A C++ library capable of hosting text adventures and MUDs with one or more players.
- G++ 7+ or Clang++ 8+. A different compiler might work, but it hasn't been tested, so you're on your own.
- CMake 3.10 or above
- LibXML2 (libxml2-dev package on Ubuntu)
- Lua 5.1, 5.2, or 5.3 (lua5.x-dev package on Ubuntu, where 5.x is the version you're compiling against)
- RapidJSON >= 1.1.0 (only required if you're building the optional built-in JSON serialization driver)
- SQLite3 (only required if you're building the optional built-in SQLite serialization driver)
By default, trogdor-pp compiles against Lua 5.3, but will also build against 5.1 and 5.2. To set the lua version to any other version, just prefix your make command with "LUA_VERSION=5.x".
Build has been tested against Lua 5.1, 5.2, and 5.3.
To install all dependencies in one fell swoop on Ubuntu 18.04 and up:
$ apt-get install cmake g++ libxml2-dev lua5.x-dev (where 5.x is your preferred Lua version)
To install the optional SQLite dependency on Ubuntu 18.04 and up:
$ apt-get install libsqlite3-dev
To install the optional JSON dependency on Ubuntu 18.04 and up:
$ apt-get install rapidjson-dev
To build and install the library and accompanying sample data, issue these commands:
cd src/core && cmake -DCMAKE_BUILD_TYPE=Release .
make trogdor && make install
The library will be installed along with the include files for development in /usr/include/trogdor and sample game data in /usr/share/trogdor.
Trogdor-pp supports Lua 5.1, 5.2, and 5.3. 5.3 is the default, but you can select one of the other supported versions by passing LUA_VERSION=5.x into your cmake command, where 5.x is the desired version.
To build the trogdor library with support for the built-in JSON serialization format, add -DENABLE_SERIALIZE_JSON=ON to your cmake command above (requires the RapidJSON header-only library in your include path to build successfully.)
To build the trogdor library with support for the built-in SQLite3 serialization format, add -DENABLE_SERIALIZE_SQLITE=ON to your cmake command above (requires the SQLite3 library and headers to be installed in a place where CMake can find them.)
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.
If you need to install relative to a custom path, add this to your cmake command: -DCMAKE_INSTALL_PREFIX:PATH=/your/custom/prefix.
To install the C++ headers and pkgconfig files for development purposes:
cd src/core && cmake -DCMAKE_BUILD_TYPE=Release .
make install_dev