about summary refs log tree commit diff homepage
diff options
context:
space:
mode:
-rw-r--r--README.rst46
m---------wiki0
2 files changed, 34 insertions, 12 deletions
diff --git a/README.rst b/README.rst
index c82b276..ee100e9 100644
--- a/README.rst
+++ b/README.rst
@@ -20,6 +20,8 @@ Brutal Maze has a few notable feautures:
 * Enemies with special abilities: stun, poison, camo, etc.
 * Somewhat a realistic physic and logic system.
 * Resizable game window in-game.
+* Eazily customizable via INI file format
+* Remote control through socket for AI researching
 
 Installation
 ------------
@@ -31,12 +33,33 @@ The installation procedure should be as simply as follow:
   directory for `Python scripts <https://docs.python.org/2/install/index.html#alternate-installation-the-user-scheme>`_
   is in your ``$PATH``.
 * Open Terminal or Command Prompt and run ``pip install --user brutalmaze``.
-  Now you can launch the game by running the command ``brutalmaze``.
 
 For more information, see
 `Installation <https://github.com/McSinyx/brutalmaze/wiki/Installation>`_
 page from Brutal Maze wiki.
 
+After installation, you can launch the game by running the command
+``brutalmaze``. Below are default bindings:
+
+F2
+   New game.
+``p``
+   Toggle pause.
+``m``
+   Toggle mute.
+Left
+   Move left.
+Right
+   Move right.
+Up
+   Move up.
+Down
+   Move down.
+Left Mouse
+   Long-range attack.
+Right Mouse
+   Close-range attack, also dodge from bullets.
+
 Configuration
 -------------
 
@@ -55,13 +78,6 @@ Settings are read in the following order:
 
 Later-read preferences will overide previous ones.
 
-.. [0] This can be copied to desired location by ``brutalmaze --write-config
-   PATH``. ``brutalmaze --write-config`` alone will print the file to stdout.
-.. [1] These will be listed as fallback config in the help message
-   (``brutalmaze --help``). See `wiki <https://github.com/McSinyx/brutalmaze/wiki/Configuration>`_
-   for more info.
-.. [2] If specified by ``brutalmaze --config PATH``.
-
 Remote control
 --------------
 
@@ -71,10 +87,6 @@ about I/O format are explained carefully in
 `Remote control <https://github.com/McSinyx/brutalmaze/wiki/Remote-control>`_
 wiki page.
 
-.. [3] This can be done by either editing option *Enable* in section *Server*
-   in the configuration file, or launching Brutal Maze using ``brutalmaze
-   --server``.
-
 License
 -------
 
@@ -87,3 +99,13 @@ running there.
 Tango color palette and several sound effects, whose author and licenses are
 listed in `Credits <https://github.com/McSinyx/brutalmaze/wiki/Credits>`_ wiki
 page.
+
+.. [0] This can be copied to desired location by ``brutalmaze --write-config
+   PATH``. ``brutalmaze --write-config`` alone will print the file to stdout.
+.. [1] These will be listed as fallback config in the help message
+   (``brutalmaze --help``). See `wiki <https://github.com/McSinyx/brutalmaze/wiki/Configuration>`_
+   for more info.
+.. [2] If specified by ``brutalmaze --config PATH``.
+.. [3] This can be done by either editing option *Enable* in section *Server*
+   in the configuration file, or launching Brutal Maze using ``brutalmaze
+   --server``.
diff --git a/wiki b/wiki
-Subproject d0221ed371d98d52173d57b71c6302b5ffb21ec
+Subproject 1b8020f4d1343c582fb3b202048db2b61be2938