TODO(#456)

[nothing.git] / README.md

diff --git a/README.md b/README.md
index 768700862bf20bddfd71182c3e7dc57678d0e1d6..f724953151456539890f6f81884745f422bd6341 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,18 +5,78 @@
 ![](https://i.imgur.com/7mECYKU.gif)
 ![](https://i.imgur.com/ABcJqB5.gif)
 
+## Dependencies
+
+- [gcc]
+- [cmake]
+- [python3]
+- [libsdl2-dev]
+- [libsdl2-mixer-dev]
+- [inotify-tools]
+
+### Ubuntu
+
+```console
+$ sudo apt-get install gcc cmake libsdl2-dev libsdl2-mixer-dev python3 inotify-tools
+```
+
+### NixOS
+
+For [NixOS] we have a development environment defined in [default.nix]
+with all of the required dependencies. You can enter the environment
+with `nix-shell` command:
+
+```console
+$ nix-shell
+```
+
+### Windows
+
+See [Build on Windows][build-on-windows] section.
+
 ## Quick Start
 
 ```console
-$ nix-shell              # Only on NixOS
 $ mkdir build
 $ cd build/
 $ cmake ..
 $ make
-$ ./nothing <level-file>
+$ ./nothing ../levels/level-01.txt
 $ ./nothing_test
 ```
 
+## Controls
+
+### Game
+
+#### Keyboard
+
+| Key     | Action                                                      |
+|---------|-------------------------------------------------------------|
+| `d`     | Move to the right                                           |
+| `a`     | Move to the left                                            |
+| `SPACE` | Jump                                                        |
+| `c`     | Open debug console                                          |
+| `r`     | Reload the current level including the Player's position    |
+| `q`     | Reload the current level preserving the Player's position   |
+| `p`     | Toggle game pause                                           |
+| `l`     | Toggle transparency on objects. Useful for debugging levels |
+
+#### Gamepad
+
+| Button       | Action                 |
+|--------------|------------------------|
+| `Left Stick` | Movement of the Player |
+| `1`          | Jump                   |
+
+### Consolé
+
+| Key       | Action                   |
+|-----------|--------------------------|
+| `ESC`     | Exit console             |
+| `Enter`   | Evaluate the expression  |
+| `Up/Down` | Traverse console history |
+
 ## Editing Levels
 
 Generally creating a level looks like:
@@ -25,11 +85,10 @@ Generally creating a level looks like:
 SVG File -> Custom Level File -> Game
 ```
 
-To convert SVG to the level file install [xqilla] and run
-[svg2rects.xqe] script:
+To convert SVG to the level file and run [svg2rects.py] script:
 
 ```console
-$ xqilla ./devtools/svg2rects.xqe -i <svg-file> -o <level-file>
+$ python3 ./devtools/svg2rects.py -i <svg-file> -o <level-file>
 ```
 
 All of the levels reside in the [./levels/] folder. Use
@@ -39,14 +98,15 @@ All of the levels reside in the [./levels/] folder. Use
 
 1. `$ inkscape ./levels/level.svg &`
 2. `$ ./build/nothing ./levels/level.txt &`
-3. `$ make watch`
-4. Edit Level in Inkscape and Save
-5. Switch to the Game and reload level by pressing Q
-6. Go to 1
+3. `$ cd ./levels/`
+4. `$ make watch`
+5. Edit Level in Inkscape and Save
+6. Switch to the Game and reload level by pressing Q
+7. Go to 5
 
 ### Objects Reference
 
-#### <rect/>
+#### SVG rect node
 
 | Regex of id  | Description                                                                                                       |
 |--------------|-------------------------------------------------------------------------------------------------------------------|
@@ -59,9 +119,11 @@ All of the levels reside in the [./levels/] folder. Use
 | `background` | Defines the **color** of the background. **Position and size are ignored**.                                       |
 | `backrect.*` | Defines the **size** and **position** of a solid block in the background.                                         |
 
-#### <text/>
+#### SVG text node
 
-- `id="label.*"`
+| Regex of id | Description                                                                |
+|-------------|----------------------------------------------------------------------------|
+| `label.*`   | Defines **position** and **text** of a in-game label. **Size is ignored**. |
 
 ## Build on Windows
 
@@ -101,7 +163,15 @@ You can support my work via
 [conan]: https://www.conan.io/
 [conan-sdl2]: https://bintray.com/conan/conan-transit/SDL2%3Alasote/2.0.5%3Astable
 [visual-studio]: https://www.visualstudio.com/
-[xqilla]: http://xqilla.sourceforge.net/HomePage
-[svg2rects.xqe]: ./devtools/svg2rects.xqe
+[svg2rects.py]: ./devtools/svg2rects.py
 [./levels/]: ./levels/
 [./levels/Makefile]: ./levels/Makefile
+[gcc]: https://gcc.gnu.org/
+[cmake]: https://cmake.org/
+[libsdl2-dev]: https://www.libsdl.org/
+[libsdl2-mixer-dev]: https://www.libsdl.org/projects/SDL_mixer/
+[python3]: https://www.python.org/
+[NixOS]: https://nixos.org/
+[default.nix]: ./default.nix
+[build-on-windows]: #build-on-windows
+[inotify-tools]: https://github.com/rvoicilas/inotify-tools