Skip to content

A web application to create and share character builds for the popular tabletop and digital game Gloomhaven

Notifications You must be signed in to change notification settings

ceva24/havenplanner

Repository files navigation

HavenPlanner

build tests code formatting linting type checking codeql analysis end-to-end tests performance checks cypress tests Coverage status

code formatting: prettier XO code style Tested with cypress.io This project is using Percy.io for visual regression testing licence CC BY-NC-SA 4.0

👋 Introduction

A web application to create and share character builds for the popular tabletop and digital game Gloomhaven. Inspired by tools like Dark Souls Character Planner, WoW Armory and FFXIV Lodestone.

🗒️ Features

  • Enter character details and select a personal quest
  • Select perks, track battle goal progress and see the resulting attack modifier deck composition
  • View and unlock character ability cards, create a saved hand, and select enhancements for cards
  • Browse and select items
  • Configure spoiler settings to show and hide locked classes and items
  • Save and share characters with a shareable link

Not implemented

  • Content from Forgotten Circles, Jaws of the Lion, Crimson Scales, Trail of Ashes and Frosthaven

💻 Development

Built with TypeScript, Next.js and MUI ❤️

Prerequisites

  1. The version of Node.js listed in .nvmrc

  2. A Google Chrome installation, to run Lighthouse locally

Tooling

Uses lint-staged and Husky for pre-commit hooks 🐶 woof!

Enforces conventional commits via commitlint, see Contribution guidelines for valid types.

Image hosting

Uses ceva24/worldhaven as a CDN for images, hosted at images.havenplanner.app.

Accessibility

This application is built for accessibility: it aims to meet at least WCAG 2.1 AA standards 😊

CI/CD

Reports and snapshots included on each PR ✔️

Continuously deployed to production using Vercel 🚀

📌 Notices

With thanks to the Worldhaven project, which makes this tool possible!

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

About

A web application to create and share character builds for the popular tabletop and digital game Gloomhaven

Topics

Resources

Stars

Watchers

Forks

Languages