Rebase v 173

.all-contributorsrc

@@ -85,12 +85,49 @@
       "contributions": [
         "translation"
       ]
+    },
+    {
+      "login": "hogwrassler",
+      "name": "hogwrassler",
+      "avatar_url": "https://avatars.githubusercontent.com/u/110945935?v=4",
+      "profile": "https://github.com/hogwrassler",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "wyrmisis",
+      "name": "Tim",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1731267?v=4",
+      "profile": "http://timsnyder.codes",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "maschill92",
+      "name": "Michael Schilling",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4692066?v=4",
+      "profile": "https://github.com/maschill92",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Haxxer",
+      "name": "Adam Oresten",
+      "avatar_url": "https://avatars.githubusercontent.com/u/12858387?v=4",
+      "profile": "http://adamoresten.com",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,
   "projectName": "ose",
   "projectOwner": "vttred",
   "repoType": "github",
   "repoHost": "https://github.com",
-  "skipCi": true
+  "skipCi": true,
+  "commitConvention": "angular"
 }

.gitattributes

@@ -1 +1 @@
-system.json filter=devLink
+system.json filter=mungePackageID

.gitconfig.example

@@ -0,0 +1,5 @@
+; Windows users will have to use Windows filepaths
+[filter "mungePackageID"]
+    required = true
+    smudge = 'sh "./scripts/smudgePackageID.sh"'
+    clean = 'sh "./scripts/cleanPackageID.sh"'

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,84 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug", "triage"]
+assignees:
+  - anthonyronda
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Give us the details of the steps taken, and the unexpected result you experienced.
+      placeholder: |
+        Reproduction steps:
+        1. I clicked the token.
+        2. The token jumped across the scene 10 spaces to the left.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behaviour
+    attributes:
+      label: What is the expected behaviour?
+      description: If this is a bug, what would you expect the fix to do?
+      placeholder: |
+        When I click the token, it becomes selected and stays in its current position.
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant Errors and Warnings
+      description: Is there an error message or warning in the browser console when you experienced this behaviour? Right after triggering the bug, press F12 and copy anything relevant in the console window. Paste that here.
+      render: shell
+  - type: textarea
+    id: debug
+    attributes:
+      label: Additional Support Details
+      description: With your Foundry VTT game active, you may click the Game Settings tab, then click the Support button. Please copy the debug information and paste it below.
+      placeholder: |
+        Foundry Virtual Tabletop: Version 9, 9.269
+        Game System: ose, 1.5.1
+        Active Modules: 9
+        Performance Mode: 1
+
+        OS: Intel Mac OS X 10.15
+        Client: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:103.0) Gecko/20100101 Firefox/103.0
+        GPU: Apple M1
+        Max Texture Size: 8192
+        ...
+  - type: dropdown
+    id: core-version
+    attributes:
+      label: Foundry VTT Core Version
+      description: Which version of Foundry VTT is installed? Skip this if you provided Additional Support Details.
+      options:
+        - V10
+        - V9
+        - 0.8.6-0.8.10
+        - Earlier than 0.8.6
+  - type: input
+    id: system-version
+    attributes:
+      label: Old-School Essentials Core Version
+      description: Which version of Old-School Essentials Foundry VTT Edition are you using? Skip this if you provided Additional Support Details.
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: Please update your browser regularly. Which (updated) browsers are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+        - Other
+  - type: checkboxes
+    id: code-of-conduct
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vttred/.github/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: User Documentation
+    url: https://vtt.red/ose
+    about: "Learn how to get started with Old-School Essentials on Foundry VTT."
+  - name: Old-School Essentials FVTT Edition Discord Community
+    url: https://discord.gg/y6RM86YgNY
+    about: "Ask a question in our #foundryvtt-help channel."

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -0,0 +1,32 @@
+name: Enhancement Request
+description: Request a new feature or improvement to the current functionality.
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this enhancement request!
+  - type: textarea
+    id: new-behaviour
+    attributes:
+      label: New Feature or Changed Behaviour
+      description: Describe your proposed enhancement in detail, and provide examples.
+      placeholder: |
+        Example: Create a new character sheet field called "Race" which automatically changes the naked AC based on the race chosen.
+    validations:
+      required: true
+  - type: textarea
+    id: explanation-of-change
+    attributes:
+      label: Why?
+      description: Would this improve/shorten a player's workflow? Would this be more intuitive? Explain with details and examples.
+      placeholder: |
+        Players will be able to make AC modifications without having to use Tweaks, saving them time and removing an extra field from the Tweaks menu.
+  - type: checkboxes
+    id: code-of-conduct
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vttred/.github/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/workflows/release.yml

@@ -12,12 +12,12 @@ jobs:
       - name: Checkout repository to add to workspace
         uses: actions/checkout@v2
 
-      - name: Setup Node.js version 14
+      - name: Setup Node.js version 16
         uses: actions/setup-node@v2
         with:
           node-version: "16"
 
-      # Caching to improve build speed
+      # # Caching to improve build speed
       - name: Enable caching for Node.js modules
         uses: actions/cache@v2
         with:
@@ -29,7 +29,7 @@ jobs:
 
       # Get dev dependencies for the package, including Gulp and Rollup
       - name: Install dev dependencies
-        run: npm ci --cache .npm --prefer-offline
+        run: npm ci #--cache .npm --prefer-offline --ignore-scripts
 
       # Create a build using Gulp build script
       - name: Run Gulp build script
@@ -43,6 +43,9 @@ jobs:
         with:
           files: "system.json"
         env:
+          name: ose
+          id: ose
+          title: "Old-School Essentials"
           version: ${{github.event.release.tag_name}}
           url: https://github.com/${{github.repository}}
           manifest: https://github.com/${{github.repository}}/releases/latest/download/system.json

CONTRIBUTING.md

@@ -1,6 +1,13 @@
 # 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](https://discord.gg/qGrxRK2yD5).
+We do our best to recognize several ways one can contribute to this project.
+
+- Become a translation contributor from English to your native language
+- Become a design contributor by researching, prototyping, and drawing new interfaces and user experiences
+- Become a documentation or SRD contributor, using primarily English skills or finding mistakes in our SRD compendia
+- **Become a code contributor, using basic or intermediate knowledge of JavaScript to improve how the game system functions**
+
+This guide is focused on the very last type, becoming a code contributor.
 
 ## Developer Environment Installation
 
@@ -9,49 +16,107 @@ Prerequisites: Node.js (v16 is recommended), a familiarity with command Foundry
 [Node installers (beginner-friendly)](https://nodejs.org/en/download/)
 [Node on package managers (recommended, I use nvm)](https://nodejs.org/en/download/package-manager/#windows)
 
-1. With Node.js installed, run the command `npm i npm -g && npm -v` in your preferred command line interface to ensure npm 7 or greater is installed.
+1. With Node.js installed, run the command `npm i npm -g && npm -v` in your preferred command line interface to ensure **npm 7 or greater** is installed.
 1. (Star) and fork this repo.
 1. Clone your fork to a directory suitable for containing your code projects, such as `/yourusername/Github/`. It will create the `ose` directory. In the command line, your command should look like `git clone git@github.com:yourusername/ose.git`.
 1. Open `ose` in an IDE and/or your Terminal and install dependencies. In the command line, `cd ose && npm i`.
-1. Create a `foundryconfig.json` file in the `ose` directory containing a single
+1. Copy the `foundryconfig.json.example` file to your repo's root directory, and rename it `foundryconfig.json`
 
-`/foundryconfig.json`
+   `/foundryconfig.json`
 
-```json
-{
-  "dataPath": "path/to/FoundryVTT REPLACE THIS STRING",
-  "symLinkName": "ose"
-}
-```
+   ```json
+   {
+     "dataPath": [
+       "path/to/FoundryVTT-userdata REPLACE THIS STRING",
+       "path/to/FoundryVTT-userdata-if-you-have-multiple OTHERWISE USE ONLY ONE STRING"
+     ],
+     "symlinkName": "ose-dev"
+   }
+   ```
 
-1. In your command line, run `npm run link`. A new system should now appear in your systems directory but it doesn't yet run any code.
-1. In your command line, run `npm run build` (build once) or `npm run build:watch` (build whenever a change is saved). You now have a working copy of OSE.
+1. In your command line, run `npm run link`. A new system should now appear in your systems directory (or directories) but it doesn't yet run any code.
+1. In your command line, run `npm run build` (build once) or `npm run build:watch` (build continuously, whenever a change is saved). You now have a working copy of OSE's developer build. You should be able to install releases of `ose` alongside this build.
 
 ### Addendum: Git for Beginners
 
 Many contributors to Unofficial OSE on Foundry VTT are inexperienced with git. GitHub provides their [quickstart tutorial](https://docs.github.com/en/get-started/quickstart/hello-world) which we recommend as a first step toward becoming an OSE Contributor.
 
-Here are some next steps to get started on your first code or translation contribution to Unofficial OSE. 
+Here are some next steps to get started on your first code contribution.
 
 1. Create a new branch for your patch. In your command line, `git checkout -b a-branchname-of-your-choosing`
-1. Make any code contributions you'd like, making sure to confirm the behavior you want in Foundry VTT and testing for edge cases if relevant.
-1. When you are satisfied, push the branch to your fork. In your command link, `git push origin a-branchname-of-your-choosing`.
+1. Make any code contributions you'd like, making sure to confirm it performs the behavior you want after trying it in Foundry VTT, and testing for edge cases if relevant.
+1. When you are satisfied, push the branch to your GitHub fork. In your command link, `git push origin a-branchname-of-your-choosing`.
 1. Follow GitHub's instructions for creating a pull request from their website.
 
 ## Troubleshooting
 
-**Errors from `node gyp` when running `npm i` on Windows.**
+To ask for a hand to help onboard you before making your first contribution to this repo, I recommend joining our [Unofficial OSE on Foundry VTT Discord server](https://discord.gg/qGrxRK2yD5).
+
+### Errors from `node gyp` when running `npm i` on Windows.
 
 [Follow these directions](https://github.com/nodejs/node-gyp#on-windows), then run `npm i` again. If you still have issues after trying to follow Microsoft's Node.js guidelines, chat with us on Discord.
 
-**Error: Cannot find module 'rollup'**
+### Error: `Operation not permitted` when trying to run `npm run link`
+
+On Windows you may have to run your shell/command prompt in administrator mode to create a symlink. This should be rare in Linux, but `sudo npm run link` or changing the owner of the Foundry user data directory to the current user should make this command run without errors.
+
+### Error: Cannot find module 'rollup'
 
 You may have skipped `npm i npm -g && npm -v`. If it shows npm version <7.0, then you may have an older version of Node or older operating system and need to upgrade.
 
-**Error: Cannot find module (any module except rollup)**
+### Error: Cannot find module (any module except rollup)
 
 You will need to `npm i` occasionally as we put out updates to the build process. We try to communicate whenever there's a change in devDependencies on Discord and in release notes.
 
 ## Repeat Contributors
 
 Repeat contributors may ask via Discord direct message (@corporat#1282) or email (ose@vtt.red) to be added to a list of people who are interested in referrals for contract work.
+
+## Addendum: Multiple Builds of OSE in the same Foundry VTT installation
+
+The maintainer of this repository has three versions of OSE installed in any given version of Foundry VTT. And 2 or 3 versions of Foundry VTT installed at any given time. Their home directory looks something like this.
+
+```console
+~/
+    mygithubusername/
+        ose/
+    vttred/
+        ose/
+    fvtt/
+        v9/
+        v9-userdata/Data/
+            systems/
+                ose/
+                ose-dev/
+                ose-test/
+    v10/
+         v10-userdata/Data/
+            systems/
+                ose/
+                ose-dev/
+                ose-test/
+```
+
+This is achieved with a `foundryconfig.json` files in each local version of the github repo on the maintainer's computer. Because of an npm script, each repo can make two symlinks, one for Foundry V9 and one for Foundry V10.
+
+`~/mygithubusername/ose/foundryconfig.json`
+
+```json
+{
+  "dataPath": ["~/fvtt/v9-userdata", "~/fvtt/v10-userdata"],
+  "symlinkName": "ose-dev"
+}
+```
+
+`~/vttred/ose/foundryconfig.json`
+
+```json
+{
+  "dataPath": ["~/fvtt/v9-userdata", "~/fvtt/v10-userdata"],
+  "symlinkName": "ose-test"
+}
+```
+
+If you want to have two local versions of your repository, there will be an additional build step. Run `git config --local include.path ../.gitconfig` in each of your repositories' root directories. Then make sure they have different symlinkNames in the `foundryconfig.json` files for each repo. Run `npm run link` in each repository.
+
+Note: you will have to provide your own .gitconfig for Windows