diff options
author | Nguyễn Gia Phong <vn.mcsinyx@gmail.com> | 2017-11-21 21:49:35 +0700 |
---|---|---|
committer | Nguyễn Gia Phong <vn.mcsinyx@gmail.com> | 2017-11-21 21:49:35 +0700 |
commit | 1578586f24c74786976f0c675c901f5e30fa6bbb (patch) | |
tree | 5c5b19c2ce1a07af52acaa465bd1618d10d1f92f /README.rst | |
parent | fffdd969ad5ab5e4cdde65e0a49940722b1f1282 (diff) | |
download | brutalmaze-1578586f24c74786976f0c675c901f5e30fa6bbb.tar.gz |
Update documentation 0.2.0
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 26 |
1 files changed, 11 insertions, 15 deletions
diff --git a/README.rst b/README.rst index 8e1f484..a48c946 100644 --- a/README.rst +++ b/README.rst @@ -7,17 +7,17 @@ art style. .. image:: https://raw.githubusercontent.com/McSinyx/brutalmaze/master/screenshot.png The game features a trigon trapped in an infinite maze. As our hero tries to -escape, the maze's border turn into aggressive squares trying to stop him. Your -job is to help the trigon fight against those evil squares and find a way out -(if there is any). Be aware that the more get killed, the more will show up and -our hero will get weaker when wounded. +escape, the maze's border turns into aggressive squares trying to stop him. +Your job is to help the trigon fight against those evil squares and find a way +out (if there is any). Be aware that the more get killed, the more will show up +and our hero will get weaker when wounded. -Being a research game, Brutal Maze has a few primary goals: +Brutal Maze has a few notable feautures: -* Highly portable. +* Being highly portable. * Auto-generated and infinite maze. * No binary data for drawing. -* Enemies with randomized attributes: stun, poison, camo, etc. +* Enemies with special abilities: stun, poison, camo, etc. * Somewhat a realistic physic and logic system. * Resizable game window in-game. @@ -29,33 +29,29 @@ The installation procedure should be as simply as follow: * Install Python and `pip <https://pip.pypa.io/en/latest/>`_. Make sure the directory for `Python scripts <https://docs.python.org/2/install/index.html#alternate-installation-the-user-scheme>`_ - is your ``PATH``. + is in your ``$PATH``. * Open Terminal or Command Prompt and run ``pip install --user brutalmaze``. Now you can lauch the game by running the command ``brutalmaze``. +For more information, see the `Installation <https://github.com/McSinyx/brutalmaze/wiki/Installation>`_ +from Brutal Maze wiki. + Control ------- F2 New game. - Escape, ``p`` Pause. - Up, ``w`` Move up. - Down, ``s`` Move down. - Left, ``a`` Move left. - Right, ``d`` Move right. - Left Mouse Long-range attack. - Return, Right Mouse Close-range attack, also dodge from bullets. |