Allow anonymous analytics?

Our cookieless analytics show us which features get used and store nothing on your device. We never sell your data or use it for advertising.

Privacy choices

Choose what ModDex may collect. You can change this anytime from Privacy choices in the footer.

Read the full privacy policy

Strictly necessary Required for the site to work: login sessions, security tokens, and abuse prevention. Always on and cannot be disabled. Always on
Analytics Cookieless analytics through PostHog's EU servers, used only to see which features get used. Nothing is stored on your device, and the anonymous visitor ID resets every day. Needs your consent because usage data goes to a third party. Never used for advertising or profiling. Off by default in the EU and UK.

MLua

Quick rating

Community listing page, reviews may not be monitored by the author.

How listings work Are you the author?

MLua

By EncDataOwner

No reviews yet

Pure Java Lua-style scripting library mod for Minecraft.

Mod Loaders
Minecraft
Shockbyte server hosting: 35% off your first server with code MODDEX35 (opens in a new tab)

About

Description

MLua

MLua lets you write Minecraft mod scripts in Lua. Scripts can interact with the game through APIs for players, worlds, events, commands, UI, and registered content.

Scripts

During development, place scripts in:

run/mlua/scripts/

Mods can bundle scripts in their JAR at:

assets/<modid>/mlua/scripts/

It will recognizes these script types:

*.mixin.lua      mixin scripts
*.registry.lua   registry scripts
*.commands.lua   command scripts
*.server.lua     server scripts
*.client.lua     client scripts
*.lua            module scripts

API reference

MLua would generate its documentation in the Minecraft client. Open run/mlua/docs/index.html after launching the game. It shows you the APIs available in that build.

Example

local Players = Minecraft:GetService("Players")
local World = Minecraft:GetService("World")

Players.PlayerAdded:Connect(function(player)
    player:SendMessage("Hello from MLua!")
    player:SetGameMode(GameMode.Creative)
end)

World:SetWeather(Weather.Clear)

Using MLua from another mod

Include MLua with your mod and declare it as a dependency.