Wizards of Lua

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

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

Examples

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

• Mini-Games: Construct games such as King of the Hill, Capture the Flag, or Journey.
• Land Claiming: Implement a system allowing players to claim specific areas for personal building.
• Aggressive Bees: Create a new breed of bees that attack players on sight.
• Safe Zones: Establish areas where player-versus-player combat is disabled.
• Magic Wand: Develop a wand that summons lightning bolts targeting hostile mobs.
• Vertical Minecart: Design a minecart capable of ascending and descending vertically using ladders.

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.
• 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.
• Trigger Scripts on Events: Automatically react to in-game events, such as players joining, breaking blocks, or swinging tools, using event-based scripting.
• 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-MCVERSION

For example:

4.0.2-1.21.11

The part before the - follows Semantic Versioning and determines compatibility with your Lua scripts. The part after the - indicates the Minecraft version the mod was built for.

• 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.

Documentation

For detailed documentation and ready-to-use examples, please refer to the documentation pages.

Quick Start Video

To get started quickly, watch the quick start guide on YouTube.