README.md 2.34 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
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
Huot Mathieu's avatar
Huot Mathieu committed
12
    To play on graphical version :
Myriam Begel's avatar
Myriam Begel committed
13
    make buildplay
Huot Mathieu's avatar
Huot Mathieu committed
14 15
    To play on terminal version :
    make buildplay-term
Myriam Begel's avatar
Myriam Begel committed
16 17 18

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

19
1)Launch the game.
Myriam Begel's avatar
Myriam Begel committed
20

21 22 23 24 25
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
Huot Mathieu's avatar
Huot Mathieu committed
26
    2.5) exit : leaves the game
27 28

3)Default commands:
Huot Mathieu's avatar
Huot Mathieu committed
29
    Graphical version:
30 31 32 33 34 35
  -Move left    : left_arrow
  -Move right   : right_arrow
  -Move up      : up_arrow
  -Move down    : down_arrow
  -Attack       : a
  -Ability1     : z
Huot Mathieu's avatar
Huot Mathieu committed
36 37 38 39 40 41 42 43 44 45 46 47
  -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
48
  -Back to main : escape
Myriam Begel's avatar
Myriam Begel committed
49 50 51

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

52 53 54
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
55 56 57 58

English versions :

    make doc-html
Fardale's avatar
Fardale committed
59

Myriam Begel's avatar
Myriam Begel committed
60 61 62 63 64 65 66 67 68 69 70
Without graphivz

    make doc-html2

French versions :

    make doc-html-fr

Without graphivz

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

Myriam Begel's avatar
Myriam Begel committed
72 73
################### PRINCIPLE OF THE GAME ###################

Huot Mathieu's avatar
Huot Mathieu committed
74
Kill the monsters and reach the stairs !
Myriam Begel's avatar
Myriam Begel committed
75 76 77

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

Huot Mathieu's avatar
Huot Mathieu committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
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
102
-Ursu Bogdan