README.md

   1 [![Build Status](https://travis-ci.org/tsoding/nothing.svg?branch=master)](https://travis-ci.org/tsoding/nothing)
   2 [![Build status](https://ci.appveyor.com/api/projects/status/gxfgojq4ko98e0g0/branch/master?svg=true)](https://ci.appveyor.com/project/rexim/nothing/branch/master)
   3
   4 # Nothing
   5
   6 ![](https://i.imgur.com/7mECYKU.gif)
   7 ![](https://i.imgur.com/ABcJqB5.gif)
   8
   9 ## Dependencies
  10
  11 - [gcc]
  12 - [cmake]
  13 - [libsdl2-dev]
  14 - [inotify-tools]
  15
  16 ### Ubuntu
  17
  18 ```console
  19 $ sudo apt-get install gcc cmake libsdl2-dev inotify-tools libxml2-dev
  20 ```
  21
  22 ### MacOS
  23
  24 ```console
  25 $ brew install gcc cmake sdl2
  26 ```
  27
  28 ### NixOS
  29
  30 For [NixOS] we have a development environment defined in [default.nix]
  31 with all of the required dependencies. You can enter the environment
  32 with `nix-shell` command:
  33
  34 ```console
  35 $ nix-shell
  36 ```
  37
  38 ### Arch Linux
  39
  40 ```console
  41 $ sudo pacman -S gcc cmake sdl2 inotify-tools libxml2
  42 ```
  43
  44 ### Windows
  45
  46 - [Visual Studio 2015+](https://visualstudio.microsoft.com/)
  47 - [SDL2 VC Development Libraries](https://www.libsdl.org/release/SDL2-devel-2.0.9-VC.zip)
  48
  49 ## Quick Start
  50
  51 ### Linux
  52
  53 ```console
  54 $ mkdir build
  55 $ cd build/
  56 $ cmake ..
  57 $ make
  58 $ cd ../data/
  59 $ ../build/nothing
  60 ```
  61
  62 ### Windows
  63
  64 - Enter the Visual Studio Command Line Development Environment https://docs.microsoft.com/en-us/cpp/build/building-on-the-command-line
  65   - Basically just find `vcvarsall.bat` and run `vcvarsall.bat x64` inside of cmd
  66 - Download [SDL2 VC Development Libraries](https://www.libsdl.org/release/SDL2-devel-2.0.9-VC.zip) and copy it to `path\to\nothing`
  67
  68 ```console
  69 > cd path\to\nothing
  70 > 7z x SDL2-devel-2.0.9-VC.zip
  71 > move SDL2-2.0.9 SDL2
  72 > mkdir build
  73 > cd build
  74 > cmake ..
  75 > cmake --build .
  76 > cd ../data/
  77 > ..\build\nothing
  78 ```
  79
  80 ## Controls
  81
  82 ### Game
  83
  84 #### Keyboard
  85
  86 | Key     | Action                                                      |
  87 |---------|-------------------------------------------------------------|
  88 | `d`     | Move to the right                                           |
  89 | `a`     | Move to the left                                            |
  90 | `SPACE` | Jump                                                        |
  91 | `c`     | Open debug console                                          |
  92 | `r`     | Reload the current level including the Player's position    |
  93 | `q`     | Reload the current level preserving the Player's position   |
  94 | `p`     | Toggle game pause                                           |
  95 | `l`     | Toggle transparency on objects. Useful for debugging levels |
  96 | `TAB`   | Switch to Level Editor                                      |
  97
  98 #### Gamepad
  99
 100 | Button       | Action                 |
 101 |--------------|------------------------|
 102 | `Left Stick` | Movement of the Player |
 103 | `1`          | Jump                   |
 104
 105 ### Consolé
 106
 107 | Key       | Action                   |
 108 |-----------|--------------------------|
 109 | `ESC`     | Exit console             |
 110 | `Enter`   | Evaluate the expression  |
 111 | `Up/Down` | Traverse console history |
 112
 113 <!-- TODO: Level Editor is not documented -->
 114
 115 ## Support
 116
 117 You can support my work via
 118
 119 - Twitch channel: https://www.twitch.tv/subs/tsoding
 120 - Patreon: https://www.patreon.com/tsoding
 121
 122 [visual-studio]: https://www.visualstudio.com/
 123 [svg2rects.py]: ./devtools/svg2rects.py
 124 [./levels/]: ./levels/
 125 [./levels/Makefile]: ./levels/Makefile
 126 [gcc]: https://gcc.gnu.org/
 127 [cmake]: https://cmake.org/
 128 [libsdl2-dev]: https://www.libsdl.org/
 129 [NixOS]: https://nixos.org/
 130 [default.nix]: ./default.nix
 131 [inotify-tools]: https://github.com/rvoicilas/inotify-tools