X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=79da0155ddfff92d9007a4ac8fd331763590518b;hb=bf5d08c21beb3a37bbee2c849268b2b0d5a7f708;hp=4011828c18695009994a08cfbe9257d8ff753707;hpb=f01783e2cf610cc911359195b27e0da5c19c1526;p=nothing.git diff --git a/README.md b/README.md index 4011828c..79da0155 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -[![Build Status](https://travis-ci.org/tsoding/nothing.svg?branch=master)](https://travis-ci.org/tsoding/nothing) -[![Build status](https://ci.appveyor.com/api/projects/status/gxfgojq4ko98e0g0/branch/master?svg=true)](https://ci.appveyor.com/project/rexim/nothing/branch/master) +[![Tsoding](https://img.shields.io/badge/twitch.tv-tsoding-purple?logo=twitch&style=for-the-badge)](https://www.twitch.tv/tsoding) +[![Build Status](https://ci.appveyor.com/api/projects/status/gxfgojq4ko98e0g0/branch/master?svg=true)](https://ci.appveyor.com/project/rexim/nothing/branch/master) +[![Build Status](https://github.com/tsoding/nothing/workflows/CI/badge.svg)](https://github.com/tsoding/nothing/actions) # Nothing @@ -8,15 +9,14 @@ ## Dependencies -- [gcc] +- [gcc] or [clang] or [MSVC 2015+][visual-studio] - [cmake] - [libsdl2-dev] -- [inotify-tools] ### Ubuntu ```console -$ sudo apt-get install gcc cmake libsdl2-dev inotify-tools libxml2-dev +$ sudo apt-get install gcc cmake libsdl2-dev ``` ### MacOS @@ -38,29 +38,45 @@ $ nix-shell ### Arch Linux ```console -$ sudo pacman -S gcc cmake sdl2 inotify-tools libxml2 +$ sudo pacman -S gcc cmake sdl2 ``` ### Windows +#### Visual Studio + - [Visual Studio 2015+](https://visualstudio.microsoft.com/) - [SDL2 VC Development Libraries](https://www.libsdl.org/release/SDL2-devel-2.0.9-VC.zip) +#### MinGW +- [mingw-w64](https://mingw-w64.org) +- [SDL2 MinGW Development Libraries](https://www.libsdl.org/release/SDL2-devel-2.0.10-mingw.tar.gz) + ## Quick Start ### Linux +#### CMake + ```console $ mkdir build $ cd build/ $ cmake .. $ make -$ ./nothing ../levels/ -$ ./nothing_test +$ ./nothing +``` + +#### SCU + +```console +$ ./build-posix.sh +$ ./nothing ``` ### Windows +#### Visual Studio + - 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` @@ -70,9 +86,39 @@ $ ./nothing_test > 7z x SDL2-devel-2.0.9-VC.zip > move SDL2-2.0.9 SDL2 > mkdir build +> cd build > cmake .. > cmake --build . -> nothing ..\levels +> .\nothing +``` + +#### MinGW (with MSYS) + +```console +$ cd path/to/nothing +$ wget https://www.libsdl.org/release/SDL2-devel-2.0.10-mingw.tar.gz +$ tar xzf SDL2-devel-2.0.10-mingw.tar.gz +$ mv SDL2-2.0.10 SDL2 +$ rm SDL2-devel-2.0.10-mingw.tar.gz +$ mkdir build && cd build +$ cmake .. -G "MSYS Makefiles" +$ cmake --build . +$ ./nothing +``` + +#### MinGW (without MSYS) +- Download [SDL2 MinGW Development Libraries](https://www.libsdl.org/release/SDL2-devel-2.0.10-mingw.tar.gz) and copy it to `path\to\nothing` + +```console +> cd path\to\nothing +> 7z x SDL2-devel-2.0.10-mingw.tar.gz -so | 7z x -si -ttar +> move SDL2-2.0.10 SDL2 +> del SDL2-devel-2.0.10-mingw.tar.gz +> mkdir build +> cd build +> cmake .. -G "MinGW Makefiles" +> cmake --build . +> .\nothing ``` ## Controls @@ -81,16 +127,18 @@ $ ./nothing_test #### 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 | +| Key | Action | +|---------- |-------------------------------------------------------------| +| `d` | Move to the right | +| `a` | Move to the left | +| `w/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 | +| `CTRL+q` | Quit the game | #### Gamepad @@ -101,64 +149,30 @@ $ ./nothing_test ### Consolé -| Key | Action | -|-----------|--------------------------| -| `ESC` | Exit console | -| `Enter` | Evaluate the expression | -| `Up/Down` | Traverse console history | - -## Editing Levels - -Generally creating a level looks like: - -``` -SVG File -> Custom Level File -> Game -``` - -To convert SVG to the level file and run svg2level program: - -```console -$ ./build/svg2level compile -``` - -All of the levels reside in the [./levels/] folder. Use -[./levels/Makefile] to automatically rebuild all levels: - -```console -$ cd levels/ # you must be inside of the `levels/` folder -$ make -``` - -### Level Editing Workflow - -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 - -### Objects Reference - -#### SVG rect node - -| 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. | - -#### SVG text node - -| Regex of id | Description | -|-------------|----------------------------------------------------------------------------| -| `label.*` | Defines **position** and **text** of a in-game label. **Size is ignored**. | +| Key | Action | +|---------------------|--------------------------| +| `ESC` | Exit console | +| `Enter` | Evaluate the expression | +| `Up/Down` | Traverse console history | +| `CTRL+L` | Clear | +| `Ctrl+X`, `CTRL+W` | Cut | +| `Ctrl+C`, `ALT+W` | Copy | +| `Ctrl+V`, `CTRL+Y` | Paste | + +### Level Editor + +To access the Level Editor open a level and press `TAB`. + +| Key | Action | +|-----------------|--------------------------------------------| +| `s` | Save level | +| `Mouse Wheel` | Zoom and pan | +| `CTRL+z` | Undo | +| `q` | Toggle snapping mode | +| `SHIFT+Up/Down` | Change overlaping order of selected object | +| `CTRL+c/v` | Copy/paste selected object | +| `F2` | Rename selected object | +| `DELETE` | Delete selected object | ## Support @@ -172,6 +186,7 @@ You can support my work via [./levels/]: ./levels/ [./levels/Makefile]: ./levels/Makefile [gcc]: https://gcc.gnu.org/ +[clang]: https://clang.llvm.org/ [cmake]: https://cmake.org/ [libsdl2-dev]: https://www.libsdl.org/ [NixOS]: https://nixos.org/