An open API service indexing awesome lists of open source software.

https://github.com/lualink/lualinkv2

A Spigot/Paper plugin which provides a Lua(JIT) scripting runtime.
https://github.com/lualink/lualinkv2

lua lua-scripting luajit minecraft minecraft-plugin paper-plugin papermc papermc-plugin spigot spigot-plugin spigot-resource

Last synced: 4 months ago
JSON representation

A Spigot/Paper plugin which provides a Lua(JIT) scripting runtime.

Awesome Lists containing this project

README

          

# LuaLink Plugin
modrinth
hangar
discord-plural

LuaLink is a plugin that provides a Lua scripting runtime for Paper-based Minecraft servers. It is designed for small and simple tasks and serves as an alternative to Skript however can do just about anything a typical Java plugin can do.

The scripting runtime is based on [LuaJava](https://github.com/gudzpoz/luajava) with LuaJIT.

## Features

- **High Performance**
LuaLink leverages LuaJava and LuaJIT, which are implemented primarily in C, ensuring fast and efficient execution.

- **User-Friendly API**
Simplifies scripting with an intuitive and easy-to-use API.

- **Simple Command Registration**
Register commands effortlessly with a single function. [Learn more](https://lualink.github.io/docs/getting-started/#commands).

- **Event Listening**
Listen to Bukkit, Spigot, Paper, or even custom plugin events. [Example here](https://lualink.github.io/docs/getting-started/#events).

- **Script Organization**
Split scripts into multiple files. Each script requires a ```main.lua``` entry point but can load additional files using Lua’s ```require``` function.

- **Java Library Integration**
Extend LuaLink’s capabilities by using any Java library—whether it’s for a Discord bot, HTTP server, or anything else you can imagine.

## Requirements

To use the LuaLink plugin, you need the following:

- A [Paper](https://papermc.io/) based Minecraft server.
- A basic understanding of Lua scripting.


## Documentation
Documentation and examples are available [here](https://lualink.github.io/docs).