Rativel/jeu-de-combat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
François Autin 2021-06-26 00:52:20 +00:00
parent bfdeccdc88
commit 90e0ac8221
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/launcher/README.md
View File

@ -1,5 +1,7 @@
# Boulevard Combattant Launcher
By [François AUTIN](@fautin) & [Indy BOYEAU](@iboyeau).
## What is the launcher about?
In order to allow for the end-user to properly input its preferred parameters, we needed a user interface to edit the game.set JSON configuration file (which is then parsed by the game engine to configure itself). Therefore, a launcher window providing basic configuration toggles and boxes was implemented.
@ -47,3 +49,13 @@ Any JavaFX `Application` class instance must have a `start(Stage primaryStage)`
### launcher.Settings
This class is specifically made to bridge between the launcher itself, and the resulting game.set JSON configuration file. `launcher.Settings` parses game.set using `com.googlecode.json-simple`, a JSON parser for Java, upon instanciation. It also provides a `write(...)` method to write the user inputed settings to file.
# Task repartition
`launcher.Launcher` and all its dependent resources (`launcher.fxml` & `style.css`) were written by @fautin.
`launcher.Settings` was co-written by @fautin and @iboyeau.
`match.match` methods relevant to parsing the game.set file were co-written by @iboyeau and @fautin.
Launcher logo was designed by @rrativel.