README.md 2.04 KB
Newer Older
Myriam Begel's avatar
Myriam Begel committed
1
################### INSTALLATION AND REQUIRED FEATURES ###################
2

Myriam Begel's avatar
Myriam Begel committed
3 4 5 6 7 8 9 10 11 12 13 14 15
This project require java 1.8. To install it on debian stable or ubuntu 14.04 see in the wiki (TODO)
To compile:

    cd project folder
    make

To run

    Make sure to have java 1.8 : java -version
    make buildplay

################### HOW TO PLAY ###################

16
1)Launch the game.
Myriam Begel's avatar
Myriam Begel committed
17

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
2)On the main panel, you may :
    2.1) single player : starts the game in a single player mode
    2.2) multi player :  enables to create/join a multi player mode
    2.3) 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
    2.5) exit : leaves the game : be careful configuration keys are not registered

3)Default commands:
  -Move left    : left_arrow
  -Move right   : right_arrow
  -Move up      : up_arrow
  -Move down    : down_arrow
  -Attack       : a
  -Ability1     : z
  -Ability1     : e
  -Ability1     : r
  -Back to main : escape
Myriam Begel's avatar
Myriam Begel committed
35 36 37

################### HOW TO DOCUMENT ###################

38 39 40
To document the project, you need the package doxygen.
It will create a HTML documentation from the code.
To have inheritance graphs, please install graphivz.
Myriam Begel's avatar
Myriam Begel committed
41 42 43 44

English versions :

    make doc-html
Fardale's avatar
Fardale committed
45

Myriam Begel's avatar
Myriam Begel committed
46 47 48 49 50 51 52 53 54 55 56
Without graphivz

    make doc-html2

French versions :

    make doc-html-fr

Without graphivz

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

Myriam Begel's avatar
Myriam Begel committed
58 59 60 61 62 63
################### PRINCIPLE OF THE GAME ###################

TODO

################### DEVELOPMENT ###################

Huot Mathieu's avatar
Huot Mathieu committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
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 :
-Arrighi Emmanuel
-Aubian Guillaume
-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
88
-Ursu Bogdan