Commit 5786b840 authored by Myriam Begel's avatar Myriam Begel

Documentation with make

parent d6ecdfb8
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
# Makefile author: Joseph Anderson <jtanderson@ratiocaeli.com>
# This is where you specify the necessary source files
# Program packages and files
# - The packages should be the path inside your src directory. eg: package1 package2/package3
PACKAGES = core graphics map_generation network user_interface ingame_programming artificial_intelligence \
core/event core/gamestate core/item core/relayer core/zone core/gamestate/species \
network/test \
graphics/graphical_display graphics/graphical_sprite graphics/guiSkeleton graphics/guiSkeleton/DummyForTest graphics/guiSkeleton/CoreProcesses graphics/guiSkeleton/EntityDisplayer graphics/guiSkeleton/EntityDisplayer/EntityDisplayerBank graphics/guiSkeleton/GUIPanel graphics/guiSkeleton/ingame_input_listener \
graphics/sprites graphics/terminalUI graphics/terminalUI/Sprite_Terminal \
map_generation/map \
assets \
graphics/termSkeleton graphics/termSkeleton/termPanel \
PACKAGEDIRS = ${shell find -iname '*.java' | sed 's/[^/]*.java//' | sed 's/.\///' | sort -g | uniq}
# Java compiler
JAVAC = javac
......@@ -32,18 +24,8 @@ JAVAFLAGS = -g -d $(BIN) -cp $(SRC) -target $(JVM)
# Creating a .class file
COMPILE = $(JAVAC) $(JAVAFLAGS)
EMPTY =
JAVA_FILES = $(subst $(SRC), $(EMPTY), $(wildcard $(SRC)*.java))
ifdef PACKAGES
PACKAGEDIRS = $(addprefix $(SRC), $(PACKAGES))
PACKAGEFILES = $(subst $(SRC), $(EMPTY), $(foreach DIR, $(PACKAGEDIRS), $(wildcard $(DIR)/*.java)))
ALL_FILES = $(PACKAGEFILES) $(JAVA_FILES)
else
#ALL_FILES = $(wildcard $(SRC).java)
ALL_FILES = $(JAVA_FILES)
endif
ALL_FILES = $(PACKAGEFILES)
# One of these should be the "main" class listed in Runfile
CLASS_FILES = $(subst $(SRC), $(BIN), $(ALL_FILES:.java=.class))
......@@ -52,8 +34,7 @@ CLASS_FILES = $(subst $(SRC), $(BIN), $(ALL_FILES:.java=.class))
# Image directory subpath
IMG = assets/
# Please add here every new directory created in assets.
IMAGEDIRS = dungeon_set_1 dungeon_set_2 Test_Error_Tiles
IMAGEDIRS = ${shell cd $(SRC)$(IMG); ls -d */ | sed 's/\/\///g'}
# Other image files (assuming every image file is an PNG one)
IMAGEFILES = $(wildcard $(SRC)$(IMG)*.png)
......@@ -74,3 +55,16 @@ buildplay: all
clean :
rm -rf $(BIN)*
#To generate the documentation
doc-html-fr :
doxygen Doxyfiles-htmlFR
doc-html :
doxygen Doxyfiles-html
doc-html2 :
doxygen Doxyfiles-html-no-graphivz
doc-html2-fr:
doxygen Doxyfiles-html-no-graphivzFR
# To compile:
* cd project folder
* make
################### INSTALLATION AND REQUIRED FEATURES ###################
PS: The compilation being done by a makefile, the <package>; import of java are not implicit. Intellij IDEA put them, but Eclipse does not, so add them manually please.
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 ###################
1)Launch the game. 2)On the main panel, you may : 2.1) single player : starts the game in a single player mode 2.2) multi player : TODO 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 the game 2.5) exit : leaves the game
3)Once you are in game : For now, the basic configuration is : Move left : left_arrow Move right : right_arrow Move up : up_arrow Move down : down_arrow Attack : a Spell : s Back to main : escape
################### HOW TO DOCUMENT ###################
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.
English versions :
make doc-html
Without graphivz
make doc-html2
French versions :
make doc-html-fr
Without graphivz
make doc-html2-fr
################### PRINCIPLE OF THE GAME ###################
TODO
################### DEVELOPMENT ###################
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 -Ursu Bogdan
TODO : missing names to fill because not registered
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