blob: 95bb22dc3d9b41bf35a7f527c5642d21e6eb6e2d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
# ESIEEquest
A simple adventure game made as part of unit IGI-1002 (Java) at ESIEE Paris.
## Project resources
The maps, the scenario, the planning and other resources are stored on [Google Drive](https://drive.google.com/folderview?id=0B1_LKCFPsrpyQXNieUlNSEhYOU0&usp=sharing).
## Repository structure
- /src: the Java source code
- /res: non Java resources to be included in the .jar
- /war: HTML, CSS and JS related to the web app
- /test: command test text files
- /website: the project's website
- /report: the LaTeX project report
## Continuous integration
The website, the LaTeX report, the .jar, the Javascript web app and the Javadoc are automagically generated through Gitlab CI and published on the [project's website](http://esieequest.pacien.net/).
## Code guidelines
For the conventions, see the ["Objects First With Java" style guide](http://www.bluej.org/objects-first/styleguide.html).
Also use the Eclipse code formatter, tabs instead of spaces for indentation and opening curly braces on the same line.
Do not use prefixes such as "a", "p", "v" or "pkg_" on variables and packages.
Try to use "final" and "this." as often as possible.
## Authors
Group 3F:
- Pacien TRAN-GIRARD
- Benoît LUBRANO DI SBARAGLIONE
|