diff options
author | Nguyễn Gia Phong <vn.mcsinyx@gmail.com> | 2018-08-06 21:59:00 +0700 |
---|---|---|
committer | Nguyễn Gia Phong <vn.mcsinyx@gmail.com> | 2018-08-06 21:59:00 +0700 |
commit | 6d2f6d6ad3348570664d84c188560cb9ae4aac82 (patch) | |
tree | 0aff0f0222085624761e6a702a421989df14342b /README.rst | |
parent | d6dfd431588624510574c2386a563af890c4adc1 (diff) | |
download | brutalmaze-6d2f6d6ad3348570664d84c188560cb9ae4aac82.tar.gz |
Add further description on game recording
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 10 |
1 files changed, 10 insertions, 0 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. |