Brodgar client

A Haven & Hearth client, forked from dolda2000/hafen-client, documented here.

• AddOns — a Lua addon system.
• Multi-session — log in several characters and control them at once.
• Proximity voice chat — voice chat with the players near you.

How to play

1. Download the launcher for your system; it brings its own Java: Windows · macOS (Apple Silicon) · Linux (x64).
2. Start it. Windows: unzip it anywhere and run run.bat. macOS: open the disk image and drag Brodgar launcher to Applications, then open it from there; it is not signed by Apple, so the first time macOS refuses it — open System Settings, Privacy & Security, and press Open Anyway, once. Linux: unzip it anywhere and run run.sh (a right click, Run as a Program); from then on it is in your applications menu. The launcher installs the client and keeps it at the newest release, on the Release or the Beta channel — pick either from its dropdown.
3. Log in. With the Steam client running, the login screen’s Log in with Steam button logs in the Haven & Hearth account your Steam account is linked to (linking is on the game’s website, under Account security). The password box beside it is the native login, as ever. On macOS the client cannot load Steam yet: log in with the password.

Documentation

The documentation is organized into two distinct sections:

• AddOns: Developer documentation for creating client addons in Lua. Covers the hafen.* API, manifest configuration, UI creation, event handling, and examples.
• Client Internals: Technical reference for the underlying Java client engine, subsystems, rendering pipeline, and architecture.
• Changelog: What each version changed, for players and for addon authors.

Creating Addons

• Getting Started: Build your first addon in 5 minutes.
• Addon Guides: Step-by-step guides for UI, world interaction, events, timers, data persistence, and permissions.
• API Reference: Complete reference for all hafen.* namespaces, methods, parameters, and events.
• Manifest Specification: Configuration reference for manifest.json.
• Runtime & Sandbox: Execution environment, watchdog limits, lifecycle hooks, and console commands.

Modifying the Client

• Architecture Overview: Subsystem map of the Java client codebase.
• Render Pipeline: OpenGL rendering architecture.
• State Management: Engine state tracking and synchronization.

[!WARNING] This documentation has been entirely generated using artificial intelligence. While efforts have been made to provide accurate and useful information, it may contain inaccuracies, omissions, or outdated information.

If you notice anything that is incorrect, unclear, or missing, please feel free to open an issue or submit a pull request with a correction.

Community contributions and corrections are always welcome!

This site is open source. Improve this page.