|
|
@@ -2,8 +2,16 @@
|
|
|
|
|
|
A 2D driving game made with C++ and Box2D
|
|
|
|
|
|
+## Repository structure
|
|
|
+
|
|
|
+**Game** contains the desktop game app which relies on _Box2D_ and _SDL_.
|
|
|
+
|
|
|
+**Editor** contains the level editor which relies on _SDL_ only.
|
|
|
+
|
|
|
## Build
|
|
|
|
|
|
+Each folder has its own `makefile`.
|
|
|
+
|
|
|
You need `make`, `SDL1` and [Box2D](https://github.com/erincatto/box2d) to build this project.
|
|
|
|
|
|
Example on Ubuntu :
|
|
|
@@ -19,7 +27,7 @@ To execute :
|
|
|
$ make exec
|
|
|
```
|
|
|
|
|
|
-## Controls
|
|
|
+## Game controls
|
|
|
|
|
|
- **A, Q** : air control, rotate left
|
|
|
- **D** : air control, rotate right
|
|
|
@@ -28,3 +36,7 @@ $ make exec
|
|
|
- **Arrow left** : go backward
|
|
|
- **Arrow down** : break
|
|
|
- **L** : choose level
|
|
|
+
|
|
|
+## Editor controls
|
|
|
+
|
|
|
+Displayed on screen when app is running.
|
