@hearthforge/plugin-minecraft
v0.2.1
Published
The Minecraft game plugin for HearthForge — vanilla, Paper, Fabric, Forge and modpacks
Maintainers
Readme
@hearthforge/plugin-minecraft
The Minecraft (Java Edition) game plugin for HearthForge. It runs each server on the itzg/minecraft-server image and teaches the panel everything game-specific about it: the compose stack (with the Java runtime matched to the Minecraft version), health probes and crash analysis — including naming an incompatible mod — console commands and live player data over RCON, whitelist and player actions (op, and more), backup and restore of the world, modpack installs from Modrinth and CurseForge with update tracking, the optional world map module (BlueMap, served into the panel through a sandboxed relay), and the plugin's own UI: creation-wizard pickers for versions and modpacks, dashboard widgets and the world-map page.
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 Minecraft 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
| | |
|---|---|
| Edition | Minecraft Java Edition 1.x (Bedrock is not supported) |
| Server types | Vanilla, Paper, Purpur, Spigot, Bukkit, Fabric, Forge, NeoForge, Quilt — or a Modrinth / CurseForge modpack, which pins its own loader and version |
| Java runtime | chosen per version: Java 8 up to 1.16, Java 17 up to 1.20.4, Java 21 from 1.20.5 |
| HearthForge host | hearthforge.sdk ^0.1.0, host UI API 1 — the panel refuses to load the plugin outside them |
CurseForge modpacks need a CurseForge API key, set once in the panel's global settings.
Peer dependencies
The panel provides every one of them: @hearthforge/plugin-sdk, @hearthforge/shared, @hearthforge/ui, @hearthforge/forms, react, react-dom, @tanstack/react-query, i18next, react-i18next and lucide-react. 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 itzg/minecraft-server image it runs is Apache-2.0; Minecraft itself is Mojang's, and the server downloads it under the Minecraft EULA the operator accepts.
Links
- Repository: hearthforge/plugin-minecraft
- HearthForge core: hearthforge/hearthforge
- Contributing: CLA.md (required for every contribution)
- Writing a plugin: plugin-authoring guide
