Spheres for Pathfinder 1e

This module for the Pathfinder 1e game system for Foundry Virtual Tabletop provides additional functionality and support for the rule sets Spheres of Power and Spheres of Might from Drop Dead Studios.

As the module is still heavily in development, the best source for available features and notable changes is its changelog.

Installation

To install the module navigate to Foundry's Add-on Modules tab in the Setup menu and paste the following link in the Install Module dialog:

https://github.com/ethaks/pf1spheres/releases/latest/download/module.json

The module can also be installed manually by downloading a zip archive from the Releases Page and extracting it to Foundry's Data/modules/pf1spheres directory.

Development

Prerequisites

In order to build this module, recent versions of node and npm are required. Most likely using yarn also works but only npm is officially supported. 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 project's dependencies. To do so, run

npm ci

Building

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.

Linking the built project to Foundry VTT

In order to provide a fluent development experience, it is recommended to link the built module 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"
}

(if you are using Windows, make sure to use \ as a path separator instead of /)

Then run

npm run link-package

On Windows, creating symlinks requires administrator privileges so unfortunately you need to run the above command in an administrator terminal for it to work.

Running the tests

You can run the tests with the following command:

npm test

A manual type checking process can be started by running

npm run typecheck

This project uses Vite. After having built the module as least once as per building, you can start a development server by running

npm run serve

This development server runs on port 30001, and is able to hot reload CSS and Handlebars template changes, as well as offering some reload functionality for TS code changes.

Legal

The software component of this system is licensed primarily under the EUPL v. 1.2. REUSE is used to specify licenses for individual files in the form of headers or .license files, or in .reuse/dep5. The rules and game content is distributed under the terms of the Open Gaming License v1.0a. The terms of the Foundry Virtual Tabletop End User License Agreement apply.

This system uses trademarks and/or copyrights owned by Paizo Inc., which are used under Paizo's Community Use Policy. We are expressly prohibited from charging you to use or access this content. This module is not published, endorsed, or specifically approved by Paizo Inc. For more information about Paizo's Community Use Policy, please visit paizo.com/communityuse. For more information about Paizo Inc. and Paizo products, please visit paizo.com.