[](https://travis-ci.org/tsoding/nothing)
+[](https://ci.appveyor.com/project/rexim/nothing/branch/master)
# Nothing
-## Quick Start
+## Dependencies
+
+- [gcc]
+- [cmake]
+- [libsdl2-dev]
+- [inotify-tools]
+
+### Ubuntu
```console
-$ nix-shell # Only on NixOS
-$ mkdir build
-$ cd build/
-$ cmake ..
-$ make
-$ ./nothing <level-file>
-$ ./nothing_test
+$ sudo apt-get install gcc cmake libsdl2-dev inotify-tools libxml2-dev
```
-## Editing Levels
-
-Generally creating a level looks like:
+### MacOS
+```console
+$ brew install gcc cmake sdl2
```
-SVG File -> Custom Level File -> Game
+
+### 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
```
-To convert SVG to the level file install [xqilla] and run
-[svg2rects.xqe] script:
+### Arch Linux
```console
-$ xqilla ./devtools/svg2rects.xqe -i <svg-file> -o <level-file>
+$ sudo pacman -S gcc cmake sdl2 inotify-tools libxml2
```
-All of the levels reside in the [./levels/] folder. Use
-[./levels/Makefile] to automatically rebuild all levels.
+### Windows
-### Level Editing Workflow
+- [Visual Studio 2015+](https://visualstudio.microsoft.com/)
+- [SDL2 VC Development Libraries](https://www.libsdl.org/release/SDL2-devel-2.0.9-VC.zip)
-1. `$ inkscape ./levels/level.svg &`
-2. `$ ./build/nothing ./levels/level.txt &`
-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
+## Quick Start
-### Objects Reference
+### Linux
-#### SVG rect node
+```console
+$ mkdir build
+$ cd build/
+$ cmake ..
+$ make
+$ cd ../data/
+$ ../build/nothing
+```
-| Regex of id | Description |
-|--------------|-------------------------------------------------------------------------------------------------------------------|
-| `player` | Defines the **position** of the Player. **Size is ignored**. |
-| `rect.*` | Defines the **size** and **position** of an impenetrable platform block |
-| `box.*` | Defines the **size** and **position** of a rigid box that obeys the physics of the game |
-| `region(.*)` | Defines the **size** and **position** of a region that hides the Goals. `\1` defines the id of the Goal to hide. |
-| `goal(.*)` | Defines the **position** of the goal. **Size is ignored**. `\1` defines the id of the region that hides the goal. |
-| `lava.*` | Defines the **position** and **size** of a lava block. |
-| `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. |
+### Windows
-#### SVG text node
+- Enter the Visual Studio Command Line Development Environment https://docs.microsoft.com/en-us/cpp/build/building-on-the-command-line
+ - Basically just find `vcvarsall.bat` and run `vcvarsall.bat x64` inside of cmd
+- Download [SDL2 VC Development Libraries](https://www.libsdl.org/release/SDL2-devel-2.0.9-VC.zip) and copy it to `path\to\nothing`
-| Regex of id | Description |
-|-------------|----------------------------------------------------------------------------|
-| `label.*` | Defines **position** and **text** of a in-game label. **Size is ignored**. |
+```console
+> cd path\to\nothing
+> 7z x SDL2-devel-2.0.9-VC.zip
+> move SDL2-2.0.9 SDL2
+> mkdir build
+> cd build
+> cmake ..
+> cmake --build .
+> cd ../data/
+> ..\build\nothing
+```
-## Build on Windows
+## Controls
-You need to install [conan][] and [Visual Studio 2017][visual-studio].
+### Game
-### Dependencies
+#### Keyboard
-Current version of [SDL2/2.0.5@lasote/stable][conan-sdl2] in the conan-transit
-repository is not compatible with the latest conan, so you'll need to install
-it locally from the git repository:
+| 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 |
+| `TAB` | Switch to Level Editor |
-```console
-$ git clone https://github.com/lasote/conan-sdl2.git # temporary, I hope hope hope
-$ cd conan-sdl2
-$ conan export SDL2/2.0.5@lasote/stable
-```
+#### Gamepad
-### Building
+| Button | Action |
+|--------------|------------------------|
+| `Left Stick` | Movement of the Player |
+| `1` | Jump |
-Execute the following commands inside of the `nothing` directory:
+### Consolé
-```console
-$ conan install --build missing --install-folder build
-$ cd build
-$ cmake .. -G "Visual Studio 15 2017 Win64"
-```
+| Key | Action |
+|-----------|--------------------------|
+| `ESC` | Exit console |
+| `Enter` | Evaluate the expression |
+| `Up/Down` | Traverse console history |
-After that, build the `build/nothing.sln` file with Visual Studio.
+<!-- TODO: Level Editor is not documented -->
## Support
- Twitch channel: https://www.twitch.tv/subs/tsoding
- Patreon: https://www.patreon.com/tsoding
-[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/
+[NixOS]: https://nixos.org/
+[default.nix]: ./default.nix
+[inotify-tools]: https://github.com/rvoicilas/inotify-tools
projects / nothing.git / blobdiff