@hearthforge/plugin-azerothcore
v0.2.1
Published
The AzerothCore game plugin for HearthForge — a five-container WotLK realm, its modules and its UI
Maintainers
Readme
@hearthforge/plugin-azerothcore
The AzerothCore game plugin for HearthForge: World of Warcraft 3.3.5a (Wrath of the Lich King) realms, run as a five-container stack — MySQL, a one-shot client-data installer, a one-shot database import, authserver and worldserver. It teaches the panel everything game-specific about such a realm: the compose stack and its bootstrap, health probes and crash patterns, graceful shutdown over SOAP, backup and restore of the three game databases, SRP6 game accounts, live player, guild and account data, the optional Playerbots module, and the plugin's own UI — player and guild pages, account actions (create, reset password, ban, unban), dashboard widgets and a live world map.
This package is installed by the panel
It is not a library you call. A HearthForge panel loads it at startup from HEARTHFORGE_PLUGINS and registers it through its plugin registry; the operator then creates AzerothCore instances from the panel's UI. Its React UI is served into the panel and runs on the panel's own React, design system and i18n through the host share scope, so it is never mounted standalone.
To try it, follow HearthForge core's install guide, or run the dev stack in this repository ("Develop against a running panel" in the repository README).
Supported versions
| | |
|---|---|
| Game client | World of Warcraft 3.3.5a (build 12340) |
| Server | AzerothCore (azerothcore-wotlk), vanilla or with mod-playerbots, from the ghcr.io/hearthforge/ac-wotlk-* images this repository builds |
| Database | MySQL 8.0 |
| HearthForge host | hearthforge.sdk ^0.1.0, host UI API 1 — the panel refuses to load the plugin outside them |
Peer dependencies
The panel provides every one of them: @hearthforge/plugin-sdk, @hearthforge/shared, @hearthforge/ui, @hearthforge/forms, typeorm, react, react-dom, @tanstack/react-query, @tanstack/react-pacer, i18next, react-i18next, lucide-react and sonner. The exact ranges are in package.json.
Versioning
Pre-1.0: a minor release may change the instance config or require a newer panel; a patch never does. Maintenance lines publish from release/X.Y branches under the release-X.Y npm dist-tag and never move latest — see Maintenance releases. Every release is listed in the CHANGELOG.
License
AGPL-3.0-or-later. The AzerothCore server images it runs are GPL-2.0-or-later; their source offer is in the repository README.
Links
- Repository: hearthforge/plugin-azerothcore
- HearthForge core: hearthforge/hearthforge
- Contributing: CLA.md (required for every contribution)
- Writing a plugin: plugin-authoring guide
