v2.0.4 Allow opt-out of copying settings

* Allow module developers to opt out of settings being copied. * Re-added bug reporter compatibility since 0.8.2.
League-of-Foundry-Developers · Jun 10, 2021 · 0fe2aed · 0fe2aed · IamWarHead · Jun 10, 2021
2 parents 3e8d28d + 4b90de6
commit 0fe2aed
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,21 @@ Go to Settings tab in Sidebar and **right click** on data **below** "General Inf
 
 *Please note that importing 'world' scope settings en masse as GM might cause some issues to connected players. I advise players should logout before attempting to import World Settings*
 
+## Info for Module Developers
+
+### How do I opt out?
+
+Perhaps you have a module that you don't want the settings being copied between worlds. You can add the following to your module manifest file to opt out of having the settings copied. The `active` state of your module will still be copied, just the settings won't.
+
+1. Add `noCopyEnvironmentSettings: true` to your manifest json inside of the `flags` field of the manifest.
+
+module.json
+```md
+  "flags": {
+    "noCopyEnvironmentSettings": true
+  }
+```
+
 ## Contact
 
 [League of Foundry Developers](https://discord.gg/gzemMfHURH) ~~If you wish to contact me for any reason, reach me out on Discord using my tag: `Forien#2130`~~

diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,10 @@
 # Changelog
 
+### v2.0.4
+
+* Allow module developers to opt out of settings being copied.
+* Re-added bug reporter compatibility since 0.8.2.
+
 ### v2.0.3
 
 * Added 0.8.4 compatibility

diff --git a/module.json b/module.json
@@ -2,11 +2,11 @@
   "name": "forien-copy-environment",
   "title": "Forien's Copy Environment",
   "description": "Allows for copying TXT/JSON list of system/modules and versions, and gives ability to export/import game and player settings",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "library": "false",
   "manifestPlusVersion": "1.0.0",
   "minimumCoreVersion": "0.6.0",
-  "compatibleCoreVersion": "0.8.4",
+  "compatibleCoreVersion": "0.8.6",
   "author": "Forien — Forien#2130",
   "authors": [
     {
@@ -41,5 +41,8 @@
   "download": "https://github.com/League-of-Foundry-Developers/foundryvtt-forien-copy-environment/releases/latest/download/module.zip",
   "bugs": "https://github.com/League-of-Foundry-Developers/foundryvtt-forien-copy-environment/issues",
   "changelog": "https://github.com/League-of-Foundry-Developers/foundryvtt-forien-copy-environment/blob/master/changelog.md",
+  "flags": {
+    "allowBugReporter": true
+  },
   "allowBugReporter": true
-}
+}
diff --git a/scripts/core.js b/scripts/core.js
@@ -284,9 +284,11 @@ export default class Core extends FormApplication {
   }
 
   static exportGameSettings() {
+    const excludeModules = game.data.modules.filter(m => m.data?.flags?.noCopyEnvironmentSettings).map(m => m.id) || [];
+
     // Return an array with both the world settings and player settings together.
     let data = Array.prototype.concat(
-      game.data.settings.map((s) => ({
+      game.data.settings.filter(s => !excludeModules.some(e => s.key.startsWith(`${e}.`))).map((s) => ({
         key: s.key,
         value: s.value,
       })),