Update documentation pointers
This commit is contained in:
parent
22b0e683bf
commit
c61bd8acc7
67
README.rst
67
README.rst
|
@ -3,14 +3,14 @@ Brutal Maze
|
||||||
|
|
||||||
Brutal Maze is a thrilling shoot 'em up game with minimalist art style.
|
Brutal Maze is a thrilling shoot 'em up game with minimalist art style.
|
||||||
|
|
||||||
.. image:: https://raw.githubusercontent.com/McSinyx/brutalmaze/master/screenshot.png
|
.. image:: https://brutalmaze.rtfd.io/_images/screenshot.png
|
||||||
:target: https://McSinyx.github.io/brutalmaze/
|
:target: https://brutalmaze.rtfd.io/recplayer.html
|
||||||
|
|
||||||
The game features a trigon trapped in an infinite maze. As our hero tries to
|
The game features a trigon trapped in an infinite maze. As our hero tries
|
||||||
escape, the maze's border turns into aggressive squares trying to stop him.
|
to escape, the maze's border turns into aggressive squares trying to stop per.
|
||||||
Your job is to help the trigon fight against those evil squares and find a way
|
Your job is to help the trigon fight against those evil squares and find
|
||||||
out (if there is any). Be aware that the more get killed, the more will show up
|
a way out (if there is any). Be aware that the more get killed,
|
||||||
and our hero will get weaker when wounded.
|
the more will show up and our hero will get weaker when wounded.
|
||||||
|
|
||||||
Brutal Maze has a few notable features:
|
Brutal Maze has a few notable features:
|
||||||
|
|
||||||
|
@ -30,17 +30,14 @@ Installation
|
||||||
Brutal Maze is written in Python and is compatible version 3.6 and above.
|
Brutal Maze is written in Python and is compatible version 3.6 and above.
|
||||||
The installation procedure should be as simple as follows:
|
The installation procedure should be as simple as follows:
|
||||||
|
|
||||||
* Install Python and `pip <https://pip.pypa.io/en/latest/>`_. Make sure the
|
* Install Python and pip_. Make sure the directory for `Python scripts`_
|
||||||
directory for `Python scripts <https://docs.python.org/3/install/index.html#alternate-installation-the-user-scheme>`_
|
|
||||||
is in your ``$PATH``.
|
is in your ``$PATH``.
|
||||||
* Open Terminal or Command Prompt and run ``pip install --user brutalmaze``.
|
* Open Terminal or Command Prompt and run ``pip install --user brutalmaze``.
|
||||||
|
|
||||||
For more information, see
|
For more information, see Installation_ page from the documentation.
|
||||||
`Installation <https://github.com/McSinyx/brutalmaze/wiki/Installation>`_
|
|
||||||
page from Brutal Maze wiki.
|
|
||||||
|
|
||||||
After installation, you can launch the game by running the command
|
After installation, you can launch the game by running the command
|
||||||
``brutalmaze``. Below are the default bindings, which can be configured as
|
``brutalmaze``. Below are the default bindings, which can be configured as
|
||||||
shown in the next section:
|
shown in the next section:
|
||||||
|
|
||||||
F2
|
F2
|
||||||
|
@ -62,9 +59,9 @@ Left Mouse
|
||||||
Right Mouse
|
Right Mouse
|
||||||
Close-range attack, also dodge from bullets.
|
Close-range attack, also dodge from bullets.
|
||||||
|
|
||||||
Additionally, Brutal Maze also supports touch-friendly control. In this mode,
|
Additionally, Brutal Maze also supports touch-friendly control. In this mode,
|
||||||
touches on different grid (empty, wall, enemy, hero) send different signals (to
|
touches on different grid (empty, wall, enemy, hero) send different signals
|
||||||
guide the hero to either move or attack, or start new game). Albeit it is
|
(to guide the hero to either move or attack, or start new game). Albeit it is
|
||||||
implemented using *mouse button up* event, touch control is not a solution for
|
implemented using *mouse button up* event, touch control is not a solution for
|
||||||
mouse-only input, but an attempt to support mobile GNU/Linux distribution such
|
mouse-only input, but an attempt to support mobile GNU/Linux distribution such
|
||||||
as postmarketOS, i.e. it's meant to be played using two thumbs :-)
|
as postmarketOS, i.e. it's meant to be played using two thumbs :-)
|
||||||
|
@ -90,21 +87,18 @@ Later-read preferences will override previous ones.
|
||||||
Remote control
|
Remote control
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
If you enable the socket server [4]_, Brutal Maze will no longer accept direct
|
If you enable the socket server [4]_, Brutal Maze will no longer accept
|
||||||
input from your mouse or keyboard, but wait for a client to connect. Details
|
direct input from your mouse or keyboard, but wait for a client to connect.
|
||||||
about I/O format are explained carefully in
|
The I/O format is explained in details in the `Remote Control`_ page.
|
||||||
`Remote control <https://github.com/McSinyx/brutalmaze/wiki/Remote-control>`_
|
|
||||||
wiki page.
|
|
||||||
|
|
||||||
Game recording
|
Game recording
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
Either game played by human or client script can be recorded to JSON format.
|
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 [5]_.
|
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
|
Recordings can be played using Brutal Maze `HTML5 record player`_.
|
||||||
is linked to.
|
|
||||||
|
|
||||||
License
|
Copying
|
||||||
-------
|
-------
|
||||||
|
|
||||||
Brutal Maze's source code and its icon are released under GNU Affero General
|
Brutal Maze's source code and its icon are released under GNU Affero General
|
||||||
|
@ -114,19 +108,24 @@ allow them to download the source code corresponding to the modified version
|
||||||
running there.
|
running there.
|
||||||
|
|
||||||
This project also uses Tango color palette and several sound effects, whose
|
This project also uses Tango color palette and several sound effects, whose
|
||||||
authors and licenses are listed in
|
authors and licenses are listed in the Copying_ page in our documentation.
|
||||||
`Credits <https://github.com/McSinyx/brutalmaze/wiki/Credits>`_ wiki page.
|
|
||||||
|
|
||||||
.. [0] Broken on vanilla pygame on GNU/Linux. For workarounds, see issue
|
.. [0] Broken on vanilla pygame on GNU/Linux. For workarounds, see issue
|
||||||
`#11 <https://github.com/McSinyx/brutalmaze/issues/11>`_.
|
`#3 <https://git.disroot.org/McSinyx/brutalmaze/issues/3>`_.
|
||||||
.. [1] This can be copied to desired location by ``brutalmaze --write-config
|
.. [1] This can be copied to desired location by ``brutalmaze --write-config
|
||||||
PATH``. ``brutalmaze --write-config`` alone will print the file to stdout.
|
PATH``. ``brutalmaze --write-config`` alone will print the file to stdout.
|
||||||
.. [2] 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 <https://github.com/McSinyx/brutalmaze/wiki/Configuration>`_
|
(``brutalmaze --help``). See the Configuration_ documentation for more info.
|
||||||
for more info.
|
|
||||||
.. [3] If specified by ``brutalmaze --config PATH``.
|
.. [3] If specified by ``brutalmaze --config PATH``.
|
||||||
.. [4] This can be done by either editing option *Enable* in section *Server*
|
.. [4] This can be done by either editing option *Enable* in section *Server*
|
||||||
in the configuration file, or launching Brutal Maze using ``brutalmaze
|
in the configuration file or launching the game via ``brutalmaze --server``.
|
||||||
--server``.
|
.. [5] ``brutalmaze --record-dir DIR``. Navigate to Configuration_
|
||||||
.. [5] ``brutalmaze --record-dir DIR``. Navigate to `wiki <https://github.com/McSinyx/brutalmaze/wiki/Configuration>`_
|
|
||||||
to see more options.
|
to see more options.
|
||||||
|
|
||||||
|
.. _pip: https://pip.pypa.io/en/latest/
|
||||||
|
.. _Python scripts: https://docs.python.org/3/install/index.html#alternate-installation-the-user-scheme
|
||||||
|
.. _Installation: https://brutalmaze.rtfd.io/install.html
|
||||||
|
.. _Remote Control: https://brutalmaze.rtfd.io/remote.html
|
||||||
|
.. _HTML5 record player: https://brutalmaze.rtfd.io/recplayer.html
|
||||||
|
.. _Copying: https://brutalmaze.rtfd.io/copying.html
|
||||||
|
.. _Configuration: https://brutalmaze.rtfd.io/config.html
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
# You should have received a copy of the GNU Affero General Public License
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
# along with Brutal Maze. If not, see <https://www.gnu.org/licenses/>.
|
# along with Brutal Maze. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
__version__ = '0.9.2'
|
__version__ = '0.9.3'
|
||||||
|
|
||||||
import re
|
import re
|
||||||
from argparse import ArgumentParser, FileType, RawTextHelpFormatter
|
from argparse import ArgumentParser, FileType, RawTextHelpFormatter
|
||||||
|
|
|
@ -22,7 +22,7 @@ copyright = '2017-2020, Nguyễn Gia Phong'
|
||||||
author = 'Nguyễn Gia Phong'
|
author = 'Nguyễn Gia Phong'
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
release = '0.9.2'
|
release = '0.9.3'
|
||||||
|
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
Credits
|
Copying
|
||||||
=======
|
=======
|
||||||
|
|
||||||
This listing is our best-faith, hard-work effort at accurate attribution,
|
This listing is our best-faith, hard-work effort at accurate attribution,
|
||||||
|
@ -21,8 +21,8 @@ running there.
|
||||||
|
|
||||||
Other creative works retain their original licenses as listed below.
|
Other creative works retain their original licenses as listed below.
|
||||||
|
|
||||||
Tango Color Palette
|
Color Palette
|
||||||
-------------------
|
-------------
|
||||||
|
|
||||||
Brutal Maze uses the Tango color palette by `the Tango desktop project`_
|
Brutal Maze uses the Tango color palette by `the Tango desktop project`_
|
||||||
to draw all of its graphics. The palette is released to the Public Domain.
|
to draw all of its graphics. The palette is released to the Public Domain.
|
|
@ -1 +0,0 @@
|
||||||
../../../screenshot.png
|
|
Before Width: | Height: | Size: 23 B After Width: | Height: | Size: 7.3 KiB |
Binary file not shown.
Before Width: | Height: | Size: 23 B After Width: | Height: | Size: 7.3 KiB |
|
@ -4,7 +4,6 @@ Overview
|
||||||
Brutal Maze is a thrilling shoot 'em up game with minimalist art style.
|
Brutal Maze is a thrilling shoot 'em up game with minimalist art style.
|
||||||
|
|
||||||
.. image:: images/screenshot.png
|
.. image:: images/screenshot.png
|
||||||
:target: recplayer.html
|
|
||||||
|
|
||||||
Notable features:
|
Notable features:
|
||||||
|
|
||||||
|
@ -28,11 +27,11 @@ Table of Contents
|
||||||
config
|
config
|
||||||
gameplay
|
gameplay
|
||||||
remote
|
remote
|
||||||
credits
|
copying
|
||||||
|
|
||||||
Indices and tables
|
Record Player
|
||||||
------------------
|
-------------
|
||||||
|
|
||||||
* :ref:`genindex`
|
.. raw:: html
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
<iframe src='recplayer.html' width=640 height=480></iframe>
|
||||||
|
|
BIN
screenshot.png
BIN
screenshot.png
Binary file not shown.
Before Width: | Height: | Size: 7.3 KiB |
Loading…
Reference in New Issue