ironarachne / world

This is a fantasy world generation CLI and set of Go packages for the same.
MIT License
48 stars 9 forks source link
hacktoberfest procedural-generation procgen tabletop-gaming tabletop-rpgs worldbuilding

World Generator

This is a tool and library to procedurally generate fantasy worlds.

Configuration

The best way to configure the executable is to put a world.yaml file in your working directory and pass it to the binary with the -c flag. For example:

world -c world.yaml culture

The file is structured like this:

data_dir: <data directory>
save_dir: <save directory>
save_target: <either "DO" or "filesystem">
web_domain: <final web domain>

The following environment variables configure the executable and are required if not specified in the config file:

Building

Run ./build.sh. The binary will be dist/world.

Running in Development

Run ./run.sh <command>. It will set sane defaults and use the local filesystem for saving files.