Changes TOTM to be agnostic with template support for any system (#27)

.eslintrc.json

@@ -12,9 +12,11 @@
       "eslint:recommended",
       "@typhonjs-fvtt/eslint-config-foundry.js/0.8.0",
       "plugin:jest/recommended",
-      "plugin:prettier/recommended"
+      "plugin:prettier/recommended",
+      "plugin:jsdoc/recommended",
+      "plugin:jsdoc/recommended-typescript-flavor"
     ],
-    "plugins": ["jest"],
+    "plugins": ["jest", "jsdoc"],
     "parserOptions": {
       "ecmaVersion": 2020,
       "extraFileExtensions": [".cjs", ".mjs"],
@@ -23,7 +25,8 @@
 
     // Defines / overrides a few more environment parameters not provided in the configs above.
     "env": {
-      "browser": true
+      "browser": true,
+      "es6": true
     },
 
     // Prevents overwriting any built in globals particularly from `@typhonjs-fvtt/eslint-config-foundry.js`, but also

.vscode/settings.json

@@ -1,4 +1,7 @@
 {
     "editor.formatOnSave": true,
-    "editor.defaultFormatter": "rvest.vs-code-prettier-eslint"
+    "editor.defaultFormatter": "rvest.vs-code-prettier-eslint",
+    "[json]": {
+        "editor.defaultFormatter": "vscode.json-language-features"
+    }
 }

CHANGELOG.md

@@ -1,41 +1,51 @@
+## 2.0.0 (2024-01-29)
+
+##### New Features
+
+*  Plugin is now system agnostic and allows any user to create templates for their favorite systems.
+    * Documentation in [SYSTEMS.md]('https://github.com/EddieDover/theater-of-the-mind/SYSTEMS.md')
+
+*  Added support for Forge hosting ([3beb550d](https://github.com/EddieDover/theater-of-the-mind/commit/3beb550d62030cd96a04aae7f06d399cd914fbb1))
+
+
 ## 1.4.7 (2023-10-17)
 
 ##### Bug Fixes
 
-*  now displays variant stats properly ([6e1c94b5]('https://github.com/EddieDover/theater-of-the-mind'/commit/6e1c94b549a1019d43b195759536f686f822e11c))
+*  now displays variant stats properly ([6e1c94b5](https://github.com/EddieDover/theater-of-the-mind/commit/6e1c94b549a1019d43b195759536f686f822e11c))
 
 ## 1.4.6 (2023-10-17)
 
 ##### Bug Fixes
 
-*  prevent party sheet closing when opening character sheet ([1f0df29c]('https://github.com/EddieDover/theater-of-the-mind'/commit/1f0df29ce5de6471333b3c50fc21a72a8aae82eb))
+*  prevent party sheet closing when opening character sheet ([1f0df29c](https://github.com/EddieDover/theater-of-the-mind/commit/1f0df29ce5de6471333b3c50fc21a72a8aae82eb))
 
 ## 1.4.5 (2023-10-17)
 
 ##### Chores
 
-* rewrote template system ([60dbaad3]('https://github.com/EddieDover/theater-of-the-mind'/commit/60dbaad30482cfc1c1006bb28d360d15d796a29f))
-* rewrote actor show/hide functionality ([60dbaad3]('https://github.com/EddieDover/theater-of-the-mind'/commit/60dbaad30482cfc1c1006bb28d360d15d796a29f))
-* restyled dialogs ([60dbaad3]('https://github.com/EddieDover/theater-of-the-mind'/commit/60dbaad30482cfc1c1006bb28d360d15d796a29f))
+* rewrote template system ([60dbaad3](https://github.com/EddieDover/theater-of-the-mind/commit/60dbaad30482cfc1c1006bb28d360d15d796a29f))
+* rewrote actor show/hide functionality ([60dbaad3](https://github.com/EddieDover/theater-of-the-mind/commit/60dbaad30482cfc1c1006bb28d360d15d796a29f))
+* restyled dialogs ([60dbaad3](https://github.com/EddieDover/theater-of-the-mind/commit/60dbaad30482cfc1c1006bb28d360d15d796a29f))
 
 
 ##### New Features
 
-*  added ability to click on characters and open sheet ([60dbaad3]('https://github.com/EddieDover/theater-of-the-mind'/commit/60dbaad30482cfc1c1006bb28d360d15d796a29f))
+*  added ability to click on characters and open sheet ([60dbaad3](https://github.com/EddieDover/theater-of-the-mind/commit/60dbaad30482cfc1c1006bb28d360d15d796a29f))
 
 ## 1.4.0 (2023-10-17)
 
 ##### New Features
 
-*  added ability to show either online characters or a curated list of any non-npc ([5e209a14]('https://github.com/EddieDover/theater-of-the-mind'/commit/5e209a140e2919710f7e1119dbfc3a0d7f82631e))
+*  added ability to show either online characters or a curated list of any non-npc ([5e209a14](https://github.com/EddieDover/theater-of-the-mind/commit/5e209a140e2919710f7e1119dbfc3a0d7f82631e))
 
 ## 1.3.0 (2023-10-15)
 
 ##### New Features
 
-*  changed **sounds** dependency from attack-roll-check-5e with midi-qol ([3ef24300]('https://github.com/EddieDover/theater-of-the-mind'/commit/3ef24300229b2365823791936000c11b28dd4561))
-*  Added Dark Mode option toggle. ([91175ad4]('https://github.com/EddieDover/theater-of-the-mind'/commit/91175ad4a088c01ab937ded8be1cf61a5427e00a))
-*  added better changelog system ([2b104a68]('https://github.com/EddieDover/theater-of-the-mind'/commit/2b104a68e4d2687fe3a4b0b25d7edb5166226ca9))
+*  changed **sounds** dependency from attack-roll-check-5e with midi-qol ([3ef24300](https://github.com/EddieDover/theater-of-the-mind/commit/3ef24300229b2365823791936000c11b28dd4561))
+*  Added Dark Mode option toggle. ([91175ad4](https://github.com/EddieDover/theater-of-the-mind/commit/91175ad4a088c01ab937ded8be1cf61a5427e00a))
+*  added better changelog system ([2b104a68](https://github.com/EddieDover/theater-of-the-mind/commit/2b104a68e4d2687fe3a4b0b25d7edb5166226ca9))
 
 ## 1.2.1 (2023-10-07)
 

README.md

@@ -4,15 +4,24 @@
 [![Foundry Hub Endorsements](https://img.shields.io/endpoint?logoColor=white&url=https%3A%2F%2Fwww.foundryvtt-hub.com%2Fwp-json%2Fhubapi%2Fv1%2Fpackage%2Ftheater-of-the-mind%2Fshield%2Fendorsements)](https://www.foundryvtt-hub.com/package/theater-of-the-mind/)
 [![Foundry Hub Comments](https://img.shields.io/endpoint?logoColor=white&url=https%3A%2F%2Fwww.foundryvtt-hub.com%2Fwp-json%2Fhubapi%2Fv1%2Fpackage%2Ftheater-of-the-mind%2Fshield%2Fcomments)](https://www.foundryvtt-hub.com/package/theater-of-the-mind/)
 
+This module provides a GM with a table of characters, online only, or all, configurable in settings, in order to quickly see important stats, traits, abilites, etc. of all characters. Originally 5e only, it is now system agnostic and you can create easy to make .json templates for your system. It supports native Foundry and The Forge. Complete instructions for creating templates and placing them in the right folder on Foundry and Forge are included in the [SYSTEMS.MD] file.
 
-The original intent of this module was to provide a 'party view' feature that I found missing when I first started using [FoundryVTT](https://www.foundryvtt.com) instead of [Fantasy Grounds](https://www.fantasygrounds.com). It will be updated with features that I personally want or need, or are requested of me by some poor soul.
+The original intent of this module was to provide a 'party view' feature that I found missing when I first started using [FoundryVTT](https://www.foundryvtt.com) instead of [Fantasy Grounds](https://www.fantasygrounds.com). It will be updated with features that I personally want or need, or are requested of me by some poor soul. Several templates for various systems have been created, and more are already in the works with even more planned.
+
+If you create a template, please submit it via email, Discord or GitHub as a Pull Request, and we will include it in future updates with full credit.
 
 ## Features
 - Adds a 'Party Sheet' similar to that provided by Fantasy Grounds. Just click the Party Sheet icon on the Tokens Controls sub-menu.
 
-  - The Party Sheet can be configured via the options to either display only currently connected players, or all non-npc characters. When using the all-characters display, there is a separate dialog to allow hiding of any characters the DM doesn't need to worry about.
+  - The Party Sheet can be configured via the options to either display only currently connected players, or all non-npc characters. When using the all-characters display, there is a separate dialog to allow hiding of any characters the DM doesn't need to worry about. See the [SYSTEMS.md](SYSTEMS.md) file for instructions on how to create a json file for your own system.
+
   - Clicking a character portrait will open their sheet.
 
+  - The Party Sheet is no longer bound to simply the built-in dnd5e system. Additional systems can be supported by writing a JSON file following the guidelines in [SYSTEMS.md](SYSTEMS.md) and placing it in either:
+
+    - Native Foundry: your <FOUNDRY_VTT/Data/totm/> folder.
+    - The Forge: the folder named [totm] at the top level of your assets library (created by the module).
+
 - Sound effects support if you have Syrinscape ([fvtt-syrin-control](https://github.com/frondeus/fvtt-syrin-control)) and Midi QOL ([midi-qol](https://gitlab.com/tposney/midi-qol/)) installed.
 
 # Support
@@ -35,3 +44,21 @@ Specific Characters
 
 ![Preview of Plugin Party Sheet - Specific Actors](images/preview2.png)
 
+# Supported Systems
+
+Built in (by Eddie Dover):
+  - DnD5e "dnd5e" - Note: this does not require any upload of a .json, but you can make your own or edit the example in the [example_templates] folder to your liking and it will show up in the dropdown of available .json files
+
+Templates by Michael Card (Emo Cthulhu):
+  - Alien RPG "alienrpg"
+  - Blade Runner RPG "blade-runner"
+  - Dragonbane "dragonbane"
+  - Starfinder "sfrpg"
+  - The Walking Dead Universe RPG "twdu"
+  - Vaesen "vaesen"
+
+  - In Progress: Coriolis "yzecoriolis", Fallout 2d20 "fallout", Cyberpunk RED "cyberpunk-red-core"
+
+  - Planned: Pathfinder 1e, Pathfinder 2e
+
+Please see the [SYSTEMS.md](SYSTEMS.md) file for how to use the provided templates and install them in the correct directory. Theater of the Mind supports Forge installations, and information in these documents will let you know what you have to do differently on native Foundry and The Forge.