Modding docs
Make your own mods for Eaglercraft 26.2 and 26.3. Write them in Lua right inside the game, or in Rust, Go and other languages.
Mods let you change how Eaglercraft looks and works. You can draw your own HUD, add commands and keybinds, build menus, change the title screen and even draw shapes in the 3D world. The mod system is called Zeus, and it is built into Eaglercraft 26.2 and 26.3.
You do not need to install anything to start. Mods are written in Lua, a small language that is easy to pick up, and the game has its own code editor. Open the Mods menu, write a few lines, press save, and your mod is running.
A whole mod in five lines
-- name: Hello HUD
-- version: 1.0.0
hud.add(function(ctx)
ctx:text("Hello, " .. player.name(), 4, 4, "#55FF55")
end)
That is a complete mod. It writes a green hello with your name in the top left corner of the screen. Your first mod shows you how to run it.
What you can build
- A HUD with your FPS, coordinates, a clock or anything else you want on screen
- Your own commands, like
/wpor/stats - Keybinds, settings pages and full menus
- Changes to the built-in screens, like new buttons on the title screen
- Markers, beams and shapes drawn in the world with WebGL
- Mods that share data and functions with other mods
What you need
- Eaglercraft 26.2 or 26.3. The 1.8 and 1.12 clients do not support mods. Play 26.3 to get started.
- A singleplayer world. Mods only run in singleplayer, and they pause when you join a server. How mods run explains why.
- Nothing else for Lua. If you want to write mods in Rust, Go or another language, you also need that language's compiler (see WebAssembly mods).
How to use these docs
The pages are in order. If you are new, start with Your first mod. It takes about five minutes. Then read Install and share and How mods run so you know the rules.
After that, jump to whatever you want to build. Every page in Build a mod covers one part of the game. When you just need to look something up, the API reference has every function on one page.
Stuck on something? Ask in the Eaglercraft Discord. The Troubleshooting page also covers the most common problems.
Get started
Make a mod from a template, change it in the game's code editor, run it and fix it when it breaks. It takes about five minutes.
Install mods from a file, pasted code, a share code or a link, keep them up to date, and share your own.
When mods load and pause, how errors are handled, the limits every mod has, and which parts of Lua you can use.
Build a mod
Run your code when something happens in the game, after a delay, or over and over.
Draw text, boxes, lines, images and items on the screen with the drawing context, ctx.
Add your own panels to the HUD, and hide, wrap or replace the parts the game draws.
Add buttons to the game's own screens, or build full menus of your own with buttons, toggles, sliders, text boxes and lists.
Add your own chat commands and keybinds, read the keyboard and mouse, send chat and play sounds.
Give players settings they can change, save your own data between sessions, and use files, JSON, the clipboard and the internet.
Turn a single Lua file into a full mod package with metadata, an icon, more files, dependencies and permissions.
Draw your own shapes in the 3D world, or over the finished frame, with the browser's WebGL 2 API.
WebAssembly
Write mods in Rust, Go, C, Zig or any other language that compiles to WebAssembly, with the same API as Lua.
Build a Zeus mod in Rust with the zeus crate, compile it to WebAssembly and package it.
Build a Zeus mod in Go 1.24 or newer, compile it to WebAssembly and package it.
The low level interface between the game and a WebAssembly mod, for anyone writing a mod or bindings in a new language.
Reference
Every library and function in the Zeus mod API on one page, with what each one takes and what it gives back.
Complete mods you can paste straight into the game, from a HUD panel to waypoints, keystrokes, a notes menu and a calculator.
Fixes for the most common modding problems, from a missing Mods button to lost data, errors and broken downloads.



