forked from foundryvtt/pf2e
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The Open Game License needs to be distributed with every build in order to finish issue foundryvtt#352 .
- Loading branch information
1 parent
46e2af5
commit 16331d5
Showing
3 changed files
with
41 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,25 @@ | ||
| If you would like to contribute to the project then I welcome all support. If you are a developer (or would like to be) the hit me up in discord and I can help get you up and running. Merge requests are welcome and there are plenty of issues logged if you want to sink your teeth into something. | ||
| # CONTRIBUTING.md | ||
|
|
||
| ## Welcome All | ||
|
|
||
| If you would like to contribute to the project then I welcome all support. If you are a developer (or would like to be) the hit me up in discord and I can help get you up and running. Merge requests are welcome and there are plenty of issues logged if you want to sink your teeth into something. | ||
|
|
||
| ## Setup | ||
|
|
||
| The project uses webpack to package the SASS files needed for a build and can create a local distribution for your own Foundry server. If you want to give it a go yourself follow these steps: | ||
|
|
||
| * Clone the repo into a local folder in your dev environment `git clone https://gitlab.com/hooking/foundry-vtt---pathfinder-2e.git pf2e-dev` | ||
|
|
||
| * Install the Javascript dependencies with `npm ci` | ||
| * Optionally, configure a `foundryconfig.json` file in the root folder of the project with `dataPath` and `systemName` attributes. An example can be found in `foundryconfig.example.json`, simply copy it and remove the `.example`, and configure it accordingly. The dataPath attribute is your User Data Folder from Foundry and can be found on the Configuration tab on the Setup screen. If you do not configure this file, the build will be built in the dist folder | ||
|
|
||
| * *-Optional-* Configure a `foundryconfig.json` file in the root folder of the project with `dataPath` and `systemName` attributes. An example can be found in `foundryconfig.example.json`, simply copy it and remove the `.example`, and configure it accordingly. The dataPath attribute is your User Data Folder from Foundry and can be found on the Configuration tab on the Setup screen. If you do not configure this file, the build will be built in the dist folder | ||
|
|
||
| * Run `npm run build` to perform a one off compile/build | ||
|
|
||
| * Run `npm run build:dev` to keep the pf2e system in your Foundry User Data Folder up to date with any coding changes you make in your dev environment. | ||
|
|
||
| ## How to Help | ||
|
|
||
| As a project, we are using a modified gitlab flow, with a development branch (master) for development and a release branch (release) that contains one commit per release. If you want to make improvements to the project, you can ask to be added to the project or make a fork of the project in gitlab. Then push your branch to gitlab and open a merge request for your branch to our development branch. After being reviewed it can be merged into the project by one of the project maintainers. | ||
|
|
||
| Note: we have started to integrate Prettier into this project but it is still early days. Please do not submit any merge requests with reformatted / auto-formatted code outside of what you are actively contributing to. Unfortunately there is a lot of technical debt in this project and we will be biting it off in small chunks. | ||
| **Note about Prettier:** we have started to integrate Prettier into this project but it is still early days. Please do not submit any merge requests with reformatted / auto-formatted code outside of what you are actively contributing to. Unfortunately there is a lot of technical debt in this project and we will be biting it off in small chunks. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,45 @@ | ||
| # PF2e System | ||
| # PF2e System for FoundryVTT | ||
|
|
||
| A community contributed game system for Pathfinder Second Edition. | ||
| > ⚔️ This is a community created game system to run Pathfinder Second Edition games on FoundryVTT. | ||
| 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 system 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. | ||
|
|
||
| ### System Version | ||
| This is a community created game system to run Pathfinder Second Edition games on virtual table top platforms. | ||
|
|
||
| Patch Notes: | ||
| See CHANGELOG | ||
| ## Shoutouts | ||
|
|
||
| A huge thanks to the large team of contributers and a special thanks to the following for code and art that we have used in this project: | ||
|
|
||
| Please Note: | ||
| - Functionality is not complete with plenty of work remaining. | ||
| - If you find any issues or have any feedback please let me know. | ||
| - __[Fatman#0714](https://www.reddit.com/user/FatMani)__ for creating the amazing token markers for the Pathfinder conditions used in the system. | ||
| - __Furyspark#7513__ and __Dan Gomme__ for the great work creating the Pathfinder measurement templates in the Pathfinder 1e system which I have incorporated into this system. | ||
| - __[@fyjham-ts](https://github.com/fyjham-ts/Pathfinder-2E-Spell-DB)__ for the raw data I used (and __FS#5443__ for pointing me to it). | ||
| - __Felix#6196__ for the creation of [Spell Browser](https://github.com/syl3r86/Spell-Browser) and kind permission to allow me to incorporate it into this system. | ||
| - __[u/baughberick](https://www.reddit.com/user/baughberick/)__ for the creation of the Pathfinder2eActions font. | ||
|
|
||
| ## WIP and Feedback | ||
|
|
||
| ### Shoutouts | ||
| > 🛠️ Please note that the functionality of this project is not complete and there is plenty of work remaining. | ||
| A huge thanks to the large team of contributers and a special thanks to the following for code and art that we have used in this project: | ||
| If you have any suggestions or feedback, please contact me on Discord @ **hooking[UTC+12]#0492** or drop by the #pf2e channel on the Foundry Discord server. | ||
|
|
||
| - Fatman#0714 (https://www.reddit.com/user/FatMani) for creating the amazing token markers for the Pathfinder conditions used in the system. | ||
| - Furyspark#7513 and Dan Gomme for the great work creating the Pathfinder measurement templates in the Pathfinder 1e system which I have incorporated into this system. | ||
| - @fyjham-ts https://github.com/fyjham-ts/Pathfinder-2E-Spell-DB for the raw data I used (and FS#5443 for pointing me to it). | ||
| - Felix#6196 for the creation of Spell Browser (https://github.com/syl3r86/Spell-Browser) and kind permission to allow me to incorporate it into this system. | ||
| - u/baughberick (https://www.reddit.com/user/baughberick/) for the creation of the Pathfinder2eActions font. | ||
| ## Licenses | ||
|
|
||
| ### Feedback | ||
| **Project Licensing:** | ||
|
|
||
| If you have any suggestions or feedback, please contact me on discord (hooking[UTC+12]#0492) or drop by the #pf2e channel on the Foundry discord server. | ||
| - All HTML, CSS and Javascript in this project is licensed under the Apache License v2. | ||
|
|
||
| ### Licenses | ||
| **Content Usage and Licensing:** | ||
|
|
||
| Project Licensing: | ||
| * All HTML, CSS and Javascript in this project is licensed under the Apache License v2. | ||
| - Any Pathfinder Second Edition information used under the Paizo Inc. Community Use Policy (<https://paizo.com/community/communityuse>) | ||
| - Game system information and mechanics are licensed under the Open Game License (OPEN GAME LICENSE Version 1.0a). | ||
| - License information for the art used in this project is included in the ./packs/ folder alongside the JSON of where it is referenced. | ||
|
|
||
| **Virtual Table Top Platform Licenses:** | ||
|
|
||
| Content Usage and Licensing: | ||
| * Any Pathfinder Second Edition information used under the Paizo Inc. Community Use Policy (https://paizo.com/community/communityuse) | ||
| * Game system information and mechanics are licensed under the Open Game License (OPEN GAME LICENSE Version 1.0a). | ||
| * License information for the art used in this project is included in the ./packs/ folder alongside the JSON of where it is referenced. | ||
| - Foundry VTT support is covered by the following license: [Limited License Agreement for module development 09/02/2020](https://foundryvtt.com/article/license/). | ||
|
|
||
| ## Patch Notes | ||
|
|
||
| Virtual Table Top Platform Licenses: | ||
| * Foundry VTT support is covered by the following license: [Limited License Agreement for module development 09/02/2020](https://foundryvtt.com/article/license/). | ||
| See [CHANGELOG.md](./CHANGELOG.md) | ||
|
|
||
| ### Contributing | ||
| ## Contributing | ||
|
|
||
| See CONTRIBUTING.md | ||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) |
File renamed without changes.