Thank you for wanting to contribute to this project!
This project depends on the Foundry VTT community. That is why we try to accept all contributions no matter how small, or how new you are to programming or Foundry. The below are mostly guidelines on how to contribute to the project.
Note: Please don't file an issue to ask a question. You'll get better help by using the resources below.
If you have usage questions the best place to get help is in the #free-league channel on the official Foundry VTT Discord.
Otherwise, discussion about the development of the Blade Runner RPG system can be found in discussions.
We are grateful for any and all localization support we can get. To localize the system you do not need to download or set up the system. To make it easier to help with localization we are using the Weblate's Foundry VTT Hub. All you need is a Weblate account. Then you can head over to our Weblate page and start translating.
Don't worry!
Click the "Add Language" button and get started. 👍
Important! You need to have node.js LTS-version installed with npm available.
Fork or Clone the project and open the project folder in your terminal:
# Install the dependencies.
npm install# Build the dist folder where the system package lives.
npm run devTo make sure that Foundry VTT will be able to detect the system so you can debug properly, you need to connect your dist folder with a symbolic link or folder junction in the systems/-folder in FoundryVTT/Data. You should make sure you do not have a pre-existing forbidden-lands installation in the systems/-folder.
Configure a pathconfig-file in the project's root folder it should contain information that looks like this:
{
// On Linux / macOS
"dataPath": "/absolute/path/to/your/FoundryVTT/Data"
}{
// On Windows
"dataPath": "\\absolute\\path\\to\\your\\FoundryVTT\\Data"
}{
// Relative path
"dataPath": "../../Data"
}Once you have configured where your Foundry VTT Data-folder is, you can link the dist folder:
# Run the project linking command.
npm run link
# or
npm run link:forceIf the above didn't work, try a direct command instead:
# Unix
ln -s dist/* /absolute/path/to/foundry/data/system-name
# cmd
mklink /J /absolute/path/to/link /absolute/path/to/this/repo/distYou should now be able to open Foundry VTT and create a world using the Blade Runner RPG system.
If you do, congratulations:tada:! To begin editing the code:
# Run the command that builds the dist folder then watches it for changes.
npm run dev #This builds the dist directory and ports static files
npm run dev:watch #Same as above and watches for files changes.You can cancel watching the files for changes by using the command ctrl + c in the terminal window.
It's not working! If somewhere along the line something failed, or you are not seeing the Blade Runner RPG system in Foundry. Do not stress! Please reach out to us in either Discord or the Discussions here. See But I just have a question!
This project uses the git hooks automator: Husky. Husky helps improve the workflow of the project by controlling commit messages for semver compatibility, and automates building, linting and formatting. For your own ease of use it is important you make sure that Husky is functioning correctly.
To do so make a test branch in the project and commit a new file using a commit message that will fail. E.g.
git checkout -b test-branch
touch test.file
git commit -am "feat: test commit"You should now see Husky running. And if it works correctly the commit should pass and an emoji should be added to the commit message lke so feat: ✨ test commit.
If you have permission issues with Husky on Linux or macOS. Run the below commands to set the right executable permissions for Husky and git hooks.
chmod ug+x .husky/*
chmod ug+x .git/hooks/*Following are some of the files and folders that you may be interested in editing, and some you shouldn't edit:
.
├── 📁 .github
├── 📁 .husky
├── 📁 archive
├── 📁 dist*
├── 📁 node_modules*
├── 📁 src
│ ├── 📁 actor
│ │ └── 📁 character
│ ├── 📁 components
│ │ └── 📁 roll
│ ├── 📁 item
│ ├── 📁 plugins
│ ├── 📁 styles
│ ├── 📁 system
│ ├── 📁 utils
│ ├── blade-runner.js
│ └── blade-runner.scss
├── 📁 static
│ ├── 📁 assets
│ │ └── 📁 icons
│ ├── 📁 fonts
│ ├── 📁 lang
│ ├── 📁 lib
│ ├── system.json
│ └── template.json
├── 📁 tools
├── .editorconfig
├── .eslintignore
├── .eslintrc
├── .gitattributes
├── .gitignore
├── .prettierignore
├── .prettierrc
├── CHANGELOG.md
├── CONTRIBUTING.md
├── esbuild.config.js
├── gulpfile.js
├── jsconfig.json
├── LICENSE
├── package.json
├── package-lock.json
├── pathconfig.example
└── README.md
.github/: This directory contains Github Actions CI files and Github Issue Templates..husky/: This is a git hooks enhancment tool. See .Huskydist/*Generated: The directory contains the output of the build process. It is not part of the git repository.node_modules/*Generated: A directory generated when running thenpm installcommand. It contains all the dependencies of the project.src/: This is the directory you want to focus most of your attention on. It contains the following files and subdirectories:actor/&item/: Javascript documents, sheets and templates for the actors (character) and items. The subfolderstemplates/contains all the html, or handlebars partials if you like. They are formatted as.hbs.plugins/: Everything related to third-party modules goes there. (e.g. Dice So Nice)styles/: The project uses SASS (SCSS). It is almost like CSS except it allows for modularization and more perks.system/: Core Javascript modules for the game system.utils/: Collection of utilitary methods used in the game system.- The main file
blade-runner.jsimports the scripts in the subdirectories and configures the system. - The main style file
blade-runner.scssonly imports the various partial files.
static/: The static directory contains assets and the system- and template.json files. This directory rarely sees changes. It contains the following subdirectories:assets/: Pictures, icons, and other assets.fonts/: Typography files.lang/: Language files. You may opt to do localization directly on the files. Note: This is not the preferred way of doing localization.
tools/: Other utilities not used by the game system..editorconfig,.eslintrc,.gitattributes,.prettierrc: These files achieve the same goal. They lint and format the code to comply with the style guide..eslintignore,.gitignore,.prettierignore: These are ignore files configured to ignore certain directories that do not require linting or configuring.CHANGELOG.md: This file contains changes made up until the latest release. It is automatically generated when one of the admins bumps the version of the system.CONTRIBUTING.md: You are reading it.esbuild.config.js: The config file for javascript concatenation..jsconfig.jsonandgulpfile.js: These files contains the configuration for the scripts used to build and watch the project as well as releases.LICENSE: The License file for the project.package-lock.jsonandpackage.json: These files are used bynpmto configure the project, and track dependencies.pathconfig.example: Rename this filepathconfigand edit it to contain the absolute path to yourFoundry VTT/Data-folder.README.md: The Readme and project page.
Glad you asked!
At any time the project has a few open issues. If there is anything in there you think you would want to cut your teeth on, please do! Check open pull requests first to see if there are anyone working on the issue. If you decide to tackle an issue, assign yourself to it, or comment on it, to indicate that you intend to work on it.
Our project page contains a list of features and bugs that are suggested improvements to the system. Maybe there is something in there you would like to tackle.
Maybe you have found a bug, or maybe you have a feature in mind that you would like to see implemented. Head over to the issue tracker first, and see if it is already listed there. If it is not, go ahead and open an issue, if it is feel free to bump it or comment on it.
If you want to work on a bug or a feature yourself, please raise an issue first then assign yourself to it or indicate that you will be working on it. This way we don't end up with two people working on the same thing:bulb:
Check the instructions for localization with GitLocalize, as this helps you help us with localization.
We are always looking for someone who can help with the project or one of the other projects in our organization. If you do not feel like you can contribute yourself, maybe you know someone who can:vulcan_salute:
When you are ready to submit a pull request, make sure you do a few things to help speed up the process.
- Keep it tidy. Fewer commits with changes logically grouped together makes it easier to review them.
- Make sure Husky has done its job. E.g. check your commit messages to confirm that they follow Conventional Commits Standards.
- Now you are ready to submit a Pull Request. The project contains two branches:
main, andlocalization. When submitting a Pull Request make sure to point it to themainbranch. Unless, you are pushing a localization change, then point tolocalizationinstead. - When creating the Pull Request consider prefacing the title with an emoji that indicates the type of pull request.
- Briefly describe the pull request and whether you have made any deletions or modifications that may be breaking.
- That's it! Thank you so much for your help with improving this project:purple_heart: