Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/lDEVinux/eaglercraft/llms.txt

Use this file to discover all available pages before exploring further.

Eaglercraft is a browser-based port of Minecraft 1.5.2 compiled from Java to JavaScript using TeaVM. It runs entirely in a standard web browser — including school Chromebooks — with no plugins or native installs required. It supports full singleplayer gameplay, multiplayer servers via WebSocket proxying, and peer-to-peer LAN worlds over WebRTC.

Quick Start

Play instantly in your browser or download the offline client in minutes.

Singleplayer

Create worlds, save progress in your browser, and import/export EPK files.

Multiplayer

Connect to public servers or set up your own with Bukkit and EaglercraftBungee.

LAN Worlds

Share your singleplayer world with friends over the internet using WebRTC relays.

What is Eaglercraft?

Eaglercraft uses TeaVM to compile the Minecraft 1.5.2 Java codebase into JavaScript, which runs inside a <canvas> element in any modern browser. The client communicates with standard Minecraft 1.5.2 Bukkit servers through EaglercraftBungee — a modified BungeeCord proxy that accepts WebSocket connections and translates them to the raw TCP protocol Bukkit expects.

Host a Server

Set up Bukkit + EaglercraftBungee to run your own Eaglercraft server.

Host a Client

Deploy the web client to your own domain with a custom server list.

LAN Relay Setup

Run your own WebSocket relay for hosting LAN worlds.

Plugin Development

Extend EaglercraftBungee with standard BungeeCord plugins and Eaglercraft-specific events.

Key Features

Browser Native

No downloads, no plugins. Runs in Chrome, Firefox, Safari, and Chromebook browsers.

Singleplayer Worlds

Worlds are saved in browser local storage and can be exported as portable EPK files.

True Multiplayer

EaglercraftBungee bridges WebSocket clients to standard 1.5.2 Bukkit servers.

LAN Over Internet

WebRTC P2P connections let you share your world with anyone, not just local Wi-Fi.

Custom Resource Packs

Build and deploy custom EPK asset packs to reskin your hosted client.

Plugin API

Full BungeeCord plugin API plus Eaglercraft-specific events for MOTD and queries.

Self-Hosting Overview

1

Run the Bukkit server

Download stable-download.zip and launch java/bukkit_command/run.bat (or run_unix.sh on Linux/macOS) to start the Minecraft 1.5.2 backend.
2

Run EaglercraftBungee

Launch java/bungee_command/run.bat (or run_unix.sh) to start the WebSocket proxy. This is what browser clients connect to.
3

Deploy the web client

Upload the contents of stable-download/web/ to any HTTP(S) server. Players open the URL in their browser and connect via Direct Connect.
4

Configure and extend

Edit config.yml to set your MOTD, manage server lists, enable authentication, and tune rate limiting. Add BungeeCord plugins to the plugins/ directory.
The web client will not work when opened from file:/// in a browser. It must be served over HTTP or HTTPS. See Hosting the Client for details.

Build docs developers (and LLMs) love