LuaCord

LuaCord is a plugin framework that allows you to create Minecraft plugins using Lua scripting with full access to the Spigot API.

It is designed to be lightweight, easy to learn, and fully compatible with modern Paper servers while maintaining backwards compatibility with Lukkit plugins.

---

Features

• Full Spigot API access (commands, events, permissions, players, worlds, etc.)
• Paper compatible
• Easy to learn (Lua is simpler than Java)
• Hot reload in development mode
• Backwards compatible with all Lukkit plugins

---

Installation

1. Download LuaCord
2. Place the JAR file into the /plugins/ directory
3. Add your .lkt plugins into /plugins/
4. Restart the server

---

Creating Plugins

Plugins can be distributed as .lkt files (ZIP archives) or as folders containing the following files:

• main.lua – plugin logic
• plugin.yml – plugin metadata
• config.yml – optional configuration

---

Example Plugin

plugin:onEnable(function()
    logger:info("Plugin enabled!")
end)

plugin:addCommand({
    name = "heal",
    description = "Heal yourself"
}, function(event)
    local player = event:getSender()
    player:setHealth(20)
    player:sendMessage("Healed!")
end)

plugin:registerEvent("PlayerJoinEvent", function(event)
    local player = event:getPlayer()
    player:sendMessage("Welcome!")
end)

---

plugin.yml Example

name: MyPlugin
version: 1.0
main: main.lua
author: YourName
description: My awesome plugin

---

Commands

• /lukkit plugins – List loaded plugins
• /lukkit dev reload <plugin> – Reload a development plugin
• /lukkit dev errors – View error logs

---

Configuration

debug-mode: false                     # Enable verbose logging
bypass-plugin-registration: true      # Paper compatibility mode
lua-debug: false                      # Lua debug globals

---

Requirements

• Spigot or Paper (any version)
• Java 8 or higher

---

Coming Soon

• JAR wrapper support for easier distribution
• Web-based JAR generator
• Extended API implementations

---

Links

• GitHub: https://github.com/TheGamingMahi/LuaCord
• Issues: https://github.com/TheGamingMahi/LuaCord/issues

---

License

GPL v3

---

Changelog

0.1.0-BETA

Initial LuaCord release.

Forked from Lukkit 2.2.0 (also by me) with major improvements.

Changes:

• Rewritten in Kotlin
• Clean console logging
• Package renamed to io.thegamingmahi.luacord
• Improved error handling

From Lukkit 2.2.0:

• Paper compatibility fixes
• Bypass mode for Paper restrictions
• Configurable loading modes

---

Compatibility

• Works with all Lukkit plugins
• Any Spigot/Paper version
• Java 8+

---

Known Issues

• Plugins do not appear in /plugins on Paper
  Use /lukkit plugins instead
• Hot reload only works for folder-based plugins