Skip to content

Commit

Permalink
trogdord: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
crankycyclops committed Jun 23, 2021
1 parent 7c6e187 commit b22a8d9
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
2 changes: 2 additions & 0 deletions src/trogdord/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ If you're interested in writing your own client-side connector, or just want to
* [Standalone ASIO library](https://think-async.com/Asio/) >=1.10 (libasio-dev package on Ubuntu)
* [INIH (INI Not Invented Here)](https://github.com/benhoyt/inih) (libinih1 and libinih-dev packages on Ubuntu)
* [RapidJSON](https://rapidjson.org/) >= 1.1.0
* [SQLite3](https://www.sqlite.org/) >= 3.0
* [Hiredis](https://github.com/redis/hiredis) 0.13+ (optional, for Redis Pub/Sub support in trogdord)
* The core library, installed as a shared object or DLL in a place where CMake can find it (corresponds to the trogdor build target)

Expand All @@ -60,6 +61,7 @@ make trogdord && make install

To build trogdord with redis support, add `-DENABLE_REDIS=ON` to your cmake command above.
To build trogdord with support for the JSON serialization format, add `-DENABLE_SERIALIZE_JSON=ON` to your cmake command above.
To build trogdord with support for the SQLite3 serialization format, add `-DENABLE_SERIALIZE_SQLITE=ON` to your cmake command above.

If you need debug symbols, add the following option to your cmake command: `-DCMAKE_BUILD_TYPE=Debug`. If you've already built it using debug symbols in the past and want to switch back to a release build, use this cmake option instead: `-DCMAKE_BUILD_TYPE=Release`.

Expand Down
5 changes: 3 additions & 2 deletions src/trogdord/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,10 @@ Every new installation of trogdord includes the following default configuration
; enabled=false

; This is the serialization format that should be used when saving a game's
; state. By default, we use json (requires support for the JSON serialization
; driver to be turned on during the compilation of the core library.)
; state. The two built-in formats (if enabled during compilation) are json
; and sqlite.
; format=json
; format=sqlite

; This is the default path where game state is saved. Relative paths are based
; on the root directory where trogdord was installed.
Expand Down
5 changes: 2 additions & 3 deletions src/trogdord/etc/trogdord.ini
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,8 @@
; enabled=false

; This is the serialization format that should be used when saving a game's
; state. By default, we use json (requires support for the JSON serialization
; driver to be turned on during the compilation of the core library.) The
; other available format is sqlite.
; state. The two built-in formats (if enabled during compilation) are json
; and sqlite.
; format=json
; format=sqlite

Expand Down

0 comments on commit b22a8d9

Please sign in to comment.