In order to build this system, recent versions of node and npm are
required. Most likely using yarn also works but only npm is officially
supported. We recommend using the latest LTS version of node, which is
v18 at the time of writing. If you use nvm to manage your node
versions, you can simply run
nvm install
in the project's root directory.
You also need to install the the project's dependencies. To do so, run
npm install
You can build the project by running
npm run build
Alternatively, you can run
npm run build:watch
to watch for changes and automatically build as necessary.
In order to provide a fluent development experience, it is recommended to link
the built system to your local Foundry VTT installation's data folder. In
order to do so, first add a file called foundryconfig.json to the project root
with the following content:
{
"dataPath": "/absolute/path/to/your/FoundryVTT/Data"
}
- The dataPath is where the Foundry data is stored (e.g. in AppData)
(if you are using Windows, make sure to use \ as a path separator instead of
/)
Then run
npm run link-project
On Windows, creating symlinks requires administrator privileges so unfortunately you need to run the above command in an administrator terminal for it to work.
You can run the tests with the following command:
npm test