---
title: "BSc IN S5 / OOP with Java / Wall-J / Wall-J / Devel. notes"
author: [Pacien TRAN-GIRARD, Adam NAILI]
date: 2018-01-03
...

# Preamble

"Wall-J: the Space Cleaner" is a game in which a player uses bombs to push garbage into trash cans in user definable
worlds.

Being part of the "OOP with Java" course at [UPEM](http://www.u-pem.fr/), this application has been entirely
written in Java and makes use of the Zen5 and [JBox2D](http://www.jbox2d.org/) libraries.

## Licensing

This work is licensed under the terms of the
[Creative Commons BY-NC-SA 4.0 license](https://creativecommons.org/licenses/by-nc-sa/4.0/) by its authors:
Pacien TRAN-GIRARD and Adam NAILI.

Build-time and embedded run-time dependencies of this program are licensed under their own respective terms.

---

# Compilation and usage

## Building the project

TODO:

- compilation done through ant
- needs jdk >= 8
- dependencies included in the jar

## Running the program

See the user manual.

---

# Implementation details

## Considerations

### Specification refinement

TODO:

- specs not clear in every possible way
- refined as such: world is made of tiles some of which defined traversable, defined coniditons of validity of a map
- see user manual

### Unit testing

TODO:

- tests are necessary

## Modules

TODO:

- class diagram
- package and class roles outline

## Additional features

## Notes