README.md 1.06 KB
Newer Older
1
# MAGIC GAME <sup><sup>*</sup> working title</sup>
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
2 3 4

## INSTALLATION

5
Simple run `make`.
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
6

Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
7 8
Then run `make run` if you want to start the game.

Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
9 10
Run `make levelEditor` to launch the level editor. This only works in debug mode to launch a custom script.

Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
11 12
Run `make test` to run all the tests.

Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
13 14 15 16
### Compilation

#### Mac OS

Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
17
To build for Mac OS, run `make install` and then `make build/macosx`.
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
18

Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
19
## PROJECT STRUCTURE
20 21 22
- `test`            - This is were all the tests are located
- `engine`          - This is where all the core engine logic sits
- `assets`          - This is where all the game assets are including the script code for the levels
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
23
    - `scripts/runtime.lua`     - This is the runtime library that can be shared between games
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
24
    - `scripts/game.lua`        - This is the game specific logic
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
25
    - `scripts/libs`            - These are the modules for sharing on the scripting layer
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
26 27

## TODOS
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
28
The tasks can be tracked on [Trello](https://trello.com/invite/b/a7vjJgl9/5a6224e658804b7173384729aeb6d7f1/magic-game).
29 30 31 32 33 34

## DEPENDENCIES
- GLFW
- LodePNG
- Box2D
- Lua
Rupert Ben Wiser's avatar
Rupert Ben Wiser committed
35
- GoogleTest