Merge pull request #47 from SirMotte/Hearth-Edition-Dev

v2.9.22-Torchbearer

README.md

@@ -1,9 +1,13 @@
 # Sir Motte's Magnificent Darkness - Hearth Edition
 
-This is a Theme Extension for the [Fantasy Grounds Virtual Tabletop Platform](https://www.fantasygrounds.com/).
+Current Version: 2.9.22 - Torchbearer
+November 22, 2023 - [Latest Changelog](https://github.com/SirMotte/FGU-Theme-Hearth/blob/Hearth-Edition-Main/CHANGELOG.md)
+
 Original creator: Sir Motte
 Maintained by: Justin Freitas
 
+This is a Theme Extension for the [Fantasy Grounds Virtual Tabletop Platform](https://www.fantasygrounds.com/).
+
 ![Showcase](https://user-images.githubusercontent.com/82598692/214700861-9e55f3c0-1541-41c6-b1fc-d6bd61e0ec5f.png)
 
 [Customization Bonus Extension](https://github.com/SirMotte/FGU-GM-Icon-Replacer/blob/GM-Icon_Replacer-Main/README.md)
@@ -13,25 +17,25 @@ Please relay questions and issue reports to, [JustinFreitas](https://www.fantasy
 You can still contact Sir_Motte, preferably on Discord, but he is, for now, no longer actively involved.
 
 ## Supported Rulesets (to varying degrees).
-- Dungeons & Dragons 5E
-- Dungeons & Dragons Classic / AdnD / 2E
-- Dungeons & Dragons 3.5E
-- Dungeons & Dragons 4E
-- Pathfinder 1E
-- Pathfinder 2E
-- XCore
-- Cypher System
-- Cyberpunk Red
-- OSE2
-- Other Rulesets might work surprisingly well, please test them and possibly report your findings.
+   - Dungeons & Dragons 5E
+   - Dungeons & Dragons Classic / AdnD / 2E
+   - Dungeons & Dragons 3.5E
+   - Dungeons & Dragons 4E
+   - Pathfinder 1E
+   - Pathfinder 2E
+   - XCore
+   - Cypher System
+   - Cyberpunk Red
+   - OSE2
+   - Other Rulesets might work surprisingly well, please test them and possibly report your findings.
 
 ## Special Contributors
-- [MeAndUnique](https://github.com/MeAndUnique)
-- [Saagael](https://github.com/Gtaray)
-- [JustinFreitas](https://forge.fantasygrounds.com/crafter/60/view-profile) - Current Maintainer
-- [bmos](https://github.com/bmos)
-- [Zarestia](https://github.com/ZarestiaDev)
-- Unofficial Developers Guild
+   - [MeAndUnique](https://github.com/MeAndUnique)
+   - [Saagael](https://github.com/Gtaray)
+   - [JustinFreitas](https://forge.fantasygrounds.com/crafter/60/view-profile) - Current Maintainer
+   - [bmos](https://github.com/bmos)
+   - [Zarestia](https://github.com/ZarestiaDev)
+   - Unofficial Developers Guild
 
 ## Foreword
 This theme was created by Sir Motte in his pursuit to not burn out his eyes in dim light conditions while using FGU. It quickly became one of the most downloaded items on the Forge. 
@@ -53,31 +57,41 @@ Due to time constraints he is no longer able to work on the theme and maintenanc
 ## Compatibility Information & Known Problems
 This theme uses a very high loadorder of 1500 in order to be able to overwrite most extension's UI elements out there. Therefore any extension that you want to overwrite my theme with must use a loadorder value of 1501 or higher. This is set in the extension.xml within any extension.
 
-- Font Extensions like the one by Mattekure will make the font go back to black and thus badly readable.
-- If you pay close attention to the console log you might find [Warning] entries related to this theme. These can normaly be ignored, as they only tell you that some extension supported is not used.
-- Celestians "Author" extension currently makes storyframe list entries hard to read (black). I'm working on resolving the issue. For now, don't use my theme during world building with the Author extension enabled.
+   - Font Extensions like the ones by Mattekure will make the font go back to black and thus badly readable.
+   - If you pay close attention to the console log you might find [Warning] entries related to this theme. You can safely ignore them, as they only tell you, that you're not using an extension supported by my theme. [ERROR]     entries on the other hand are serious. If you encounter one related to this theme, please give me a report.
+   - A warning regarding Chat Aesthetics Configurator by Drowbe, maintained by rhagelstrom. Its font settings and chat colors won't fit very well with my theme. If you still want to use it please set it to default color in its settings menu entry.If you're using the PFRPG2 ruleset, you need to restart the client AND the lanucher else the action icons won't show.
+   - Celestians "Author" extension currently makes storyframe list entries hard to read (black). I'm working on resolving the issue. For now, don't use my theme during world building with the Author extension enabled.
 
 # Installation - Forge (Recommended)
-1. Subscribe to the [FG Forge Item](https://forge.fantasygrounds.com/shop/items/12/view) and Update your Fantasy Grounds Client.
-2. Activate the theme listed as "Theme: Hearth" in your campaign details page in the "Extensions" section and launch the campaign.
-3. Done, I hope you like it!
+   1. Subscribe to the [FG Forge Item](https://forge.fantasygrounds.com/shop/items/12/view) and Update your Fantasy Grounds Client.
+   2. Activate the theme listed as "Theme: Hearth" in your campaign details page in the "Extensions" section and launch the campaign.
+   3. Done, I hope you like it!
 
 # Installation - GitHub
-1. [Download](https://github.com/SirMotte/FGU-Theme-Hearth/releases) the Theme from Github
-   - or grab the Developer-Build (always most up to date, but potentially unstable)
-2. Move the file named "Theme_SirMotte_Hearth.ext" into the "Extensions" Folder found inside your Fantasy Grounds Data folder"
-3. Activate the theme listed as "Theme: Hearth" in your campaign details page in the "Extensions" section and launch the campaign
-4. Done, I hope you like it!
+   1. [Download](https://github.com/SirMotte/FGU-Theme-Hearth/releases) the Theme from Github.
+   2. Move the file named "Theme_SirMotte_Hearth.ext" into the "Extensions" Folder found inside your Fantasy Grounds Data folder".
+   3. Activate the theme listed as "Theme: Hearth" in your campaign details page in the "Extensions" section and launch the campaign.
+   4. Done, I hope you like it!
 
 ## Customization Bonus Extension
-- In order to customize your GM Icon, download my [GM Icon Replacer Extension](https://github.com/SirMotte/FGU-GM-Icon-Replacer/blob/GM-Icon_Replacer-Main/README.md) and follow the instructions in the readme.
+   - In order to customize your GM Icon, download my [GM Icon Replacer Extension](https://github.com/SirMotte/FGU-GM-Icon-Replacer/blob/GM-Icon_Replacer-Main/README.md) and follow the instructions in the readme.
 
 Enjoy!
 Sir Motte
 
 
 # Hall of Fame
-- 
+- The first offering seemed to do little and as the Knight stepped back from the altar, his unease was showing clearly on his face.
+"We can't fail!" he uttered as he nodded to the Ranger.
+The young Elf carefully approached the basin and put forth his selection of goods. Ripples of golden light radiated across the fluids surface when the items sank down to its bottom.
+"It is pleased!" he whispered, showing little emotion on his face, but his companions knew him well enough to decipher his stoic expression. Elation and a hint of relief.
+"My turn!" grunted the short sorcerer. He had trouble to place his gifts, his height forced him to tiptoe around the altar and place them one by one at its large stone rim.
+With a push by his cane he tipped them over. Splish, splash. The soft light became brighter and brighter with each item, until the Adventurers had to avert their eyes.
+
+Pleasant heat tickled their skin and they dared to look up again. An orb of pure light had formed atop the altar, hovering just a few inches in the air.
+"We made it!" gasped the Knight and stepped forward....
+
+- Evolivolution for providing Starfinder support!
 - Shoutout to seansps who added Cyberpunk Red support to the theme, you rock!
 - Rugged sea, distant shore, waves and thunder evermore.
 Laughing gods of wet an wind care not for souls on wooden splint.
@@ -91,7 +105,9 @@ my heart was moved you may go further!"
 Thank you Tabarkus, for a launch of ships to my maps collection!
 - Thanks a lot to the two people who donated using the forge donation system. When you do, make sure that Smite Works gets a little cut as well.
 - The creature stared at me while sitting on top of its treasure. Its enormous front teeth glistened wet in the dim light, as did its brown fur. It smirked, the smirk became a smile and suddenly it snipped an object at me from below its feet. My instincts made me flinch, but my arm reached for the object anyway and snatched it out of the air. A beautiful gold coin from a distant country lay in my hand. Intricate and ornate details framed a fair face with long hair and a hat of an unknown fashion. The smile resembled the one shown by the creature. As I looked up again, the creature still sat there, still watching me, still smiling. I bowed. I would do my best to please it again. Thanks to Felix Achberger for donating!
-- The nameless soul led on in silence. A ghoustly figure floating just a few feet in front of me, ragged clothes billowing in an otherworldy breeze. The translucent body shimmered in a faint silverish, blue light. I followed it into a room, that looked to have been a study at some point in the distant past. Crumbling parchment and dried out inkpots, old maps of long lost kingdoms and tomes of forgotten wisdom lay about in a somewhat orderly fashion. "Remarkable!", I thought, as I let my eyes examine the treasures before me. The ghostly figure stopped and turned to me, his fair face seemed to kindly smile as he noticed the exitement in my eyes. His hands began to gesture around the room, pointed at some of his belongings, and then at me. He smiled again. I understood, nodded, bowed deeply and then returned his smile. Certainly not as fair as his, but in kind.
+- The nameless soul led on in silence. A ghoustly figure floating just a few feet in front of me, ragged clothes billowing in an otherworldy breeze. The translucent body shimmered in a faint silverish, blue light. I followed it into a room, that looked to have been a study at some point in the distant past. Crumbling parchment and dried out inkpots, old maps of long lost kingdoms and tomes of forgotten wisdom lay about in a somewhat orderly fashion. "Remarkable!", I thought, as I let my eyes examine the treasures before me. The ghostly figure stopped and turned to me, his fair face seemed to kindly smile as he noticed the exitement in my eyes.
+His hands began to gesture around the room, pointed at some of his belongings, and then at me. He smiled again.
+I understood, nodded, bowed deeply and then returned his smile. Certainly not as fair as his, but in kind.
 - Where wares and coin change purse and hands, the one called Bayne there proudly stands, manifold a craft displayed, unlucky those who come too late, missing out on goods so great!
 - Kindred spirit, generous soul, artful script makes worth a scroll, it's weight in gold and read out loud. Thank you bmos, you can be proud!
 - The one who shares with golden heart, bright in soul and sound in art, has given plentiful his craft; abundant the amount amassed; eyes wide open I childlike laughed. Thank you Dud-in!

build-windows/build-fgu-theme-hearth-zip.bat

@@ -0,0 +1,15 @@
+:: Works on Windows (10 and 11, at least). Assumes running from Theme_SirMotte_Hearth\build
+:: Use GitHub Action 'Create Release' for official release builds but this helps during development.
+mkdir out\Theme_SirMotte_Hearth
+copy ..\extension.xml out\Theme_SirMotte_Hearth\
+copy ..\SirMotte_footface.png out\Theme_SirMotte_Hearth\
+xcopy ..\common\*.* out\Theme_SirMotte_Hearth\common /h /i /c /k /e /r /y
+xcopy ..\graphics\*.* out\Theme_SirMotte_Hearth\graphics /h /i /c /k /e /r /y
+xcopy ..\rulesets\*.* out\Theme_SirMotte_Hearth\rulesets /h /i /c /k /e /r /y
+xcopy ..\scripts\*.* out\Theme_SirMotte_Hearth\scripts /h /i /c /k /e /r /y
+cd out
+CALL ..\zip-items Theme_SirMotte_Hearth
+rmdir /S /Q Theme_SirMotte_Hearth\
+copy Theme_SirMotte_Hearth.zip Theme_SirMotte_Hearth.ext
+cd ..
+explorer .\out

build-windows/zip-items.cmd

@@ -0,0 +1,34 @@
+@echo off   
+if "%1"=="" goto end
+
+setlocal
+set TEMPDIR=%TEMP%\ZIP
+set FILETOZIP=%1
+set OUTPUTZIP=%2.zip
+if "%2"=="" set OUTPUTZIP=%1.zip
+
+:: preparing VBS script, tune the Sleep value (in milliseconds, give enough time for compression) so that operation finishes before time elapses, else 1K zipfile (bad).
+echo Set objArgs = WScript.Arguments > _zipIt.vbs
+echo InputFolder = objArgs(0) >> _zipIt.vbs
+echo ZipFile = objArgs(1) >> _zipIt.vbs
+echo Set fso = WScript.CreateObject("Scripting.FileSystemObject") >> _zipIt.vbs
+echo Set objZipFile = fso.CreateTextFile(ZipFile, True) >> _zipIt.vbs
+echo objZipFile.Write "PK" ^& Chr(5) ^& Chr(6) ^& String(18, vbNullChar) >> _zipIt.vbs
+echo objZipFile.Close >> _zipIt.vbs
+echo Set objShell = WScript.CreateObject("Shell.Application") >> _zipIt.vbs
+echo Set source = objShell.NameSpace(InputFolder).Items >> _zipIt.vbs
+echo Set objZip = objShell.NameSpace(fso.GetAbsolutePathName(ZipFile)) >> _zipIt.vbs
+echo if not (objZip is nothing) then  >> _zipIt.vbs
+echo objZip.CopyHere(source) >> _zipIt.vbs
+echo wScript.Sleep 15000 >> _zipIt.vbs
+echo end if >> _zipIt.vbs
+
+@ECHO Zipping, please wait...
+mkdir %TEMPDIR%
+xcopy /y /s %FILETOZIP% %TEMPDIR%
+cscript //NoLogo _zipIt.vbs  %TEMPDIR%  %OUTPUTZIP%
+del _zipIt.vbs
+rmdir /s /q  %TEMPDIR%
+
+@ECHO ZIP Completed.
+:end

rulesets/ose2_compilation.xml

@@ -15,6 +15,9 @@
 	<icon name="data" file="graphics/tabs_ose2/tab_data.png" />
 	<icon name="tab_rolls" file="graphics/tabs_ose2/tab_rolls.png" />
 
+	<font name="OSEsmall" merge="join">
+		<color value="#FFF0CA" />
+	</font>
 	<font name="Ose-Reference" merge="join">
 		<color value="#FFF0CA" />
 	</font>