OpenRPG is still in its infancy and I want it to do a lot by v1.0.0!
What OpenRPG aims to accomplish two fold.
First, it will be a tool for someone to use to quickly create content for a tabletop RPG world. v1.0.0 will focus specifically on the 5e rules, however I hope to have that expand out to include Pathfinder and as far back as AD&D.
Secondly, OpenRPG should be structured in such a way that game developers that want to emulate the d20 system in a video game could easily implement our libraries in their games to help speed production of back end tools.
Some of the features this tool will include by v1.0.0 are:
- A GUI front-end for the CLI tools
- A die simulation tool
- A name generator tool
- A character generator tool (with the option to autofill a character sheet)
- A town generator tool
- An encounter/combat generator tool
- A world generator tool
- A world/town map generator
... And more (hopefully)!
v0.1.0 is a basis for the CLI/developer version, but v1.0.0 will contain a portable GUI that works on Windows, Linux, and macOS.
Currently we require cmake (at least v2.8.4) and make, and your choice of C/C++
compiler that supports at least the C++11 standard.
Note: This project strives to keep its source as clean of any dependancies to be as cross platform as possible. If you have suggestions to help move toward that goal, please feel free to open issues, or even a PR!
The build script now provides some extra assistance with building, installing, uninstalling and more.
Debug build: $ ./build.sh
Install debug build: $ ./build.sh install
Release build: $ ./build.sh release
Install release build: $ ./build.sh release install
Linux clean build: $ ./build.sh clean
Linux clean and rebuild: $ ./build.sh rebuild
Note: build.sh has the potential to work on MacOS, but is currently untested. If you happen to use a Mac, please test this!
This script is VERY minimal compared to its bash counterpart. It could use a ton of improvements, so if that is something you are interested in, open a PR!
Simply run > build.bat
Create a build directory $ mkdir build && cd build
Run cmake $ cmake .. OR Optionally run $ cmake -DCMAKE_INSTALL_PREFIX=/desired/install/location ..
Run make $ make
In the build/ folder, run make check $ make check
After building, in the build/ folder, run make install $ make install
After installing, in the build/ folder, run make uninstall $ make uninstall
OpenRPG Software License - Version 1.0 - February 10th, 2017 https://www.openrpg.io/about/license/