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.

EaglercraftBungee is a fork of BungeeCord that adds WebSocket transport, enabling browser-based Eaglercraft clients to connect to a Minecraft server. It translates the WebSocket handshake into raw TCP that Bukkit understands, acting as the public-facing entry point for all player connections. Vanilla BungeeCord does not support WebSockets and will not work — you must use the EaglercraftBungee JAR included in the stable-download package. Make sure your Bukkit backend is already running before starting EaglercraftBungee.

​
Starting EaglercraftBungee

1

Navigate to java/bungee_command/

In the extracted stable-download.zip folder, open the java/bungee_command/ subdirectory. This contains the EaglercraftBungee JAR, startup scripts, config.yml, and the plugins/ directory.
2

Start the proxy

Run the startup script for your operating system:
run.bat
A second terminal window will open showing the EaglercraftBungee startup log.
Keep both the Bukkit and EaglercraftBungee terminal windows open at the same time. Closing either one will disconnect all players. Minimize them rather than closing them.

​
Verifying the Connection

Once both processes are running:
  1. Open any Eaglercraft client (e.g. https://g.deev.is/eaglercraft/)
  2. Click Multiplayer from the main menu
  3. Select Direct Connect
  4. Enter 127.0.0.1:25565 and click Join Server
You should connect successfully and spawn in the world. If you see an error, check both terminal windows for stack traces or connection refused messages.

​
Adding Bungee Plugins

Place BungeeCord-compatible JAR files into the java/bungee_command/plugins/ directory. Plugins are loaded on the next restart of EaglercraftBungee. Standard BungeeCord plugins work alongside Eaglercraft-specific ones. For plugin development, add bungee-dist.jar (found in java/bungee_command/) to your Java IDE’s build path and develop it like a regular BungeeCord plugin.

​
Configuration

Key fields in java/bungee_command/config.yml:
FieldDescription
hostThe address EaglercraftBungee binds to for incoming WebSocket connections. Default: 0.0.0.0:25565.
websocketMust be true. This is what distinguishes EaglercraftBungee from vanilla BungeeCord.
default_serverThe name of the Bukkit backend server to route players to by default (matches a key under servers:).
force_default_serverWhen true, players are always sent to the default server on join rather than their last known server.
motd1 / motd2Server description shown in the multiplayer list. Supports & color codes. Add motd2 for a second line.
max_playersMaximum number of concurrent connections shown in the server list.
servers.lobby.addressThe TCP address of the Bukkit backend. Default: localhost:25569.
Here is the relevant portion of the default config.yml:
config.yml
listeners:
- host: 0.0.0.0:25565
  websocket: true
  default_server: lobby
  force_default_server: true
  motd1: '&6An Eaglercraft server'
  max_players: 60
servers:
  lobby:
    address: localhost:25569
    restricted: false
For the full set of configuration options — including authentication, moderation, client bans, rate limiting, and MOTD customization — see the Configuration Reference.
If you want to use a domain name or enable TLS (wss://) for your server, set up an NGINX reverse proxy in front of EaglercraftBungee. This also unlocks IP-based bans and rate limiting, which require the real client IP to be forwarded. See the NGINX Reverse Proxy guide for setup instructions.

Build docs developers (and LLMs) love

Get started for freeTalk to us