From 629cc26b887dabad0bdb2d0aa6c69ac75a5171fc Mon Sep 17 00:00:00 2001 From: pacien Date: Wed, 3 Jan 2018 02:34:38 +0100 Subject: Write devlog draft outline Signed-off-by: pacien --- src/docs/dev.md | 47 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 4 deletions(-) (limited to 'src/docs') diff --git a/src/docs/dev.md b/src/docs/dev.md index 2a40e1b..bae64aa 100644 --- a/src/docs/dev.md +++ b/src/docs/dev.md @@ -1,14 +1,24 @@ --- -title: "Wall-J Devel. notes" +title: "BSc IN S5 / OOP with Java / Wall-J / Wall-J / Devel. notes" author: [Pacien TRAN-GIRARD, Adam NAILI] -date: 2017-12-09 +date: 2018-01-03 ... -# Project description +# 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 -## Credits +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. --- @@ -16,14 +26,43 @@ date: 2017-12-09 ## 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 -- cgit v1.2.3