diff options
| -rw-r--r-- | README.rst | 10 | ||||
| -rw-r--r-- | docs/README.md | 6 |
2 files changed, 15 insertions, 1 deletions
diff --git a/README.rst b/README.rst index a8e7990..302fc32 100644 --- a/README.rst +++ b/README.rst @@ -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. diff --git a/docs/README.md b/docs/README.md index f55a93e..dadc38f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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/). |