Commit cb8c7b66 authored by Thomas Dupriez's avatar Thomas Dupriez

Updated README.md

parent 7e9ba875
...@@ -4,32 +4,63 @@ If you have any trouble installing and playing this game, or if you just want to ...@@ -4,32 +4,63 @@ 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 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** **ens-info-genielog-2015@lists.crans.org**
################### INSTALLATION AND REQUIRED FEATURES ################### ################### 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```
This project require java 1.8. **To install Java 8 on Ubuntu 14.10 and later:**
To install it on debian stable or ubuntu 14.04 see in the wiki. * Just enter in a terminal:
Make sure to have java 1.8 : java -version. ```sudo apt-get install openjdk-8```
To compile: **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:**
cd project folder cd project folder
make make
To run: **To run:**
* The graphical version:
Graphical version:
make play make play
Terminal version:
* The terminal version:
make play-term make play-term
To compile and run: **To compile and run:**
* The graphical version:
Graphical version :
make buildplay make buildplay
Terminal version :
* The terminal version:
make buildplay-term make buildplay-term
To launch test : **To launch the tests :**
make test make test
...@@ -38,83 +69,94 @@ To launch test : ...@@ -38,83 +69,94 @@ To launch test :
1)Launch the game. 1)Launch the game.
2)On the main panel, you may : 2)On the main panel, you may :
2.1) single player : starts the game in a single player mode * single player : starts the game in a single player mode
2.2) multi player : enables to create/join a multi player mode * multi player : enables to create/join a multi player mode
2.3) configuration : you may configure the keys used to play the game * configuration : you may configure the keys used to play the game
2.4) IGP : stands for "in game programming" : you may configure your own A.I. for your game allies * IGP : stands for "in game programming" : you may configure your own A.I. for your game allies
2.5) exit : leaves the game * exit : leaves the game
3)Default commands: 3)Default commands:
Graphical version:
-Move left : left_arrow **Graphical version:**
-Move right : right_arrow * Move left : left_arrow
-Move up : up_arrow * Move right : right_arrow
-Move down : down_arrow * Move up : up_arrow
-Attack : a * Move down : down_arrow
-Ability1 : z * Attack : a
-Ability2 : e * Ability1 : z
-Ability3 : r * Ability2 : e
-Back to main : escape * Ability3 : r
Terminal version: * Back to main : escape
-Move left : q
-Move right : d **Terminal version:**
-Move up : z * Move left : q
-Move down : s * Move right : d
-Attack : o * Move up : z
-Ability1 : k * Move down : s
-Ability2 : l * Attack : o
-Ability3 : m * Ability1 : k
-Back to main : escape * Ability2 : l
* Ability3 : m
################### HOW TO DOCUMENT ################### * Back to main : escape
To document the project, you need the package doxygen. ################### HOW TO GENERATE DOCUMENTATION ###################
To document the project, you need the package *doxygen*.
It will create a HTML documentation from the code. It will create a HTML documentation from the code.
To have inheritance graphs, please install graphivz. 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 :
English versions :
make doc-html make doc-html
Without graphivz * Without graphivz :
make doc-html2 make doc-html2
French versions : **French version :**
* With graphviz :
make doc-html-fr make doc-html-fr
Without graphivz * Without graphivz :
make doc-html2-fr make doc-html2-fr
################### PRINCIPLE OF THE GAME ################### ################### GOAL OF THE GAME ###################
Kill the monsters and reach the stairs ! Kill the monsters and reach the stairs !
################### DEVELOPMENT ################### ################### DEVELOPMENT TEAM ###################
This game was created between september 2015 and january 2016. This game was created between september 2015 and january 2016.
It was designed in a software engineering course of M1 at ENS Cachan, France. It was designed in a software engineering course of M1 at ENS Cachan, France.
The following people were the developers : The following people were the developers :
-Arrighi Emmanuel * Arrighi Emmanuel
-Babonnaud William * Babonnaud William
-Beauseigneur Clément * Beauseigneur Clément
-Begel Myriam * Begel Myriam
-Bogdan Ursu * Bogdan Ursu
-Cohen Louis * Cohen Louis
-Chouasne-Guillon Gwendoline * Chouasne-Guillon Gwendoline
-Delcros Lucas * Delcros Lucas
-Dupriez Thomas * Dupriez Thomas
-Garnier Remy * Garnier Remy
-Ghyselen Alexis * Ghyselen Alexis
-Guerquin Arnaud * Guerquin Arnaud
-Hilaire Mathieu * Hilaire Mathieu
-Hocquet Guillaume * Hocquet Guillaume
-Huot Mathieu * Huot Mathieu
-Lopez Théodore * Lopez Théodore
-Ramusat Yann * Ramusat Yann
-Ringeade Clément * Ringeade Clément
-Toussaint Etienne * Toussaint Etienne
-Thomas Colin * Thomas Colin
-Ursu Bogdan * Ursu Bogdan
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment