- Go 76%
- JavaScript 7.9%
- HTML 7%
- Python 6.8%
- CSS 2.1%
- Other 0.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| cmd | ||
| deploy | ||
| dev | ||
| docs | ||
| internal | ||
| scripts | ||
| .dockerignore | ||
| .gitignore | ||
| compose.yaml | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| README.md | ||
LibreMC
LibreMC hosts Minecraft Java servers for LibreTalk users. A user chooses a server name, Minecraft version, server implementation, and hardware tier, then manages the server and its whitelist through the web dashboard. Trellis holds the application state and identity. Kubernetes runs Minecraft and stores the active worlds.
Development
Prerequisites are Go 1.26+, Docker Compose, access to the Trellis development image, and a dedicated Kubernetes development cluster reachable from the app container. Kubernetes 1.34 or newer is required for transfer Job replacement semantics. Use a scoped kubeconfig for the disposable cluster and its API address as seen from the container. Install the workload namespace and MinecraftRoute CRD in that fixture.
Review the Minecraft EULA, then set
LIBREMC_MINECRAFT_EULA=true when you accept it for the development runtime.
Set LIBREMC_DEV_KUBECONFIG to the absolute path of the fixture kubeconfig and
run docker compose up --build. Visit http://libremc.localhost:8080. The
gateway's /_dev/ page switches between John, Anna and an administrator.
TRELLIS_DEV_IMAGE can select a locally built image from the Trellis checkout
if the Forgejo registry requires credentials. The default Compose
configuration omits archive Jobs and imports. Use the separate transfer-role
and world workflow tests to exercise archive operations locally.
For CI and source-based fixtures without Docker, see verification commands. The main binary listens on port 3000 and uses the same port and Trellis contract in every environment.
Production
Use the deployment guide and raw manifests. The routing contract describes the mcprox controller. A Minecraft address is reserved immediately and becomes usable only when mcprox has installed the route and the backend is ready.
The version picker covers Minecraft Java 1.18 through 26.3. It offers Vanilla and compatible builds of Paper, Purpur, Fabric, Forge, and NeoForge. An administrator can enable compatible Quilt and Spigot builds. The catalog contains stable releases and fixes the compatible Java runtime for each game version. A server keeps the selection saved when it was created.
Every Minecraft server uses offline mode and a mandatory whitelist. A player can impersonate an allowed Minecraft username. LibreTalk-only requires a signed-in LibreTalk account to associate a whitelist entry. It does not authenticate Minecraft connections.
Architecture · Implementation status · MIT license
Design
LibreMC uses the amethyst palette, with periwinkle accents on warm stone and
charcoal. It uses the LibreTalk design system’s components and shared light
and dark preference. Logos, icons, and other platform assets load from the
same-origin /lt/ publication. The official light and dark PNG logos are
from Trellis’s branding release. Trellis branding assets