Gloomhaven Secretariat

Latest Online Version

Gloomhaven Secretariat is a Gloomhaven/Frosthaven companion app that keeps track of all entity values to allow more focus on gameplay. It is an open source web application built with [Angular] (https://angular.io/).

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.

For use with multiple clients sharing the same game, the server component Gloomhaven Secretariat Server is required. A public instance is available at gloomhaven-secretariat.de port 8443 with secure option. (I also maintain a public server list, so please contact me if you're running a public instance yourself).

GHS is based on the look and feel of the original Gloomhaven Helper (by Esoteric Software®). Since GHH has been discontinued and is no longer available, GHS should become a well maintained successor, implementing all the functionality of GHH, many improvements and many more features. For a comparison of some popular apps, see Comparison of Companion Apps.

As open source software this is meant for the community to actively contribute with ideas, suggestions and of course feedback. As I am not capable of good design/UX, feel free to contribute better assets.

If you need help using the app, have a look at the help page. It is not complete, but should help with all the general steps to use GHS properly.

SPOILER WARNING: The label-spoiler.json files 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!), for details see Data Progression
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, Investment*, Experience* of characters
- Character Progression Level, loot, experience, items, battlegoals, perks, masteries
- Character Attack Modifier Deck including Perks & CS Oak Cards
- Elements automatic update status
- Monster Stats
- Monster Standees automatically adds stats for scenario rooms/sections and special rules (room/section data WIP)
- Monster Modifier Deck Adding Blessings and Curses, auto shuffling
- Monster Ability Cards auto-shuffling, calculated values (separate for normal and elite)
- Character Summons
- Scenarios and Sections with automatic level calculation, display and apply special rules and end scenario to apply character progression
- Party Sheet
- Campaign Management (some special rules for CS are missing)
- Markers
- Treasures (WIP)
Elimination of the following physical components
- monster ability cards
- monster stat cards
- Monster Attack Modifier Deck
- damage tokens
- Condition tokens
- Elemental Board, Elemental Disc, Round Tracker, Initiative Tracker
- Character HP/XP dials
- Character boards
- Character sheets
- Character attack modifier deck
- Loot Deck
- Party/Campaign Sheet
Other features:
- i18n support (currently en, de, fr and ko, more translations needed. Many thanks to the contributors of french and korean)
- PWA for installation on all devices!
- Synchronise state (+ settings) with GHS Server
- Manage permissions for different clients with GHS Server
- 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 FH Loot Deck, including enhancements
- Monster Data Editor (https://gloomhaven-secretariat.de/editor/monster)
- Includes Solo Scenarios
- Includes Blood and Sand campaign: can be enabled in Data Management (Thanks to /u/Calm_Construction131 for contribution)
- Includes the Seeker of Xor campaign: can be enabled under Data Management.
- Manage multiple parties (on the party sheet while no active scenario is set)
- SPOILER WARNING: Envelope X (and V)
  To add Envelope X (or V for ToA), enable it under Data Management, then enter the full name in the Character Filter (not case sensitive).

Short term plans

Validate all existing data
Address all issues

Long term plans

Support for managing character ability cards

Install

Install as App

You can always install any hosted version as an App (PWA) if your OS/Browser supports PWA installation. For example, here is the Latest Online Version.

Instructions for different devices/browsers:

Chrome: Computer/Android
Safari: iOS
Firefox: Android
other: search for "install PWA"

Standalone

An Electron application is available for Linux, Mac and Windows. Download the appropriate files from the latest release assets.

Linux AppImage only tested for now

Selfhosting

To self host Gloomhaven Secretariat on your web server, simply download the zip file from the latest release and unzip it on your web server.

The base url for this build is set to root. To use a different base URL, please build your own package.

Build and run with Docker

If you want to use docker to run on port 80, run the following

docker pull gloomhavensecretariat/ghs
docker run --rm -p 80:80 --name ghs gloomhavensecretariat/ghs

For use with docker compose, just run docker compose up -d.

Building from source

If you want to create your own custom build (e.g. on Selfhosting), prepare a development setup. Then run npm run build' ([available options](https://angular.io/cli/build#options)) and access the build at ./dist/gloomhavensecretariat'.

Development

Prerequisite:

Current Node.js and npm version

Check out the source with git clone https://github.com/Lurkars/gloomhavensecretariat.git.

Install the dependencies with npm install.

Then run npm run start to create a development server at http://localhost:4200.

To develop with docker, install docker compose and run docker compose -f docker-compose.dev.yaml up -d.

Contributing

Feel free to file a new issue for bugs, features and improvements or start a new new discussion for help or feedback.

All game data is located in the data folder with subfolders for each release. A third party review of all data would be great. As all files are JSON data, they should be easily human readable. Each character, monster and monster deck has it's own file, so it should be easy to check. Each edition folder will be concatenated into a single edition data file on build.

Pull requests are also welcome!

Please note: all files in the data subfolder will be automatically formatted and added to each commit. If you have made local changes to these files and do NOT want to commit those changes, please use the --no-verify' parameter for your git commit' and `git push' commands.

Thanks to everyone who has already contributed, you're awesome!

Privacy

This application does NOT collect any personal data. Everything runs and stays in your browser/local memory. For using the server component please go to Gloomhaven Secretariat Server#Privacy.

Copyright / License

Gloomhaven and all related properties, images and text are owned by Cephalofair Games.

Assets/Data used:

Creator Pack by Isaac Childres CC BY-NC-SA 4.0
Worldhaven
Nerdhaven Images
X-haven Assistant
Gloomhaven Item DB
Virtual Gloomhaven Board
some other used assets are licensed under public domain

Source code is licensed under AGPL

Personal disclaimer

This is a hobby project I do in my spare time. The software fills a practical need due to the demise of the original Helper application, so I am following the Quick'n'Dirty approach to get things done quickly. This of course leads to a lack of quality and testing and the code base is definitely not in line with my profession.

pyroghostx / gloomhavensecretariat Goto Github PK