Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethaks/pf1spheres
An implementation of Spheres of Power/Might for the Pathfinder 1e system for Foundry VTT
https://github.com/ethaks/pf1spheres
foundryvtt
Last synced: about 1 month ago
JSON representation
An implementation of Spheres of Power/Might for the Pathfinder 1e system for Foundry VTT
- Host: GitHub
- URL: https://github.com/ethaks/pf1spheres
- Owner: Ethaks
- License: eupl-1.2
- Created: 2024-06-18T16:46:43.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-07-07T14:20:24.000Z (6 months ago)
- Last Synced: 2024-10-15T01:45:38.987Z (3 months ago)
- Topics: foundryvtt
- Language: TypeScript
- Homepage:
- Size: 32.2 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Spheres for Pathfinder 1e
This module for the [Pathfinder 1e game system](https://gitlab.com/foundryvtt_pathfinder1e/foundryvtt-pathfinder1) for [Foundry Virtual Tabletop](http://foundryvtt.com/) provides additional functionality and support for the rule sets [Spheres of Power](https://www.dropdeadstudios.com/spheres-of-power) and [Spheres of Might](https://www.dropdeadstudios.com/spheres-of-might) from [Drop Dead Studios](https://www.dropdeadstudios.com/).
As the module is still heavily in development, the best source for available features and notable changes is its [changelog](CHANGELOG.md).
## 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](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
```bash
nvm install
```
in the project's root directory.
You also need to install the project's dependencies. To do so, run
```bash
npm ci
```
### Building
You can build the project by running
```bash
npm run build
```
Alternatively, you can run
```bash
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:
```json
{
"dataPath": "/absolute/path/to/your/FoundryVTT/Data"
}
```
(if you are using Windows, make sure to use `\` as a path separator instead of `/`)
Then run
```bash
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:
```bash
npm test
```
A manual type checking process can be started by running
```bash
npm run typecheck
```
This project uses [Vite](https://vitejs.dev/).
After having built the module as least once as per [building](#Building), you can start a development server by running
```bash
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](https://foundryvtt.com/article/license/) apply.
This system uses trademarks and/or copyrights owned by Paizo Inc., which are used under [Paizo's Community Use Policy](https://paizo.com/community/communityuse).
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](https://paizo.com/communityuse).
For more information about Paizo Inc. and Paizo products, please visit [paizo.com](https://paizo.com).