CONTRIBUTING.md

Contributing

For a more hands-on onboarding experience before making your first contributiion to this repo, I recommend joining our Unofficial OSE on Foundry VTT Discord server.

Installation

Prerequisites: Node.js, npm, Foundry VTT with a valid license

1. (Star) and Fork this repo.
2. Clone your fork to a directory suitable for containing your code projects, such as /yourusername/Github/. It will create the ose directory.
3. Open ose in an IDE and/or your Terminal.
4. In Terminal (you are in the ose directory), run npm i.
5. Create a foundryconfig.json file in the ose directory.

/foundryconfig.json

{
  "dataPath": "path/to/your/user/Data/ REPLACE THIS STRING"
}

1. In Terminal run npm run build.
2. Make any code contributions in the /src directory.
3. Run npm run build any time you need to apply those changes, or run npm run watch to have it apply changes automatically.