Skip to content

Wizards of Lua — About

Wizards of Lua brings Lua programming to Minecraft, allowing server operators to run Lua scripts directly within the game. This Fabric-based rewrite of the original but outdated Forge mod provides enhanced control and flexibility for modders, server administrators, and advanced users.

Applications

  • Customize game mechanics to suit your server’s needs.
  • Implement custom server rules and behaviors.
  • Develop engaging mini-games within the Minecraft environment.

Examples

You can transform your Minecraft server with custom Lua scripts. Here are some possibilities:

Key Features

  • Run Lua Scripts In-Game: Use the /lua command followed by your script to execute Lua code directly in Minecraft.
  • Modify Minecraft: Place blocks, summon mobs, handle player events, and create new mechanics using an extensive Lua API.
  • Start Scripting Instantly: Jump straight into coding with Lua. No knowledge of Java or modding frameworks required.
  • Use External Script Files: Include Lua files stored in the config/wizards-of-lua folder and its subdirectories.
  • Code with Autocompletion: Edit scripts in Visual Studio Code with IntelliSense and full type support.
  • Live Script Updates: Modify your scripts while Minecraft is running. They’re recompiled automatically when used. No server restart necessary.
  • Create Instant or Long-Lasting Effects: Write quick scripts for immediate changes, or develop long-running programs that influence the Minecraft world over hours or days.
  • Trigger Scripts on Events: Automatically react to in-game events, such as players joining, breaking blocks, or swinging tools, using event-based scripting.
  • Define Dynamic Commands: Create custom Brigadier commands at runtime that invoke Lua code and support auto-completion. Define placeholders (e.g. %i, %player) to pass arguments to your Lua script.
  • Monitor and Manage Scripts: Use /wol spell list to view your running scripts and /wol spell break to stop them when needed.
  • Debug Easily in Real Time: Use print() or log() to send output directly to the console, chat, or log files. This makes it easy to debug your scripts while playing.
  • Access Dynamic Server Data (Optional): Use Placeholder API values in your scripts for advanced integration with other server plugins.
  • Use It Anywhere: Create and run scripts in both singleplayer and multiplayer modes.
  • No Client Mods Needed: Everything runs on the server. Players do not need to install anything.

Command Permissions

Wizards of Lua includes support for permission plugins like LuckPerms.
You can grant access to specific commands using defined permission nodes.

For a full list of permission nodes and required levels, see the Commands documentation.

Versioning

This project uses Semantic Versioning. A version number follows the format:

MAJOR.MINOR.PATCH

For example: 

1.4.2

  • You can safely update the mod if the MINOR or PATCH number increases.
  • If the MAJOR version number increases, consult the changelog because breaking changes may have been introduced, and your Lua scripts might need to be updated manually.

License and 3rd Party Licenses

  • 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-permission-api_LICENSE file for details.

Documentation

Download

All releases are available on Modrinth.