V2.0.0 (#6)

* v1.0.6

* Safety first

* v2.0.0 rewrite

Author: sneat

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## v2.0.0
+
+- Major rewrite of how the module is accessed.
+  - Scene Packer now supports more than one ScenePacker enabled module in a world. Previously they would conflict with each other and cause issues.
+- DEPRECATED: Calls to `window['scene-packer']` have been deprecated in favour of a global `ScenePacker` object.
+  - View the Readme for the new way to initialise Scene Packer.
+    - `ScenePacker.Initialise({...});`
+    - `ScenePacker.RelinkJournalEntries('module-name', {dryRun: true});`
+    - `ScenePacker.PromptRelinkJournalEntries();`
+    - `ScenePacker.HasPackedData(scene, moduleName);`
+    - `ScenePacker['module-name'];`
+    - etc.
+- Made the `Enable Scene Packer context menu` setting appear under `Library: Scene Packer` rather than the module utilising Scene Packer.
+- Packing a Scene will now store the initial view position of the Scene. Unpacking a Scene will use this value rather than defaulting to 0, 0 and a zoom of 1.
+- The Welcome Journal will now only show once per module version, rather than once per imported Scene. Upgrading the version of your module will redisplay the Welcome Journal (allowing you to show Changelogs etc.).
+- Added [libWrapper](https://foundryvtt.com/packages/lib-wrapper/) to set the `sourceId` value of entities imported from compendiums in versions of FoundryVTT prior to 0.8.0 (which does it by default).
+  - This allows appropriate tracking and linking of entities imported.
+- Unpacking a Scene will show its associated Journal entry to an authorised person. Generally this is just the GM unless your Journal has different permissions.
+  - Journal sheets will not automatically appear if you use the "Import All" option on the dialog you receive when first enabling a "packed" module.
+- Packing and Unpacking a Scene will prioritise matching based on `sourceId`'s for exact matches, rather than by name (it will still fall back to name based matching).
+- Before unpacking a Scene, a check will be made to ensure the Scene was packed with a compatible version of Scene Packer.
+- Added a performance report dialog option. Trigger it with `ScenePacker.ShowPerformanceReport();` or via the Macro in the compendium.
+  - This can be useful when building your Scenes to get an idea of how "heavy" they are.
+- Removed warning about remembering to Unpack after Packing. It's no longer needed. Unpacking a Scene over the top of itself won't cause any problems.
+
 ## v1.0.5
 
 - Added "How to use" style journals to the Scene Packer compendium.

README.md

@@ -6,14 +6,21 @@ A library to help other developers package up Scenes and Adventures to solve the
 
 - Scene Journal Pins link to the correct Journal
 - Actor tokens on a Scene link to the correct Actor
+- Imported Journals link to their correct Journal entry
 - Relink journal entries to compendium entities (to automatically fix the broken links after exporting from your World to your Compendium)
 
+In summary, it makes importing a Scene from a Compendium (via an "adventure module") work as though you build it in your world.
+
+Scene Packer is system agnostic, it doesn't matter whether you're packaging up a D&D5e module, or a Pathfinder one, or an Alien RPG one, Scene Packer doesn't mind.
+
 ## Installation
 
 In the setup screen, use the URL <https://raw.githubusercontent.com/League-of-Foundry-Developers/scene-packer/master/module.json> to install the module.
 
 ## Usage
 
+There are several `Journal entries` bundled with Scene Packer. In them, you can find references on how to use Scene Packer both as a Developer and as a GM.
+
 To use the Scene Packer as part of your module you will need to add it as a dependency in your `module.json` file.
 
 ```json
@@ -58,17 +65,20 @@ const creaturePacks = [`${moduleName}.actors`, 'dnd5e.monsters'];
  * Set to the following to disable:
  *   const journalPacks = [];
  */
-const journalPacks = [`${moduleName}.journals`];/**
+const journalPacks = [`${moduleName}.journals`];
+/**
  * macroPacks is a list of compendium packs to look in for Macros by name (in prioritised order).
  * The first entry here assumes that you have a Macro pack in your module with the "name" of "macros".
  * Set to the following to disable:
  *   const macroPacks = [];
  */
 const macroPacks = [`${moduleName}.macros`];
 
-Hooks.once('scenePackerReady', ({ getInstance }) => {
+Hooks.once('scenePackerReady', ScenePacker => {
   // Initialise the Scene Packer with your adventure name and module name
-  let packer = getInstance(adventureName, moduleName, {
+  let packer = ScenePacker.Initialise({
+    adventureName,
+    moduleName,
     creaturePacks,
     journalPacks,
     macroPacks,
@@ -90,9 +100,6 @@ To pack your scene ready for distribution:
 5. Re-export your Journals to compendiums, be sure to select the "Merge By Name" option to prevent the IDs from changing (and therefore re-breaking the links)
 6. Right click on your Scene in the Scenes Directory and choose `Pack Scene Data`.
 7. Export your Scene to your compendium.
-8. Right click on your Scene in the Scenes Directory and choose `Clear Packed Scene Data`.
-
-  - You want to choose this otherwise next time you open your Scene locally it will run the Scene import scripts.
 
 ![scene-context-menu](scene-context-menu.png)
 
@@ -101,7 +108,7 @@ To pack your scene ready for distribution:
 When you build an adventure module, it's a painful process updating all of your Journal references to link to the compendium versions. You can simplify this by running the following command in your browser console putting in your appropriate module name (as per your manifest json name):
 
 ```js
-await window['scene-packer'].relinkJournalEntries('module-name', {dryRun: false});
+await ScenePacker.RelinkJournalEntries('module-name', {dryRun: false});
 ```
 
 Alternatively, you can run the macro `Relink compendium journal entries` that is included in the Scene Packer compendium, which will prompt you for your module name and whether you want to run in "dry run" mode (not saving changes).
@@ -110,10 +117,21 @@ This will automatically go through the Journal compendiums that belong to your m
 
 ## TODO
 
-- Provide example complete module
+- Provide complete example module
+- Support v0.8.x (Scene Packer does not currently work with v0.8.0 and above)
 
 ## Acknowledgements
 
 A portion of the code is based on code created by [honeybadger](https://github.com/trioderegion) and used with permission.
 
 Thanks to [Baileywiki](https://www.patreon.com/baileywiki) for their initial testing and feedback.
+
+## Support
+
+Please submit any issues via the [Bug Reporter](https://foundryvtt.com/packages/bug-reporter) module or via [GitHub Issues](https://github.com/League-of-Foundry-Developers/scene-packer/issues).
+
+You can contact me on Discord `blair#9056` if you have questions, comments, queries, concerns etc.
+
+If you are making money and utilising this module, please consider sending a few dollars my way and/or providing me with the cool adventures and modules you're building :)
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A0488MI)

languages/en.json

@@ -22,18 +22,18 @@
       "dont-ask": "Don't ask me again"
     },
     "notifications": {
-      "first-launch": "First launch of this adventure! Unpacking scene...",
+      "first-launch": "First launch of this Scene! Unpacking scene...",
       "done": "All done!",
       "pack-scene": {
-        "clear-reminder": "Don't forget to \"Clear Packed Scene Data\" after exporting to prevent future duplicates.",
         "writing-journals": "Writing {number} journals to scene: {name}",
         "no-journal-pins": "No journal pins detected on the scene.",
         "no-token-name-warning": "Cannot pack a token that has no name. Check debug logs for details.",
         "no-token-name-log": "Trying to pack a token that has no name is not going to end well. Please ensure the Token and Actor have a name.",
         "no-journal-link-warning": "Cannot pack a journal pin that does not link to a valid journal entry. Journal pin is called: \"{pin}\". Check debug logs for details.",
         "no-journal-link-log": "Trying to pack a journal pin that does not link to a journal entry is not going to end well. Please ensure the pin \"{pin}\" is linked correctly.",
         "writing-tokens": "Writing {number} tokens to scene: {name}",
-        "no-tokens": "No tokens detected on the scene."
+        "no-tokens": "No tokens detected on the scene.",
+        "already-shown-welcome": "The welcome journal \"{journal}\" has already been shown for this version \"{version\"."
       },
       "import-by-name": {
         "creating-data": "Importing {count} new {type}.",
@@ -47,6 +47,18 @@
           "missing-pack-details": "ImportByName was called to search for pack \"{packName}\" which is not found. Check for typos in your module setup."
         }
       },
+      "find-journal-compendium": {
+        "no-match": "Could not find a Journal entry named \"{journal}\" in the compendiums.",
+        "invalid-index": "Error loading journal content from compendium. Check debug logs for details.",
+        "missing-pack": "Invalid pack configuration. Cannot find compendium {packName}. Check console for more details.",
+        "missing-pack-details": "FindJournalInCompendiums was called to search for pack \"{packName}\" which is not found. Check for typos in your module setup."
+      },
+      "find-actor-compendium": {
+        "no-match": "Could not find an Actor entry named \"{actor}\" in the compendiums.",
+        "invalid-index": "Error loading actor content from compendium. Check debug logs for details.",
+        "missing-pack": "Invalid pack configuration. Cannot find compendium {packName}. Check console for more details.",
+        "missing-pack-details": "FindActorInCompendiums was called to search for pack \"{packName}\" which is not found. Check for typos in your module setup."
+      },
       "find-actor": {
         "missing-name": "Cannot find a token that has no name. Check debug logs for details.",
         "missing-name-details": "Trying to find a token that has no name is not going to end well. Please ensure the Token and Actor have a name prior to packing."
@@ -61,9 +73,6 @@
         "missing-details": "Could not find {count} notes to spawn. The following journals were not found.",
         "spawning": "Spawning {count} journal notes."
       },
-      "unpack": {
-        "no-items": "No items to configure. All done!"
-      },
       "clear-data": {
         "done": "Finished clearing Packed Data."
       },
@@ -92,6 +101,13 @@
         "ui": "Invalid call to SetModuleName(). See console for details.",
         "details": "Invalid module name passed to \"SetModuleName()\". This must be the name of the module as defined in module.json under the \"name\" field."
       },
+      "instance": {
+        "ui": "Invalid call to ScenePacker. See console for details.",
+        "details": "Invalid module name or method passed to \"ScenePacker\". The module name must be as defined in module.json under the \"name\" field. Ensure that the names are correct and that your module has initialised ScenePacker correctly - see Journal entries in the compendium for assistance."
+      },
+      "version": {
+        "packed-low": "The scene \"{scene}\" (from module \"{sourceModule}\") was packed with Scene Packer version \"{version}\" which is older than the minimum compatible version of \"{supportedVersion}\". Please contact the author and ask them to re-Pack the Scene with a current version."
+      },
       "welcomeJournal": {
         "ui": "Invalid call to SetWelcomeJournal(). See console for details.",
         "details": "Invalid journal name passed to \"SetWelcomeJournal()\". This must be the name of a journal in the module compendium.",
@@ -139,13 +155,29 @@
         "completed": "Completed!"
       }
     },
+    "instance-prompt": {
+      "title": "Select instance",
+      "intro": "Select the module that you want to Pack against:",
+      "none-found": "There are no modules installed that have registered with Scene Packer. See the Journal entries in the compendium for how to register your module with Scene Packer.",
+      "select": "Select",
+      "cancel": "Cancel"
+    },
     "relink-prompt": {
       "title": "Relink Journal Entries",
       "intro": "Select the module you are using Scene Packer with:",
       "make-changes": "Save changes?",
       "make-changes-info": "Leaving this unchecked will operate in a \"dry run\" mode, where changes are only output to the console.",
       "relink": "Relink",
-      "cancel": "Cancel"
+      "cancel": "Cancel",
+      "none": "There are no modules initialised with Scene Packer in this world."
+    },
+    "performance-report": {
+      "title": "Performance Report",
+      "copy": "Copy to clipboard",
+      "close": "Close"
+    },
+    "deprecated": {
+      "method": "The method \"{method}\" has been deprecated and will be removed in a future version. Please see the Journal entries in the Scene Packer compendium on how to correctly call Scene Packer."
     }
   }
 }

module.json

@@ -2,7 +2,7 @@
   "name": "scene-packer",
   "title": "Library: Scene Packer",
   "description": "A module to assist with Scene and Adventure packing and unpacking.",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "library": "true",
   "manifestPlusVersion": "1.0.0",
   "minimumCoreVersion": "0.7.9",
@@ -15,7 +15,8 @@
     },
     {
       "name": "Blair McMillan",
-      "discord": "blair#9056"
+      "discord": "blair#9056",
+      "ko-fi": "blairm"
     }
   ],
   "packs": [
@@ -33,7 +34,8 @@
     }
   ],
   "esmodules": [
-    "/scripts/scene-packer.js"
+    "/scripts/scene-packer.js",
+    "/scripts/wrapped.js"
   ],
   "languages": [
     {