X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=db1beccf5b46cbd26b8cfa6885cd9b57f7bb4c36;hb=f1a46dab481e52f75e6026b6dc7d1de4f7a975b1;hp=d3bfa892feb2e41046797650d06ecec604fa6348;hpb=18c6d85f3fcac0b917ebef6f55ec9c6445f3dfa7;p=nothing.git diff --git a/README.md b/README.md index d3bfa892..db1beccf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![Tsoding](https://img.shields.io/badge/twitch.tv-tsoding-purple?logo=twitch&style=for-the-badge)](https://www.twitch.tv/tsoding) -[![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) +[![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 @@ -9,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 @@ -39,7 +38,7 @@ $ nix-shell ### Arch Linux ```console -$ sudo pacman -S gcc cmake sdl2 inotify-tools libxml2 +$ sudo pacman -S gcc cmake sdl2 ``` ### Windows @@ -57,13 +56,21 @@ $ sudo pacman -S gcc cmake sdl2 inotify-tools libxml2 ### Linux +#### CMake + ```console $ mkdir build $ cd build/ $ cmake .. $ make -$ cd ../assets/ -$ ../build/nothing +$ ./nothing +``` + +#### SCU + +```console +$ ./build-posix.sh +$ ./nothing ``` ### Windows @@ -82,8 +89,7 @@ $ ../build/nothing > cd build > cmake .. > cmake --build . -> cd ../assets/ -> ..\build\nothing +> .\nothing ``` #### MinGW (with MSYS) @@ -97,8 +103,7 @@ $ rm SDL2-devel-2.0.10-mingw.tar.gz $ mkdir build && cd build $ cmake .. -G "MSYS Makefiles" $ cmake --build . -$ cd ../assets/ -$ ../build/nothing +$ ./nothing ``` #### MinGW (without MSYS) @@ -113,8 +118,7 @@ $ ../build/nothing > cd build > cmake .. -G "MinGW Makefiles" > cmake --build . -> cd ../assets/ -> ..\build\nothing +> .\nothing ``` ## Controls @@ -123,18 +127,18 @@ $ ../build/nothing #### 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 | -| `TAB` | Switch to Level Editor | -| `CTRL+q` | Quit the game | +| 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 @@ -150,16 +154,25 @@ $ ../build/nothing | `ESC` | Exit console | | `Enter` | Evaluate the expression | | `Up/Down` | Traverse console history | - - +| `CTRL+L` | Clear | +| `CTRL+W` | Cut | +| `ALT+W` | Copy | +| `CTRL+Y` | Paste | ### Level Editor To access the Level Editor open a level and press `TAB`. -| Key | Action | -|------|------------------------| -| `F2` | Rename selected object | +| 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 @@ -173,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/