When building a new system, you have several options to choose from. You can copy an existing system (depending on its license) like the Simple World-building system, you can use a system generator, or you could start from scratch and have total control.
¶ Option 1: Use the Boilerplate generator
First, clone the Boilerplate repository
git clone https://github.com/asacolips-projects/boilerplate.git
Second, install the dependencies for the generator. You'll need node.js installed, ideally version 20 or higher. Once you have node, execute the following from inside the boilerplate directory.
npm install
Finally, run the generator. It will prompt you to name your system in several different ways, like my-system for your package name and MySystem for class names.
npm run generate
This will create a generated version of Boilerplate that handles all of the filename and text replacements for you. The generated version will be saved to boilerplate/build/<your-system-name and then you can move the <your-system-name> directory out of the build directory and into your /Data/systems directory of your Foundry userData folder.
¶ Option 2: Boilerplate with manual replacements
- Download a zip version of the Boilerplate System
- Extract it to the
/Data/systemsdirectory in your Foundry userData folder and rename it fromboilerplate-masterto your system's name (lowercase, machine-safe). - Search the directory for any files with the filename
boilerplateand rename them to your system's machine-safe name, such asmysystemname. - Search the files for any occurrences of
Boilerplate(case-sensitive) and replace those with a capitalized version of your system name that's still machine-safe, such asMySystemName. These are typically used for the classes in the Javascript files. - Search the files for any occurrences of
boilerplate(case-sensitive) and replace those with a lowercase machine-safe version of your system name, such asmysystemname. - If the replace instructions from step 4 also included updating your description in system.json, you should edit that to be more readable now, such as "My System Name".
From here, you can skip to the next page or keep reading if you'd like to read about the other options for starting a new system.
¶ Other options
If you'd like to see other options for getting started with building a new system to start from, see the Other options page.
- Next: Stuff to be aware of