diff --git a/CHANGELOG.md b/CHANGELOG.md index fd2927d5..c5f4b0ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +# 3.4.10 + +- (Maintenance) Added Wardens of Wildwood to the premium module exclusion system. +- (Meta) Updated the README to more accurately reflect the module as of v3+. + # 3.4.9 - (Maintenance) Ensured Vehicle sheets are styled properly again, with respect to sheet theme and PC theme color. diff --git a/README.md b/README.md index 889c058f..f94509ee 100644 --- a/README.md +++ b/README.md @@ -4,118 +4,96 @@ ![Latest Version Downloads](https://img.shields.io/github/downloads/dorako/pf2e-dorako-ui/latest/total?color=171f69&label=Latest%20Version%20Downloads&sort=semver) [![Forge Installs](https://img.shields.io/badge/dynamic/json?label=Forge%20Installs&query=package.installs&suffix=%25&url=https%3A%2F%2Fforge-vtt.com%2Fapi%2Fbazaar%2Fpackage%2Fpf2e-dorako-ui&colorB=e9d7a1)](https://forge-vtt.com/bazaar#package=pf2e-dorako-ui) -This is a UI overhaul for the Pathfinder 2nd Edition System for Foundry VTT, building upon the work of mdizo. +A UI overhaul for the Pathfinder 2nd Edition System for Foundry VTT. + +If you and/or your players enjoy Dorako UI, consider supporting me on Ko-fi (all proceeds go towards pulling Honkai: Star Rail waifus). +[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B8X7O6Q) ## Localization Translation status -## Fresh coat of paint - -This theme standardizes the Foundry UI, Pathfinder 2e System sheets, and all your modules (even popular macros!) to a pretty combination of glass, red, and blue. - -All clickable elements react to :hover, with a quick, standardized transition. - -### Foundry UI - -Navigation, Controls, Hotbar, Sidebar - - -### Token Effects HUD - - - -### Chat messages - -#### A strike, using the light message theme - - - -#### A strike, using the dark message theme - - - -#### A strike, using the light message theme, with a red header - - - -### Pathfinder 2e sheets and UI +# Themes -#### Rework of all sorts of sheets and applications, for both light and dark UI theme +Dorako UI has a powerful system to theming all aspects of the FVTT UI. Themes can be enabled or disabled to your preferences. - - +Dorako UI introduces three types of themes: -#### New themes for NPCs, Hazard, and Familiars +- Sheet themes +- Interface themes +- Chat message themes - - +#### Example -#### New dark theme for PC sheets + +Pictured: A mishmash of available theme options. - +## Sheet themes -#### Effects rounded, panel also scrolls if needed +These themes affect the look and feel of 'window' style applications and sheets. +Available themes include: - +- **Core Rulebook/CRB** theme, inspired by the PF2e system sheets, building upon the work of mdizo. Available in light and dark color schemes. +- **Foundry2** theme, inspired by the design language introduced in Foundry 11. +- **Baldur's Gate 3** theme, inspired by the video game Baldur's Gate 3. +- **Discord** theme, inspired by the software of the same name. Available in light and dark color schemes. +- **D&D 5e** theme, inspired by the design language introduced in the v3 5e system. Requires the 5e system to be installed for certain assets to load. -### Modules +## Interface themes -#### A strike and a damage roll, merged using DFCE, with 'attack' traits removed from the damage roll to conserve space +These themes affect the look and feel of 'UI' style applications such as the hotbar, scene navigation, the token HUD, and many modules. +Available themes include: - +- **Glass** theme, the original 'Dorako UI' look. A refinement of default FVTT design using colors typical to Pathfinder. +- **Opaque** theme, for people who do not appreciate transparency. +- **Foundry2** theme. +- **Discord** theme. +- **BG3** theme. -#### Spell message with blue header, restructured to put important information up top, with PF2e Target Damage to add per-target buttons +## Chat Message themes - +These themes affect the look and feel of chat messages. +A different theme can be applied to messages from the 'opposition', making enemy creatures feel visibly distinct. For example using a light color scheme for allies and a dark color scheme for enemies. +Available themes include: -#### Modules that live in the sidebar have explicit theme compatability. In this picture, PF2e Speaking As, DFCE, Polyglot, Dice Tray +- **Core Rulebook** light and dark theme, with an extra setting for header theme colors. +- **Foundry2** theme. +- **Baldur's Gate 3** brown and blue theme, inspired by the M&K and controller UI. +- **Discord** light and dark theme. +- **D&D 5e** light and dark theme. - +## PC Sheet color theme -#### Explicit styling for a bunch of ironkmonk's modules +Player Character and Vehicle sheets provided by the PF2e system have a red banner. Dorako UI provides options for changing the 'theme color' to suit your preferences: -Including "Active Tile Triggers", "Common Display", "Hotbar Expansion", "Little Details", "Scene Navigation", "TokenBar", etc. -Image shows a journal with Dalvyn's CRB styled journals enabled. +- **Default** +- Red +- Green +- Blue +- Purple +- Black - - -#### Token HUD with Monk's Little Details +## Wide compatability - +- Includes explicit theme support for 30+ modules. +- Warns you about compatability issues that can be fixed by changing settings in other modules, and gives you a one-click button to resolve the issues. +- Includes a system for excluding incompatible applications from theming. +- Includes a system for excluding journals provided by premium content modules from theming. -#### Token Action HUD +## Highly customizable - +If you're feeling brave, Dorako UI includes 'Do It Yourself' theme options that are unstyled by the module, but are treated as real themes, and provide you all the affordances and integration of the themes provided by Dorako UI. +You can supply your own CSS to create a fully custom theme. -#### Foundry 2 Application Theme +For smaller changes, Dorako UI includes a 'custom css' box for minor tweaks. - +Check the [Wiki](https://github.com/Dorako/pf2e-dorako-ui/wiki) for more details. ## Features Non-theme features have been moved to [Dorako UX](https://github.com/Dorako/pf2e-dorako-ux) -## Wide compatability - -- Includes explicit theme support for 30+ modules. -- Warns you about compatability issues that can be fixed by changing settings in other modules, and gives you a one-click button to resolve the issues. -- Includes a system for marking applications as incompatible with dark theme (or _requiring_ dark theme in some cases) -- Includes a system to avoid affecting "Premium content journals". - - All premium content modules with the exception of Beginner's Box and Abomination Vaults includes fancy Journal frames that should not be affected by Dorako UI. - - All premium content journals, regardles of whether they have fancy frames, are marked as exempt from styling so they are unaffected by dark journal theme, or Dalvyn's CRB styling. - - The system is easy to extend for future premium modules. - -## Highly customizable - -- Prefer a different color for the application chrome? -- Got a beefy PC and want the chrome to be frosted glass? -- Prefer _not_ to use Dorako UI for certain modules? -- Got a nitpicky feature request that isn't already a setting? - -Dorako UI's custom settings menu allows you to configure the theme to your liking. - ## Licenses & Attributions This code is available under the MIT license, see LICENSE. diff --git a/esmodules/consts.js b/esmodules/consts.js index 845bd852..b20540c0 100644 --- a/esmodules/consts.js +++ b/esmodules/consts.js @@ -5,7 +5,7 @@ export const MODULE_NAME = "pf2e-dorako-ui"; /* ----------------------------------------- */ /* Premium module */ /* ----------------------------------------- */ -export const premiumModuleSelector = ".sevendooms, .sevendooms-wrapper, .rusthenge, .rusthenge-wrapper, .pfs05, .pfs05Pt2 .pfs05Pt1, .pfs05Pt1-wrapper, .pf2e-yom, .pf2e-ii, .pf2e-woii, .seasonofghosts, .seasonofghosts-wrapper, .skykingstomb-wrapper, .skykingstomb, .stolenfate-wrapper, .stolenfate, .harrow-reading, .harrow, .pf2e-km, .kingdom-app, .swpf-sheet, .swpf-wrapper, .pf2e-av, .pf2e-bb, .gatewalkers-wrapper, .gatewalkers, .outlaws-wrapper, .outlaws, .bloodlords-wrapper, .bloodlords, .kingmaker-wrapper, .kingmaker"; // +export const premiumModuleSelector = "wardensofwildwood, wardensofwildwood-wrapper, .sevendooms, .sevendooms-wrapper, .rusthenge, .rusthenge-wrapper, .pfs05, .pfs05Pt2 .pfs05Pt1, .pfs05Pt1-wrapper, .pf2e-yom, .pf2e-ii, .pf2e-woii, .seasonofghosts, .seasonofghosts-wrapper, .skykingstomb-wrapper, .skykingstomb, .stolenfate-wrapper, .stolenfate, .harrow-reading, .harrow, .pf2e-km, .kingdom-app, .swpf-sheet, .swpf-wrapper, .pf2e-av, .pf2e-bb, .gatewalkers-wrapper, .gatewalkers, .outlaws-wrapper, .outlaws, .bloodlords-wrapper, .bloodlords, .kingmaker-wrapper, .kingmaker"; // /* ----------------------------------------- */ /* Apps */ diff --git a/promo/errything.webp b/promo/errything.webp new file mode 100644 index 00000000..8841d331 Binary files /dev/null and b/promo/errything.webp differ diff --git a/promo/src/effect-panel.png b/promo/legacy/src/effect-panel.png similarity index 100% rename from promo/src/effect-panel.png rename to promo/legacy/src/effect-panel.png diff --git a/promo/src/foundry2-theme.png b/promo/legacy/src/foundry2-theme.png similarity index 100% rename from promo/src/foundry2-theme.png rename to promo/legacy/src/foundry2-theme.png diff --git a/promo/src/item-dark-theme.png b/promo/legacy/src/item-dark-theme.png similarity index 100% rename from promo/src/item-dark-theme.png rename to promo/legacy/src/item-dark-theme.png diff --git a/promo/src/item-light-theme.png b/promo/legacy/src/item-light-theme.png similarity index 100% rename from promo/src/item-light-theme.png rename to promo/legacy/src/item-light-theme.png diff --git a/promo/src/monks.png b/promo/legacy/src/monks.png similarity index 100% rename from promo/src/monks.png rename to promo/legacy/src/monks.png diff --git a/promo/src/npc-hazard-dark-theme.png b/promo/legacy/src/npc-hazard-dark-theme.png similarity index 100% rename from promo/src/npc-hazard-dark-theme.png rename to promo/legacy/src/npc-hazard-dark-theme.png diff --git a/promo/src/npc-hazard-light-theme.png b/promo/legacy/src/npc-hazard-light-theme.png similarity index 100% rename from promo/src/npc-hazard-light-theme.png rename to promo/legacy/src/npc-hazard-light-theme.png diff --git a/promo/src/pc-dark-theme.png b/promo/legacy/src/pc-dark-theme.png similarity index 100% rename from promo/src/pc-dark-theme.png rename to promo/legacy/src/pc-dark-theme.png diff --git a/promo/src/red-blue-glass.png b/promo/legacy/src/red-blue-glass.png similarity index 100% rename from promo/src/red-blue-glass.png rename to promo/legacy/src/red-blue-glass.png diff --git a/promo/src/sidebar-modules.png b/promo/legacy/src/sidebar-modules.png similarity index 100% rename from promo/src/sidebar-modules.png rename to promo/legacy/src/sidebar-modules.png diff --git a/promo/src/spell-message-restructure.png b/promo/legacy/src/spell-message-restructure.png similarity index 100% rename from promo/src/spell-message-restructure.png rename to promo/legacy/src/spell-message-restructure.png diff --git a/promo/src/strike-dark-theme.png b/promo/legacy/src/strike-dark-theme.png similarity index 100% rename from promo/src/strike-dark-theme.png rename to promo/legacy/src/strike-dark-theme.png diff --git a/promo/src/strike-dfce-merge-strip-tags.png b/promo/legacy/src/strike-dfce-merge-strip-tags.png similarity index 100% rename from promo/src/strike-dfce-merge-strip-tags.png rename to promo/legacy/src/strike-dfce-merge-strip-tags.png diff --git a/promo/src/strike-light-theme-red-header.png b/promo/legacy/src/strike-light-theme-red-header.png similarity index 100% rename from promo/src/strike-light-theme-red-header.png rename to promo/legacy/src/strike-light-theme-red-header.png diff --git a/promo/src/strike-light-theme.png b/promo/legacy/src/strike-light-theme.png similarity index 100% rename from promo/src/strike-light-theme.png rename to promo/legacy/src/strike-light-theme.png diff --git a/promo/src/token-action-hud.png b/promo/legacy/src/token-action-hud.png similarity index 100% rename from promo/src/token-action-hud.png rename to promo/legacy/src/token-action-hud.png diff --git a/promo/src/token-effects-hud.png b/promo/legacy/src/token-effects-hud.png similarity index 100% rename from promo/src/token-effects-hud.png rename to promo/legacy/src/token-effects-hud.png diff --git a/promo/src/token-hud-monk.png b/promo/legacy/src/token-hud-monk.png similarity index 100% rename from promo/src/token-hud-monk.png rename to promo/legacy/src/token-hud-monk.png diff --git a/promo/web/effect-panel.jpg b/promo/legacy/web/effect-panel.jpg similarity index 100% rename from promo/web/effect-panel.jpg rename to promo/legacy/web/effect-panel.jpg diff --git a/promo/web/foundry2-theme.jpg b/promo/legacy/web/foundry2-theme.jpg similarity index 100% rename from promo/web/foundry2-theme.jpg rename to promo/legacy/web/foundry2-theme.jpg diff --git a/promo/web/item-dark-theme.jpg b/promo/legacy/web/item-dark-theme.jpg similarity index 100% rename from promo/web/item-dark-theme.jpg rename to promo/legacy/web/item-dark-theme.jpg diff --git a/promo/web/item-light-theme.jpg b/promo/legacy/web/item-light-theme.jpg similarity index 100% rename from promo/web/item-light-theme.jpg rename to promo/legacy/web/item-light-theme.jpg diff --git a/promo/web/monks.jpg b/promo/legacy/web/monks.jpg similarity index 100% rename from promo/web/monks.jpg rename to promo/legacy/web/monks.jpg diff --git a/promo/web/npc-hazard-dark-theme.jpg b/promo/legacy/web/npc-hazard-dark-theme.jpg similarity index 100% rename from promo/web/npc-hazard-dark-theme.jpg rename to promo/legacy/web/npc-hazard-dark-theme.jpg diff --git a/promo/web/npc-hazard-light-theme.jpg b/promo/legacy/web/npc-hazard-light-theme.jpg similarity index 100% rename from promo/web/npc-hazard-light-theme.jpg rename to promo/legacy/web/npc-hazard-light-theme.jpg diff --git a/promo/web/pc-dark-theme.jpg b/promo/legacy/web/pc-dark-theme.jpg similarity index 100% rename from promo/web/pc-dark-theme.jpg rename to promo/legacy/web/pc-dark-theme.jpg diff --git a/promo/web/red-blue-glass.jpg b/promo/legacy/web/red-blue-glass.jpg similarity index 100% rename from promo/web/red-blue-glass.jpg rename to promo/legacy/web/red-blue-glass.jpg diff --git a/promo/web/sidebar-modules.jpg b/promo/legacy/web/sidebar-modules.jpg similarity index 100% rename from promo/web/sidebar-modules.jpg rename to promo/legacy/web/sidebar-modules.jpg diff --git a/promo/web/spell-message-restructure.jpg b/promo/legacy/web/spell-message-restructure.jpg similarity index 100% rename from promo/web/spell-message-restructure.jpg rename to promo/legacy/web/spell-message-restructure.jpg diff --git a/promo/web/strike-dark-theme.jpg b/promo/legacy/web/strike-dark-theme.jpg similarity index 100% rename from promo/web/strike-dark-theme.jpg rename to promo/legacy/web/strike-dark-theme.jpg diff --git a/promo/web/strike-dfce-merge-strip-tags.jpg b/promo/legacy/web/strike-dfce-merge-strip-tags.jpg similarity index 100% rename from promo/web/strike-dfce-merge-strip-tags.jpg rename to promo/legacy/web/strike-dfce-merge-strip-tags.jpg diff --git a/promo/web/strike-light-theme-red-header.jpg b/promo/legacy/web/strike-light-theme-red-header.jpg similarity index 100% rename from promo/web/strike-light-theme-red-header.jpg rename to promo/legacy/web/strike-light-theme-red-header.jpg diff --git a/promo/web/strike-light-theme.jpg b/promo/legacy/web/strike-light-theme.jpg similarity index 100% rename from promo/web/strike-light-theme.jpg rename to promo/legacy/web/strike-light-theme.jpg diff --git a/promo/web/token-action-hud.jpg b/promo/legacy/web/token-action-hud.jpg similarity index 100% rename from promo/web/token-action-hud.jpg rename to promo/legacy/web/token-action-hud.jpg diff --git a/promo/web/token-effects-hud.jpg b/promo/legacy/web/token-effects-hud.jpg similarity index 100% rename from promo/web/token-effects-hud.jpg rename to promo/legacy/web/token-effects-hud.jpg diff --git a/promo/web/token-hud-monk.jpg b/promo/legacy/web/token-hud-monk.jpg similarity index 100% rename from promo/web/token-hud-monk.jpg rename to promo/legacy/web/token-hud-monk.jpg