README

Context

This is the readme file for Demo01Frame (1.0.0) proposing a simple 2D game framework to implements and test your own !

Build

To build the project, just execute the following command line :

$> build.sh a

Run

To execute the build project, just run it with :

$> build.sh r

or you can execute the command line :

$> java -jar target/Demo01-1.0.0.jar

figure 1 - This is the default result for a DemoAppTemplate execution

NOTE
On this figure 1, a screenshot, you can note the yellow border indicating that the debug level is set to 1 at least. the bottom orage line display some live debugging information.

Now, the following keys act as :

key	Description
ESCAPE	Exit the Demo01Frame application
CTRL+Z	Reset the current Scene
CTRL+G	Reverse the current Scene Gravity
UP	Move player up
DOWN	Move player down
LEFT	Move player left
RIGHT	Move player right
PAGE_UP	Add 1à new enemies

figure 2 - Requesting to quit by pressing ESCAPE key

Configuration

You can enhance the default values for window, buffer, play area and gravity thanks to the config.properties file:

Config. key	Description
app.exit	Request game to not execute the main loop, only for test purpose
app.window.title	defines the game window title
app.window.height	define the game window height
app.window.width	define the game window width
app.render.fps	define the rendering frame per seconds
app.render.buffer.height	define the internal buffer resolution height
app.render.buffer.width	define the internal buffer resolution width
app.world.play.area.height	define the game internal play area height
app.world.play.area.width	define the game internal play area width
app.world.gravity	define the world gravity applied to all Entity

Enjoy !

Frédéric Delorme.