Wizards of Lua — About¶

Wizards of Lua is a server-side Fabric mod that runs Lua programs inside Minecraft. We call them spells. Cast a one-liner from the chat for an instant change, or start a long-running spell that reacts to everything happening in your world. No Java, no server restarts, no client mods.

local queue = spell:collect("PlayerJoinedEvent")
while true do
  local evt = queue:next()
  spell:execute("say Welcome, " .. evt.player.name .. "!")
end

A spell that greets every player who joins.

What You Can Do¶

Run Lua in-game: Cast spells with the /lua command, or load them from files in config/wizards-of-lua. Edited files are picked up automatically, so no restart is needed.
Change the world: Place blocks, summon mobs, edit items and entities, all through an extensive Lua API.
React to events: Respond when players join, break blocks or swing tools, and cancel those actions if you want.
Add your own commands: Register Brigadier commands at runtime, with typed arguments and auto-completion.
Code with autocompletion: Write spells in Visual Studio Code with full type support.
Stay in control: Spells run on a per-tick budget and yield automatically, so a busy spell doesn't freeze your server. Access is controlled by permission levels and nodes, compatible with LuckPerms. Use /wol spell list to see what's running and /wol spell break to stop it.
Install on the server only: Works in singleplayer and multiplayer. Players don't need to install anything.

What People Build¶

Safe zones where PvP is disabled
Minecarts that climb ladders
A magic wand that strikes hostile mobs with lightning
A magic hoe that harvests a whole wheat field with one swing
Mini-games like Journey

Get Started¶

Download the mod from Modrinth.
Watch the Quickstart Video.
Follow the Getting Started Guide.

Then explore the Examples, Commands, Dynamic Commands, FAQ and API Reference.

Questions or something to show? Join us on Discord.

Versioning¶

Versions follow the format MAJOR.MINOR.PATCH-MCVERSION, for example 5.1.0-1.21.11. The first part follows Semantic Versioning and describes compatibility with your scripts. The part after the - is the Minecraft version.

Updates that raise MINOR or PATCH are safe. If MAJOR increases, check the changelog first, because your scripts may need changes.

History¶

This mod is a complete rewrite for Fabric of the original Wizards of Lua for Forge, which is no longer maintained. The two APIs differ, and scripts written for the Forge version won't run unchanged. All documentation on this site refers to the Fabric version.

License¶

Wizards of Lua is released under the LGPL 3 license. See the LICENSE file for details.
Rembulan is released under the Apache License 2. See the Rembulan_LICENSE file for details.
fabric-permission-api is released under the MIT License. See the fabric-permissions-api_LICENSE file for details.