McSinyx/brutalmaze
McSinyx
/
brutalmaze
1
1
Fork 0
Code Issues 3 Pull Requests Releases Activity

Add further description on game recording

This commit is contained in:
Nguyễn Gia Phong 2018-08-06 21:59:00 +07:00
parent d6dfd43158
commit 6d2f6d6ad3
2 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -92,6 +92,14 @@ about I/O format are explained carefully in
`Remote control <https://github.com/McSinyx/brutalmaze/wiki/Remote-control>`_
wiki page.
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]_.
Recordings can be played on the repo's Github Page which the above screenshot
is linked to.
License
-------
@ -114,3 +122,5 @@ authors and licenses are listed in
.. [3] 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 <https://github.com/McSinyx/brutalmaze/wiki/Configuration>`_
to see more options.

6
docs/README.md
View File

@ -1,3 +1,7 @@
# Brutal Maze record player
Hosted by Github Pages: https://McSinyx.github.io/brutalmaze/
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 via
command-line option `--record-dir` or `Directory` in configuration file's
`Record` section. Recordings can be played on
[the repo's Github Page](https://McSinyx.github.io/brutalmaze/).