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.

Anzeige

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 /wp or /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.

Get started

Build a mod

WebAssembly

Reference