[#6922] Add welcome dialog with links, settings, & module list

Adds a new window that pops up when the system is first launched to
provide some first run improvements to users. This window displays
a welcome message & several links to documentation & support pages.

Beneath that are some important settings that are useful to get set
immediately including rules version, calendar, bastion, and whether
the metric system is used. Any changes to these settings are saved
when the window is closed and a reload will be prompted if needed.

The second tab contains a list of all of the first-party modules
offered for the system. These modules can be easily enabled from
this screen and any selected modules will be enabled when the app
is closed.

The list of modules is contained in a JSON file included with the
system, but it will also check the copy of that file on the
`publish-wiki` branch of the GitHub. This should allow the system
to add new modules to this listing without requiring a new system
version.

 ### Todo
- [ ] Write welcome dialog & links
- [ ] Modify compendium browser filters to match selected rules
      and enabled modules
- [ ] Integrate with adventure quickstart dialog #6946

Closes #6922

Author: arbron

dnd5e.mjs

@@ -536,7 +536,7 @@ Hooks.once("i18nInit", () => {
 /**
  * Once the entire VTT framework is initialized, check to see if we should perform a data migration
  */
-Hooks.once("ready", function() {
+Hooks.once("ready", async function() {
   // Wait to register hotbar drop hook on ready so that modules could register earlier if they want to
   Hooks.on("hotbarDrop", (bar, data, slot) => {
     if ( ["ActiveEffect", "Activity", "Item"].includes(data.type) ) {
@@ -564,8 +564,24 @@ Hooks.once("ready", function() {
     dnd5e.ui.calendar.render({ force: true });
   }
 
-  // Determine whether a system migration is required and feasible
+  // Run migrations
+  await _handleMigration();
+
+  // Present welcome dialog to GMs
+  if ( game.user.isGM && game.settings.get("dnd5e", "firstRun") ) {
+    const welcome = new applications.WelcomeScreen();
+    welcome.render({ force: true });
+  }
+});
+
+/* -------------------------------------------- */
+
+/**
+ * Determine whether a system migration is required and feasible and run it.
+ */
+async function _handleMigration() {
   if ( !game.user.isGM ) return;
+
   const cv = game.settings.get("dnd5e", "systemMigrationVersion") || game.world.flags.dnd5e?.version;
   const totalDocuments = game.actors.size + game.scenes.size + game.items.size;
   if ( !cv && totalDocuments === 0 ) return game.settings.set("dnd5e", "systemMigrationVersion", game.system.version);
@@ -580,8 +596,8 @@ Hooks.once("ready", function() {
   if ( cv && foundry.utils.isNewerVersion(game.system.flags.compatibleMigrationVersion, cv) ) {
     ui.notifications.error("MIGRATION.5eVersionTooOldWarning", { permanent: true });
   }
-  migrations.migrateWorld();
-});
+  await migrations.migrateWorld();
+}
 
 /* -------------------------------------------- */
 /*  System Styling                              */

json/official-content.json

@@ -0,0 +1,48 @@
+{
+  "core": {
+    "dnd-players-handbook": {
+      "name": "Player's Handbook",
+      "description": "<p>Embark on an epic adventure 10 years in the making. This new and improved Player's Handbook® is the ultimate guide for fifth edition D&D players. Play your way with optimized rules for character creation and advancement, exploration, combat, equipment, spells, and much more. Create fantastic heroes from an expanded selection of character origins, classes, and subclasses, revised and balanced for maximum fun.</p>"
+    },
+    "dnd-dungeon-masters-guide": {
+      "name": "Dungeon Master's Guide",
+      "description": "<p>Create thrilling adventures with this revised and expanded Dungeon Master's Guide. Inside this essential guide is everything new and experienced Dungeon Masters need to weave epic tales, build fantastical worlds, and inspire memorable moments for your party.</p>"
+    },
+    "dnd-monster-manual": {
+      "name": "Monster Manual",
+      "description": "<p>Populate your worlds and adventures with the hundreds of monsters provided, and let their stories, illustrations, and easy-to-use stat blocks fuel your D&D® adventures for years to come. Encounter a monstrous menagerie of familiar favorites like dragons, giants, and mind flayers, plus a host of new monsters like the arch-hag, the blob of annihilation, and the vampire nightbringer.</p>"
+    }
+  },
+  "expanded": {
+    "dnd-tashas-cauldron": {
+      "name": "Tasha's Cauldron of Everything",
+      "description": "<p>Natasha the Dark, Iggwilv the Witch Queen, daughter of Baba Yaga or simply the witch named Tasha, well-known for her spells such as Tasha’s hideous laughter, has compiled all the precious lore she has gathered during her illustrious career as an adventurer for the enrichment of all. Her book offers a taste of the great power that awaits D&D players and dungeon masters everywhere! It contains new player subclasses, sidekicks, and rules and tools for Dungeon Masters.</p>"
+    },
+    "dnd-heroes-faerun": {
+      "name": "Forgotten Realms: Heroes of Faerûn",
+      "description": "<p>Become a hero worthy of the Forgotten Realms and carve out a path of your own in this compendium of player options.</p>"
+    },
+    "dnd-forge-artificer": {
+      "name": "Eberron: Forge of the Artificer",
+      "description": "<p>TODO</p>"
+    }
+  },
+  "adventures": {
+    "dnd-tomb-annihilation": {
+      "name": "Tomb of Annihilation",
+      "description": "<p>Challenge your players to work together to navigate Chult, solve puzzles, and survive the myriad deadly encounters in the Tomb of the Nine Gods as they investigate the mysterious Death Curse that has overtaken the world.</p>"
+    },
+    "dnd-phandelver-below": {
+      "name": "Phandelver & Below: The Shattered Obelisk",
+      "description": "<p>Journey to the beloved town of Phandalin, where a malevolent cult threatens to overtake the region. Together with your party, solve mysteries and stamp out growing corruption as you uncover more about the peculiar happenings plaguing the town. Discover what lurks below in this high-fantasy adventure that begins with the familiar story of Lost Mine of Phandelver and then delves into the perilous Underdark.</p>"
+    },
+    "dnd-heroes-borderlands": {
+      "name": "Heroes of the Borderlands",
+      "description": "<p>Gather your party and prepare for an unforgettable journey! Heroes of the Borderlands is your magical portal into the world of Dungeons &amp; Dragons. Perfect for seasoned adventurers and newcomers alike, this is D&amp;D's largest starter set ever and combines the magic of tabletop storytelling with the fun of playing with your friends online using the power of Foundry Virtual Tabletop!</p>"
+    },
+    "dnd-adventures-faerun": {
+      "name": "Forgotten Realms: Adventures in Faerûn",
+      "description": "<p>The most expansive take on the Forgotten Realms in Dungeons & Dragons history, Forgotten Realms: Adventures in Faerûn has everything Dungeon Masters need to tackle this timeless fantasy setting, complete with new stories, lore, locations, and encounters - all in one place. Go where your imagination leads in this enormous Forgotten Realms expansion. There is no power too vast, no mountaintop too high, and no possibility too great to leave unexplored.</p>"
+    }
+  }
+}

lang/en.json

@@ -5628,6 +5628,32 @@
 "DND5E.WeaponSimpleProficiency": "Simple",
 "DND5E.WeaponSimpleR": "Simple Ranged",
 "DND5E.Weight": "Weight",
+
+"DND5E.WELCOME": {
+  "Button": "Welcome Screen",
+  "Module": {
+    "Enabled": "Enabled",
+    "NotInstalled": "Not Installed"
+  },
+  "Section": {
+    "adventures": "Adventures",
+    "core": "Core Rulebooks",
+    "expanded": "Expanded Rulebooks"
+  },
+  "Settings": {
+    "Label": "Settings",
+    "Metric": {
+      "Hint": "Swap to metric units as default for distances, weights, and volume.",
+      "Label": "Use Metric System"
+    }
+  },
+  "Tab": {
+    "main": "Welcome",
+    "modules": "Official Content"
+  },
+  "Title": "Welcome to D&D 5e"
+},
+
 "DND5E.WhisperedTo": "Whispered to",
 "DND5E.Wiki": "Wiki",
 "DND5E.available": "available",

less/dnd5e.less

@@ -35,6 +35,7 @@
 @import "v2/journal.less";
 @import "v2/region-behaviors.less";
 @import "v2/blocks.less";
+@import "v2/welcome.less";
 
 /* High Contrast */
 @import "v2/high-contrast/apps.less";

less/v2/welcome.less

@@ -0,0 +1,52 @@
+.welcome.application {
+  [data-application-part="main"] {
+    .hero {
+      box-shadow: 0 3px 6px var(--dnd5e-shadow-45);
+    }
+    .message {
+      font-size: var(--font-size-14);
+    }
+  }
+
+  [data-application-part="modules"] {
+    h3 {
+      margin-block-start: 12px;
+      margin-block-end: 6px;
+      border: none;
+      font-family: var(--dnd5e-font-roboto-slab);
+    }
+    h4 {
+      margin: 0;
+      font-family: var(--dnd5e-font-roboto-condensed);
+      font-size: var(--font-size-20);
+      font-variant: small-caps;
+      line-height: 1;
+    }
+    .key-art {
+      align-content: center;
+      align-self: start;
+      box-shadow: 0 3px 6px var(--dnd5e-shadow-15);
+      max-inline-size: 240px;
+      text-align: center;
+    }
+    .status {
+      display: flex;
+      align-items: center;
+      justify-content: flex-end;
+      font-weight: bold;
+    }
+    .module-list {
+      gap: 10px;
+
+      .module-entry {
+        align-items: stretch;
+        gap: 8px;
+      }
+      .module-content {
+        display: grid;
+        grid-template-rows: min-content auto min-content;
+      }
+      .status { gap: 8px; }
+    }
+  }
+}

module/applications/_module.mjs

@@ -24,6 +24,7 @@ export {default as PropertyAttribution} from "./property-attribution.mjs";
 export {default as RollTableSheet5e} from "./roll-table-sheet.mjs";
 export {default as Tabs5e} from "./tabs.mjs";
 export {PrototypeTokenConfig5e, TokenConfig5e} from "./token-config.mjs";
+export {default as WelcomeScreen} from "./welcome-screen.mjs";
 
 // Deprecated
 export {default as SheetConfig} from "./sheet-config.mjs";

module/applications/_types.mjs

@@ -89,3 +89,11 @@
  * @property {number} value               Value of this step.
  * @property {ActiveEffect5e} [document]  Active effect applying this attribution, if any.
  */
+
+ /* -------------------------------------------- */
+
+ /**
+  * @typedef OfficialModuleListing
+  * @property {string} name         Display name in the interface.
+  * @property {string} description  Brief description in HTML.
+  */

module/applications/components/checkbox.mjs

@@ -237,7 +237,8 @@ export default class CheckboxElement extends AdoptedStyleSheetMixin(
   /** @override */
   _onClick(event) {
     event.preventDefault();
-    this.checked = !this.checked;
+    if ( this.indeterminate ) this.indeterminate = false;
+    else this.checked = !this.checked;
     this.dispatchEvent(new Event("input", { bubbles: true, cancelable: true }));
     this.dispatchEvent(new Event("change", { bubbles: true, cancelable: true }));
   }

module/applications/settings/base-settings.mjs

@@ -52,6 +52,17 @@ export default class BaseSettingsConfig extends Application5e {
    * @returns {object}
    */
   createSettingField(name) {
+    return BaseSettingsConfig.createSettingField(name);
+  }
+
+  /* -------------------------------------------- */
+
+  /**
+   * Create the field data for a specific setting.
+   * @param {string} name  Setting key within the dnd5e namespace.
+   * @returns {object}
+   */
+  static createSettingField(name) {
     const setting = game.settings.settings.get(`dnd5e.${name}`);
     if ( !setting ) throw new Error(`Setting \`dnd5e.${name}\` not registered.`);
     const isDataField = setting.type instanceof DataField;
@@ -86,9 +97,24 @@ export default class BaseSettingsConfig extends Application5e {
    * @returns {Promise<void>}            Resolves once the settings are updated, or prompts for a reload if required.
    */
   static async #onCommitChanges(event, form, formData) {
+    const changes = foundry.utils.expandObject(formData.object);
+    const { requiresClientReload, requiresWorldReload } = await BaseSettingsConfig.commitChanges(changes);
+    if ( requiresClientReload || requiresWorldReload ) {
+      return foundry.applications.settings.SettingsConfig.reloadConfirm({ world: requiresWorldReload });
+    }
+  }
+
+  /* -------------------------------------------- */
+
+  /**
+   * Commit changes to various `dnd5e` settings and determine if a reload is required.
+   * @param {object} changes  Changes to apply to settings within the dnd5e namespace.
+   * @returns {{ requiresClientReload: boolean, requiresWorldReload: boolean }}
+   */
+  static async commitChanges(changes) {
     let requiresClientReload = false;
     let requiresWorldReload = false;
-    for ( const [key, value] of Object.entries(foundry.utils.expandObject(formData.object)) ) {
+    for ( const [key, value] of Object.entries(changes) ) {
       const setting = game.settings.settings.get(`dnd5e.${key}`);
       const current = game.settings.get("dnd5e", key, { document: true });
       const prior = current?._source?.value ?? current;
@@ -97,8 +123,6 @@ export default class BaseSettingsConfig extends Application5e {
       requiresClientReload ||= (setting.scope !== "world") && setting.requiresReload;
       requiresWorldReload ||= (setting.scope === "world") && setting.requiresReload;
     }
-    if ( requiresClientReload || requiresWorldReload ) {
-      return foundry.applications.settings.SettingsConfig.reloadConfirm({ world: requiresWorldReload });
-    }
+    return { requiresClientReload, requiresWorldReload };
   }
 }

module/applications/settings/sidebar.mjs

@@ -1,3 +1,5 @@
+import WelcomeScreen from "../welcome-screen.mjs";
+
 /**
  * Generate sidebar links.
  * @returns {HTMLUListElement}
@@ -49,4 +51,10 @@ export function renderSettings(html) {
   section.append(_generateLinks());
   if ( pip ) section.querySelector(".system-info").insertAdjacentElement("beforeend", pip);
   html.querySelector(".info").insertAdjacentElement("afterend", section);
+
+  const welcomeLink = document.createElement("button");
+  welcomeLink.type = "button";
+  welcomeLink.innerHTML = `<i class="fa-solid fa-handshake"></i> ${game.i18n.localize("DND5E.WELCOME.Button")}`;
+  welcomeLink.addEventListener("click", () => new WelcomeScreen().render({ force: true }));
+  section.after(welcomeLink);
 }