MCPcopy Index your code
hub / github.com/Lurkars/gloomhavensecretariat

github.com/Lurkars/gloomhavensecretariat @v0.166.3

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.166.3 ↗ · + Follow
3,400 symbols 9,648 edges 311 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Gloomhaven Secretariat

Latest Online Version

Publish Latest Online Version Build and Publish Release Publish Docker Image

image

Scenario 1 of Gloomhaven with starting classes of different editions

Table of Contents

Introduction

Gloomhaven Secretariat is a companion app for Gloomhaven-based board games. The app supports all official editions, namely Gloomhaven, Frosthaven, Jaws of the Lion, Forgotten Circles, Gloomhaven 2nd Edition, Button & Bugs and the Mercenary Packs, the community editions The Crimson Scales and Trail of Ashes as well as Solo scenarios and custom content from Custom Content Unity Guild.

GHS is a complete replacement for the abandoned Gloomhaven Helper app (by Esoteric Software®), enhanced with more tracking and automation features. As a single-screen web application, GHS helps manage scenario play by tracking character and monster turns, automatically setting up monsters separately for each room or section, assisting with scenario-specific rules, attack modifiers, loot deck, and much more. GHS also tracks your progress on the Character, Party and Campaign sheets, allowing you to buy and equip items, loot treasures, apply all scenario rewards, register scenario unlocks and manage your outpost. For a more detailed feature list, including a comparison of some popular applications, see Comparison of Companion Apps.

Multiple clients are supported by a server component Gloomhaven Secretariat Server with a public instance available at gloomhaven-secretariat.de.

Since GHS is a web application, no installation is required and it runs in any modern browser, even on mobile devices, but it can also be installed for offline use.

An extensive settings menu ensures highly individual customization to suit all requirements. Almost every feature can be switched on/off or customized.

Gloomhaven Secretariat is open-source software built with Angular and is open for the community to actively contribute ideas, suggestions and of course feedback and bug fixes. You can also help translating the app.

A basic user guide is available online.

SPOILER WARNING: The label/spoiler folder in the data folders, and therefore the final edition data files in the releases in the ./assets/data folder, contain spoilers by including the appropriate label.

More information about spoilers in this repository

Support me

Buy me a coffee? (or Donate directly via PayPal)

Current Features

  • Base feature complete for GH, FH, JOTL, FC and CS (all need testing, so please contribute!)
  • Tracking:
  • Initiative sorting
  • Health automatic exhaust/dead, max values for each level
  • Conditions auto expire + auto apply (wound, wound_x, regen, bane, poison, poison_x, ward, brittle)
  • Level, Loot, Experience of characters
  • Character Progression level, loot, experience, items, battle goals, perks, masteries
  • Character Attack Modifier Deck including Perks & CS Oak Cards
  • Elements automatic update status
  • Monster Stats
  • Monster Standees automatically adds standees for scenario rooms/sections, special rules and random monster cards
  • Monster Modifier Deck Adding Blessings and Curses, auto-shuffling
  • Monster Ability Cards auto-shuffling, calculated values (separate for normal and elite), add stats values
  • Character Summons
  • Scenarios and Sections with automatic level calculation, displays and applies special rules, and applies scenario results to character progression
  • Party Sheet
  • Campaign Management (some special rules for CS are missing)
  • Markers
  • Treasures
  • Character Items (must be enabled in Settings!) manage state of items during a scenario
  • Battle Goals (must be enabled in Settings!)
  • Event Decks (must be enabled in Settings!)
  • Elimination of the following physical components
  • Monster ability cards
  • Monster stat cards
  • Monster attack modifier deck
  • Damage tokens
  • Condition tokens
  • Element board, elemental disc, round tracker, initiative trackers
  • Character HP/XP dials
  • Character boards
  • Character sheets
  • Character attack modifier deck
  • Event decks
  • Loot deck
  • Town guard deck
  • Party/Campaign sheet
  • Item Cards
  • Battle Goals
  • Building deck
  • Frosthaven Decks:

SPOILER WARNING: Building 81

> Trials Deck

SPOILER WARNING: Building 90

> Challenges Deck
  • World Map

  • Other features:

  • i18n support (see translating for details)
  • PWA for installation on all devices!
  • Synchronise state (+ settings) with GHS Server
  • Manage permissions for different clients with GHS Server
  • Keyboard Shortcuts
  • Load custom JSON edition data for custom content!
  • Edit monster attack modifier and monster ability decks (support for Diviner class mechanics): reveal cards, remove cards, rearrange cards
  • Support for Frosthaven loot deck (including enhancements) and town guard deck
  • Support for Frosthaven Outpost Attacks
  • Support for Frosthaven Building 81 and 90 Mechanics including automation (if possible)
  • special ability automation for some characters

SPOILER WARNING:

> Banner of Strength: All alive allies gain +1 Attack at the start of their turn

> Banner of Hope: All alive allies with missing HP gain Heal 1 at the start of their turn

SPOILER WARNING:

> Time Tokens: Automatically add/remove time tokens at start of round after defining slow/fast

> Overdrive: Add Shield 1 at start of each slow round (removed at end of round)

> Breaknet Speed: Gain 2 damage at start of each round when not long resting (and automatically gain XP)

SPOILER WARNING:

> Unholy Prowess: Add +1 Heal to all Shambling Skeletons

> Solid Bones: Add +1 HP, +1 Move and Pierce 1 to all Shambling Skeletons

SPOILER WARNING:

> One with the Mountain: Whenever not having Regenerate, gain Regenerate

> Gift of the Mountain: Heal 2 self at end of each turn

SPOILER WARNING:

> Perk 11: Start each scenario with 2 Trophy Tokens

SPOILER WARNING:

> Auto-Apply Mode: When setting a summon to Prism Mode, transfer HP damage and conditions from summon to Prism

> Repair Drone Mode: Heal 2 self at start of turn

> Spider Mode (level 8): Gain Ward at start of turn

SPOILER WARNING:

> Imbue with Life: Whenever you do not have Disarm, gain Disarm

> Veil of Protection: Your current and maximum hitpoint values are increased by 3 (also applied to summons)

SPOILER WARNING:

> Delayed Malady: Negative conditions do not apply/expire for 4 rounds (and automatically gain XP)

SPOILER WARNING:

> Resonance Tokens: At the end of each of your turns, you gain one Resonance Token

> Perk 10: Start scenario with Brittle to gain 2 Resonance Tokens

SPOILER WARNING:

> Perk 9: Muddle new revealed Monster

SPOILER WARNING:

> Mech Suit (+5 HP, Heal 10)

SPOILER WARNING:

> Nightfall: Generate Dark when not strong at end of turn (and automatically gain XP)

SPOILER WARNING:

> Blood Pact: Suffer 1 damage at the start of each of your turns

> Unbridled Power: Enable overhealing up to 26 HP

> Careless Charge: Toggle immunity for all conditions

SPOILER WARNING:

> Automatically gain 1 XP at start of turn for active song

SPOILER WARNING: (GH/GH2E)

> Call of the Grave (level 1): Wound deals +1 damage to monsters

SPOILER WARNING: GH2E

> Blood Pact: Suffer 1 damage at the start of each of your turns (not when at 1 HP)

> Perk 9: Heal 3 instead of 2 during long rest

SPOILER WARNING:

> Start each scenario with 1 Supply Token

> Perk 11: Gain 1 additional Supply Token during long rest (max 5)

SPOILER WARNING:

> Perk 12: Fire, Ice, Air and Earth elements do not wane at end of round

SPOILER WARNING:

> Hive Tokens: Start each scenario with 1 Hive Token

SPOILER WARNING:

> Spirits: Spirit summons gain +1 HP at the start of Skull's turn, lose 1 HP at the end of Skull's turn
  • Random Dungeons
  • Scenario Flow Chart
  • Scenario Stats (damage/heal provided and received)
  • Monster data editor (https://gloomhaven-secretariat.de/editor/monster)
  • Includes Solo scenarios
  • Includes the Seeker of Xorn campaign: can be enabled under Data Management.
  • Includes the Satire's Extended Battle Goals: can be enabled under Data Management.
  • Includes Ice Rift: can be enabled under Data Management.
  • Includes Blood and Sand campaign: can be enabled in Data Management (Thanks to [/u/Calm_Construction131](https://www.reddit.com/user/Calm_Cons

Extension points exported contracts — how you extend this code

Figure (Interface)
(no doc) [6 implementers]
src/app/game/model/Figure.ts
Editional (Interface)
(no doc) [14 implementers]
src/app/game/model/data/Editional.ts
Entity (Interface)
(no doc) [4 implementers]
src/app/game/model/Entity.ts
Spoilable (Interface)
(no doc) [4 implementers]
src/app/game/model/data/Spoilable.ts
AndroidFullscreenPlugin (Interface)
(no doc) [1 implementers]
src/app/ui/helper/android-fullscreen.ts

Core symbols most depended-on inside this repo

find
called by 932
src/app/ui/helper/pointer-input-service.ts
filter
called by 777
src/app/ui/figures/attackmodifier/attackmodifier.ts
before
called by 424
src/app/game/commands/Command.ts
after
called by 403
src/app/ui/figures/conditions/highlight.ts
EntityValueFunction
called by 231
src/app/game/model/Entity.ts
evaluateExpression
called by 228
src/app/game/util/ExpressionEvaluator.ts
parse
called by 162
src/app/game/util/ExpressionEvaluator.ts
getLabel
called by 125
src/app/game/businesslogic/SettingsManager.ts

Shape

Method 2,550
Class 735
Function 65
Enum 34
Interface 16

Languages

TypeScript100%

Modules by API surface

src/app/ui/figures/party/party-sheet-dialog.ts98 symbols
src/app/game/businesslogic/GameManager.ts68 symbols
src/app/game/businesslogic/SettingsManager.ts45 symbols
src/app/ui/figures/character/character.ts42 symbols
src/app/game/businesslogic/MonsterManager.ts42 symbols
src/app/ui/figures/character/sheet/character-sheet.ts40 symbols
src/app/game/businesslogic/AttackModifierManager.ts40 symbols
src/app/ui/footer/scenario/summary/scenario-summary.ts39 symbols
src/app/ui/footer/footer.ts39 symbols
src/app/game/businesslogic/ScenarioManager.ts39 symbols
src/app/ui/figures/attackmodifier/attackmodifierdeck-dialog.ts37 symbols
src/app/game/businesslogic/StateManager.ts36 symbols

For agents

$ claude mcp add gloomhavensecretariat \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page