README.md 3.6 KB
Newer Older
Thomas Dupriez's avatar
Thomas Dupriez committed
1 2 3 4 5 6
################### ABOVE ALL ###################

If you have any trouble installing and playing this game, or if you just want to
contact the development team, send a mail (no need to be formal, and you can send it in French) to 
**ens-info-genielog-2015@lists.crans.org**

Thomas Dupriez's avatar
Thomas Dupriez committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
################### JAVA 8 ###################

This project requires java 1.8.
To check if you have it, you can enter in a terminal:
```java -version```

**To install Java 8 on Debian:**
 * Enter in a terminal:
 ```sudo nano /etc/apt/source.list```
 * Add at the end of the file :
  ```deb http://http.debian.net/debian jessie-backports main```
 * Ctrl-O
 * Enter
 * Ctrl-X
 * Enter in a terminal:
 ```sudo apt-get update```
  * Enter in a terminal:
  ```sudo apt-get -t jessie-backports install openjdk-8```
25

Thomas Dupriez's avatar
Thomas Dupriez committed
26 27 28
**To install Java 8 on Ubuntu 14.10 and later:**
 * Just enter in a terminal:
```sudo apt-get install openjdk-8```
29

Thomas Dupriez's avatar
Thomas Dupriez committed
30 31 32 33 34 35 36
**To install Java 8 on Ubuntu 14.04:**
 * Follow the instructions of: http://ubuntuhandbook.org/index.php/2015/01/install-openjdk-8-ubuntu-14-04-12-04-lts/


################### INSTALLATION AND REQUIRED FEATURES ###################

**To compile:**
Myriam Begel's avatar
Myriam Begel committed
37 38 39 40

    cd project folder
    make

Thomas Dupriez's avatar
Thomas Dupriez committed
41 42 43
**To run:**
* The graphical version:

44 45

    make play
Thomas Dupriez's avatar
Thomas Dupriez committed
46 47 48 49

* The terminal version:


50 51
    make play-term

Thomas Dupriez's avatar
Thomas Dupriez committed
52 53 54
**To compile and run:**
* The graphical version:

Myriam Begel's avatar
Myriam Begel committed
55 56

    make buildplay
Thomas Dupriez's avatar
Thomas Dupriez committed
57 58 59 60

* The terminal version:


Huot Mathieu's avatar
Huot Mathieu committed
61
    make buildplay-term
Myriam Begel's avatar
Myriam Begel committed
62

Thomas Dupriez's avatar
Thomas Dupriez committed
63
**To launch the tests :**
Fardale's avatar
Fardale committed
64 65 66

    make test

Myriam Begel's avatar
Myriam Begel committed
67 68
################### HOW TO PLAY ###################

69
1)Launch the game.
Myriam Begel's avatar
Myriam Begel committed
70

71
2)On the main panel, you may :
Thomas Dupriez's avatar
Thomas Dupriez committed
72 73 74 75 76
  * single player : starts the game in a single player mode
  * multi player :  enables to create/join a multi player mode
  * configuration : you may configure the keys used to play the game
  * IGP : stands for "in game programming" : you may configure your own A.I. for your game allies
  * exit : leaves the game
77 78

3)Default commands:
Thomas Dupriez's avatar
Thomas Dupriez committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104

  **Graphical version:**
  * Move left    : left_arrow
  * Move right   : right_arrow
  * Move up      : up_arrow
  * Move down    : down_arrow
  * Attack       : a
  * Ability1     : z
  * Ability2     : e
  * Ability3     : r
  * Back to main : escape

  **Terminal version:**
  * Move left    : q
  * Move right   : d
  * Move up      : z
  * Move down    : s
  * Attack       : o
  * Ability1     : k
  * Ability2     : l
  * Ability3     : m
  * Back to main : escape

################### HOW TO GENERATE DOCUMENTATION ###################

To document the project, you need the package *doxygen*.
105
It will create a HTML documentation from the code.
Thomas Dupriez's avatar
Thomas Dupriez committed
106 107 108 109 110 111 112
To have inheritance graphs, please install *graphivz*.

To access the documentation, double-click on the *doc.html* file at the root of the project that
 will be generated/updated by running the commands below.

**English version :**
* With graphviz :
Myriam Begel's avatar
Myriam Begel committed
113 114 115


    make doc-html
Fardale's avatar
Fardale committed
116

Thomas Dupriez's avatar
Thomas Dupriez committed
117 118
* Without graphivz :

Myriam Begel's avatar
Myriam Begel committed
119 120 121

    make doc-html2

Thomas Dupriez's avatar
Thomas Dupriez committed
122 123 124
**French version :**
* With graphviz :

Myriam Begel's avatar
Myriam Begel committed
125 126 127

    make doc-html-fr

Thomas Dupriez's avatar
Thomas Dupriez committed
128 129
* Without graphivz :

Myriam Begel's avatar
Myriam Begel committed
130 131

    make doc-html2-fr
Fardale's avatar
Fardale committed
132

Thomas Dupriez's avatar
Thomas Dupriez committed
133
################### GOAL OF THE GAME ###################
Myriam Begel's avatar
Myriam Begel committed
134

Huot Mathieu's avatar
Huot Mathieu committed
135
Kill the monsters and reach the stairs !
Myriam Begel's avatar
Myriam Begel committed
136

Thomas Dupriez's avatar
Thomas Dupriez committed
137
################### DEVELOPMENT TEAM ###################
Myriam Begel's avatar
Myriam Begel committed
138

Huot Mathieu's avatar
Huot Mathieu committed
139 140 141
This game was created between september 2015 and january 2016.
It was designed in a software engineering course of M1 at ENS Cachan, France.
The following people were the developers :
Thomas Dupriez's avatar
Thomas Dupriez committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
* Arrighi Emmanuel
* Babonnaud William
* Beauseigneur Clément
* Begel Myriam
* Bogdan Ursu
* Cohen Louis
* Chouasne-Guillon Gwendoline
* Delcros Lucas
* Dupriez Thomas
* Garnier Remy
* Ghyselen Alexis
* Guerquin Arnaud
* Hilaire Mathieu
* Hocquet Guillaume
* Huot Mathieu
* Lopez Théodore
* Ramusat Yann
* Ringeade Clément
* Toussaint Etienne
* Thomas Colin
* Ursu Bogdan