From be6c2fedea57177b75bc1f50dfc016d672be92b1 Mon Sep 17 00:00:00 2001 From: Nguyễn Gia Phong Date: Sun, 28 Oct 2018 15:50:13 +0700 Subject: Update documentation related to #11 --- README.rst | 26 ++++++++++++++------------ brutalmaze/game.py | 6 +++++- setup.py | 2 +- wiki | 2 +- 4 files changed, 21 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 573f317..eadb13b 100644 --- a/README.rst +++ b/README.rst @@ -16,7 +16,7 @@ and our hero will get weaker when wounded. Brutal Maze has a few notable features: * Being highly portable. -* Auto-generated and infinite maze. +* Auto-generated and infinite maze. [0]_ * No binary data for drawing. * Enemies with special abilities: stun, poison, camo, etc. * Somewhat a realistic physic and logic system. @@ -80,10 +80,10 @@ to configuration file only. Settings are read in the following order: -0. Default configuration [0]_ -1. System-wide configuration file [1]_ -2. Local configuration file [1]_ -3. Manually set configuration file [2]_ +0. Default configuration [1]_ +1. System-wide configuration file [2]_ +2. Local configuration file [2]_ +3. Manually set configuration file [3]_ 4. Command-line arguments Later-read preferences will override previous ones. @@ -91,7 +91,7 @@ Later-read preferences will override previous ones. Remote control -------------- -If you enable the socket server [3]_, Brutal Maze will no longer accept direct +If you enable the socket server [4]_, Brutal Maze will no longer accept direct input from your mouse or keyboard, but wait for a client to connect. Details about I/O format are explained carefully in `Remote control `_ @@ -101,7 +101,7 @@ Game recording -------------- Either game played by human or client script can be recorded to JSON format. -This can be enabled by setting the output directory to a non-empty string [4]_. +This can be enabled by setting the output directory to a non-empty string [5]_. Recordings can be played on the repo's Github Page which the above screenshot is linked to. @@ -118,14 +118,16 @@ This project also uses Tango color palette and several sound effects, whose authors and licenses are listed in `Credits `_ wiki page. -.. [0] This can be copied to desired location by ``brutalmaze --write-config +.. [0] Broken on vanilla pygame on GNU/Linux. For workarounds, see issue + `#11 `_. +.. [1] 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 +.. [2] These will be listed as fallback config in the help message (``brutalmaze --help``). See `wiki `_ for more info. -.. [2] If specified by ``brutalmaze --config PATH``. -.. [3] This can be done by either editing option *Enable* in section *Server* +.. [3] If specified by ``brutalmaze --config PATH``. +.. [4] This can be done by either editing option *Enable* in section *Server* in the configuration file, or launching Brutal Maze using ``brutalmaze --server``. -.. [4] ``brutalmaze --record-dir DIR``. Navigate to `wiki `_ +.. [5] ``brutalmaze --record-dir DIR``. Navigate to `wiki `_ to see more options. diff --git a/brutalmaze/game.py b/brutalmaze/game.py index ca99a14..94e2f08 100644 --- a/brutalmaze/game.py +++ b/brutalmaze/game.py @@ -17,7 +17,7 @@ # You should have received a copy of the GNU Affero General Public License # along with Brutal Maze. If not, see . -__version__ = '0.8.22' +__version__ = '0.8.23' import re from argparse import ArgumentParser, FileType, RawTextHelpFormatter @@ -417,3 +417,7 @@ def main(): while game.update(): game.touch_control() else: while game.update(): game.user_control() + + +# Allow launching the game via invoking ``python -m brutalmaze.game'' +if __name__ == '__main__': main() diff --git a/setup.py b/setup.py index bb96a75..2ffd2c0 100755 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with open('README.rst') as f: setup( name='brutalmaze', - version='0.8.22', + version='0.8.23', description='A minimalist TPS game with fast-paced action', long_description=long_description, url='https://github.com/McSinyx/brutalmaze', diff --git a/wiki b/wiki index 4921800..bbe35ef 160000 --- a/wiki +++ b/wiki @@ -1 +1 @@ -Subproject commit 4921800d525d36a2b48666c1fb938eabeeb33bb8 +Subproject commit bbe35efbf6089f17fffb72612196f36b1256aea6 -- cgit 1.4.1