Mcraftr markCRAFTR
Open docs navigation

Mcraftr Docs

The fast path to understanding Mcraftr.

Everything you need to learn the product, choose a setup path, and jump into the right GitHub docs.

Open DemoBrowse GitHub Docs

Features

The core surfaces

Mcraftr is built to help you run the Minecraft server you already have, not replace your entire stack.

Operations surfaces

Dashboard

See server status, player count, TPS, weather, and key actions at a glance.

Players

Inspect live players, view vitals and inventory, and handle moderation faster.

Actions

Run common admin actions for time, weather, kits, teleporting, and more.

Worlds

Unlock world-aware workflows when running the full Mcraftr stack.

Admin + customization

Terminal

Use raw RCON directly when you want full manual control.

Admin

Manage policies, schedules, audit history, users, and server controls.

Chat

Live chat history, broadcasts, and panel-based messages without needing to camp in the game client or logs.

Settings

Theme packs, accent colors, fonts, sound effects, background music, avatars, and saved-server preferences.

Modes

Choose the setup that fits your server

Both modes start with a working RCON connection. Quick Connect is the real baseline. Full Stack adds optional Relay and Beacon enhancements for the richer integrated experience.

Fastest setup

Quick Connect

Core Mcraftr over plain RCON

  • +Works with plain RCON and no extra integration layer
  • +Best for getting started quickly and for most self-hosters
  • +Still gives you the real baseline Mcraftr experience

Recommended experience

Full Mcraftr Stack

Adds optional Relay and Beacon enhancements

  • +Adds richer world-aware workflows and deeper server context
  • +Unlocks structures, entities, maps, previews, and richer terminal help
  • +Best when you intentionally have Relay and Beacon available

Install

Start with Docker Compose

Start with the installer. It generates your `.env`, sets up the runtime, and gets you into Quick Connect without making you assemble the environment by hand first.

Quick start

  1. 1Clone the repo and run `./install.sh`
  2. 2Choose local, private-network, LAN, or public-domain mode
  3. 3Sign in with the admin account created by the installer
  4. 4Start with Quick Connect, then add Relay and Beacon only if you want the richer Full Stack experience
chmod +x install.sh
./install.sh
# open the URL the installer prints

Required runtime shape

  • a Mcraftr app runtime or container
  • Redis
  • persistent storage mounted to `/app/data`
  • internal app port `3050` exposed through your chosen entrypoint
  • a reachable Minecraft RCON endpoint
enable-rcon=true
rcon.port=25575
rcon.password=your-secure-password

Core env vars

NEXTAUTH_SECRETNEXTAUTH_URLMCRAFTR_ADMIN_USERMCRAFTR_ADMIN_PASSMCRAFTR_ENC_KEYREDIS_URL

Optional Full Stack values include Relay and Beacon wiring such as `MCRAFTR_BEACON_TOKEN`, `MCRAFTR_MINECRAFT_DATA`, `MCRAFTR_SCHEMATICS_DIR`, `MCRAFTR_ENTITY_PRESET_DIR`, `MCRAFTR_BLUEMAP_URL`, and `MCRAFTR_DYNMAP_URL`.

More repo docs

Install guideCore vs enhancementsConfiguration docs.env example

Extras

Deploy

Installer-first local/private-network/public-domain paths plus grouped alternative platform notes.

Core and extensions

Read how Quick Connect, Relay, and Beacon fit together without confusing core product behavior and optional enhancements.

FAQ

Quick answers with the full docs nearby

This page gives you the short version. GitHub has the deeper write-up when you need it.

Live demo notes in READMERequirements in READMERuntime requirements in install guide
What is Mcraftr?
Mcraftr is a self-hosted Minecraft admin panel built for fast server management over RCON.
Do I need to change hosts?
No. Mcraftr is built to work with the server you already run.
Quick Connect or Full Stack?
Use Quick Connect for the real baseline product over plain RCON. Use Full Stack when you intentionally want the optional Relay and Beacon enhancements too.
What does it need?
At minimum, a reachable RCON endpoint. Relay and Beacon are optional enhancement layers for richer workflows and read-only world context.
Can I try it first?
Yes. Open the demo to explore the interface before installing.

Need the full source docs?

Go straight to GitHub for the complete documentation and source.

Open GitHub RepoCoffee