Merge pull request #178 from arknano/title-cards

feat(titleCards): Configurable Book of Boba Fett-style title cards

README.md

@@ -14,6 +14,7 @@ This module is designed to supplement the
 ### Features
 
 -   Launch a customizable Opening Crawl based upon the [Kassel Labs Star Wars Intro Creator](https://github.com/KasselLabs/StarWarsIntroCreator)
+-   Launch customisable Book of Boba Fett-style title cards
 -   A shop generator
 -   Easily create Bounties and Datapada entries for showing players
 -   Provides support for automatic, configurable attack animations (with sounds!)

ffg-star-wars-enhancements.js

@@ -2,6 +2,7 @@ import { init as settings_init } from "./scripts/settings.js";
 import { FfgEnhancementsLayer, log_msg as log } from "./scripts/util.js";
 import { init as attack_animation_init, attack_animation_check, attack_animation } from "./scripts/animation.js";
 import { init as opening_crawl_init, ready as opening_crawl_ready } from "./scripts/opening_crawl.js";
+import { init as title_cards_init, ready as title_cards_ready } from "./scripts/title_cards.js";
 import { init as hyperspace_init, ready as hyperspace_ready } from "./scripts/hyperspace.js";
 import { init as rename_init, rename_combatant } from "./scripts/rename.js";
 import {
@@ -29,6 +30,7 @@ Hooks.once("init", async function () {
     strain_reminder_init();
     talent_checker_init();
     opening_crawl_init();
+    title_cards_init();
     shop_generator_init();
     hyperspace_init();
     quench_tests_init(); // Will have no effect unless Quench is active
@@ -99,6 +101,7 @@ Hooks.once("ready", () => {
     /* register functionality here */
     attack_animation_check();
     opening_crawl_ready();
+    title_cards_ready();
     shop_sheet_ready();
     dice_helper();
     talent_checker();

lang/en.json

@@ -195,5 +195,31 @@
     "ffg-star-wars-enhancements.minionsize-sync-status-zero": "Minion Status at zero",
     "ffg-star-wars-enhancements.minionsize-sync-status-zero-hint": "Will be applied when zero minion member",
     "ffg-star-wars-enhancements.controls.holo.name": "Convert to Hologram2",
-    "ffg-star-wars-enhancements.controls.holo.title": "Toggle Hologram conversion"
+    "ffg-star-wars-enhancements.controls.holo.title": "Toggle Hologram conversion",
+    "ffg-star-wars-enhancements.controls.title-cards.title": "Title Cards",
+    "ffg-star-wars-enhancements.controls.title-cards.toptext-label": "Top Text",
+    "ffg-star-wars-enhancements.controls.title-cards.bottomtext-label": "Bottom Text",
+    "ffg-star-wars-enhancements.controls.title-cards.launch": "Launch Title Cards",
+    "ffg-star-wars-enhancements.title-cards.ui.name": "Title Cards settings",
+    "ffg-star-wars-enhancements.title-cards.ui.hint": "Configure Title Cards",
+    "ffg-star-wars-enhancements.title-cards.ui.label": "Open Configuration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo": "Title Cards Logo",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-hint": "Logo to display first",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music": "Title Cards music",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-hint": "Music to play. Default settings are synced to the Book of Boba Fett intro",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-delay": "Music start delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-delay-hint": "Delay in seconds until the music starts playing",
+    "ffg-star-wars-enhancements.title-cards.title-cards-top-font-size": "Top Text Size",
+    "ffg-star-wars-enhancements.title-cards.title-cards-top-font-size-hint": "Size of the top text in px",
+    "ffg-star-wars-enhancements.title-cards.title-cards-bottom-font-size": "Bottom Text Size",
+    "ffg-star-wars-enhancements.title-cards.title-cards-bottom-font-size-hint": "Size of the bottom text in px",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-delay": "Logo delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-delay-hint": "Time in seconds until the logo appears",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-duration": "Logo duration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-duration-hint": "Time in seconds the logo remains on screen",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-delay": "Text delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-delay-hint": "Time in seconds until the text appears",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-duration": "Text duration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-close-delay": "Window close delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-close-delay-hint": "Time in seconds since the text disappeared to close the window. If 0, will not close the window"
 }

lang/fr.json

@@ -189,5 +189,31 @@
     "ffg-star-wars-enhancements.minionsize-sync-status-zero": "Icône de status de sbires à zéro",
     "ffg-star-wars-enhancements.minionsize-sync-status-zero-hint": "Sera appliqué pour un groupe de sbire sans membres",
     "ffg-star-wars-enhancements.controls.holo.name": "Conversion vers Hologram2",
-    "ffg-star-wars-enhancements.controls.holo.title": "Active/Désactive la conversion en holograme"
+    "ffg-star-wars-enhancements.controls.holo.title": "Active/Désactive la conversion en holograme",
+    "ffg-star-wars-enhancements.controls.title-cards.title": "Title Cards",
+    "ffg-star-wars-enhancements.controls.title-cards.toptext-label": "Top Text",
+    "ffg-star-wars-enhancements.controls.title-cards.bottomtext-label": "Bottom Text",
+    "ffg-star-wars-enhancements.controls.title-cards.launch": "Launch Title Cards",
+    "ffg-star-wars-enhancements.title-cards.ui.name": "Title Cards settings",
+    "ffg-star-wars-enhancements.title-cards.ui.hint": "Configure Title Cards",
+    "ffg-star-wars-enhancements.title-cards.ui.label": "Open Configuration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo": "Title Cards Logo",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-hint": "Logo to display first",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music": "Title Cards music",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-hint": "Music to play. Default settings are synced to the Book of Boba Fett intro",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-delay": "Music start delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-delay-hint": "Delay in seconds until the music starts playing",
+    "ffg-star-wars-enhancements.title-cards.title-cards-top-font-size": "Top Text Size",
+    "ffg-star-wars-enhancements.title-cards.title-cards-top-font-size-hint": "Size of the top text in px",
+    "ffg-star-wars-enhancements.title-cards.title-cards-bottom-font-size": "Bottom Text Size",
+    "ffg-star-wars-enhancements.title-cards.title-cards-bottom-font-size-hint": "Size of the bottom text in px",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-delay": "Logo delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-delay-hint": "Time in seconds until the logo appears",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-duration": "Logo duration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-duration-hint": "Time in seconds the logo remains on screen",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-delay": "Text delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-delay-hint": "Time in seconds until the text appears",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-duration": "Text duration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-close-delay": "Window close delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-close-delay-hint": "Time in seconds since the text disappeared to close the window. If 0, will not close the window"
 }

lang/pt-BR.json

@@ -189,5 +189,31 @@
     "ffg-star-wars-enhancements.minionsize-sync-status-zero": "Status dos minions no zero",
     "ffg-star-wars-enhancements.minionsize-sync-status-zero-hint": "Will be applied when zero minion member",
     "ffg-star-wars-enhancements.controls.holo.name": "Converter para o Holograma",
-    "ffg-star-wars-enhancements.controls.holo.title": "Alterne a conversão do holograma"
+    "ffg-star-wars-enhancements.controls.holo.title": "Alterne a conversão do holograma",
+    "ffg-star-wars-enhancements.controls.title-cards.title": "Title Cards",
+    "ffg-star-wars-enhancements.controls.title-cards.toptext-label": "Top Text",
+    "ffg-star-wars-enhancements.controls.title-cards.bottomtext-label": "Bottom Text",
+    "ffg-star-wars-enhancements.controls.title-cards.launch": "Launch Title Cards",
+    "ffg-star-wars-enhancements.title-cards.ui.name": "Title Cards settings",
+    "ffg-star-wars-enhancements.title-cards.ui.hint": "Configure Title Cards",
+    "ffg-star-wars-enhancements.title-cards.ui.label": "Open Configuration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo": "Title Cards Logo",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-hint": "Logo to display first",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music": "Title Cards music",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-hint": "Music to play. Default settings are synced to the Book of Boba Fett intro",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-delay": "Music start delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-music-delay-hint": "Delay in seconds until the music starts playing",
+    "ffg-star-wars-enhancements.title-cards.title-cards-top-font-size": "Top Text Size",
+    "ffg-star-wars-enhancements.title-cards.title-cards-top-font-size-hint": "Size of the top text in px",
+    "ffg-star-wars-enhancements.title-cards.title-cards-bottom-font-size": "Bottom Text Size",
+    "ffg-star-wars-enhancements.title-cards.title-cards-bottom-font-size-hint": "Size of the bottom text in px",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-delay": "Logo delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-delay-hint": "Time in seconds until the logo appears",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-duration": "Logo duration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-logo-duration-hint": "Time in seconds the logo remains on screen",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-delay": "Text delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-delay-hint": "Time in seconds until the text appears",
+    "ffg-star-wars-enhancements.title-cards.title-cards-text-duration": "Text duration",
+    "ffg-star-wars-enhancements.title-cards.title-cards-close-delay": "Window close delay",
+    "ffg-star-wars-enhancements.title-cards.title-cards-close-delay-hint": "Time in seconds since the text disappeared to close the window. If 0, will not close the window"
 }

release-notes.md

@@ -1,3 +1,5 @@
+-   NEW FEATURE: Configurable Book of Boba Fett-style title cards can be played like the opening crawl
+-   IMPROVEMENT: Opening crawl timing can be configured in the settings
 -   FIX: Module settings popup windows titles corrected
 
 `2.0.5` - 2023-12-29

scripts/controls_layer.js

@@ -1,4 +1,5 @@
 import { select_opening_crawl } from "./opening_crawl.js";
+import { title_cards_dialog } from "./title_cards.js";
 import { select_hyperspace } from "./hyperspace.js";
 import { create_datapad_journal } from "./datapads.js";
 import { shop_creator } from "./shop.js";
@@ -25,6 +26,15 @@ export const register_controls = (controls) => {
                     select_opening_crawl();
                 },
             },
+            {
+                name: game.i18n.localize("ffg-star-wars-enhancements.controls.title-cards.name"),
+                title: game.i18n.localize("ffg-star-wars-enhancements.controls.title-cards.title"),
+                icon: "fas fa-book",
+                button: true,
+                onClick: () => {
+                    title_cards_dialog();
+                },
+            },
             {
                 name: game.i18n.localize("ffg-star-wars-enhancements.controls.new-journal-template.name"),
                 title: game.i18n.localize("ffg-star-wars-enhancements.controls.new-journal-template.title"),