Skip to content

Lua <3 Spigot - Write quick and dirty scripts to your server using Lua

License

Notifications You must be signed in to change notification settings

xeno-fi/lulbaite

Repository files navigation

GitHub GitHub top language GitHub release (release name instead of tag name)

📕 Documentation       ⬇️ Download      ❗ Issues

Lulbaite is a Spigot/Paper scripting plugin. Using Lulbaite, you can write Lua scripts to add functionality to your server.

Disclaimer: Java and Spigot API knowledge is required. This plugin is not a beginner-friendly scripting plugin. Basically Lulbaite just lets you write regular Java plugin functionality, except that you write Lua with LuaJ.

If you need something easy and fun, check out Skript, Denizen or even data packs.

Features

  • ⚡️ Lightning fast LuaJ
  • ⛏️ Convenience methods for fast and useful scripting
    • Event listeners
    • Command registration
    • Scheduler
    • HTTP requests (async and sync)
  • ♻️ Fast reloading - no need to restart your server when programming

Installation

  1. Download the latest release
  2. Place the .jar file into your plugins folder
  3. Restart your server
  4. Now you will be ready for some scripting!

Writing a script

  1. Create a script file, place it into plugins/XLulbaite/scripts/
  2. Add your script file name into plugins/XLulbaite/scripts.toml
  3. Run /xscript reload

Find more in the documentation.


License

Lulbaite is licensed under the MIT license.


Contributing

Pull requests are welcome. However, the purpose of this plugin is to act as a quick and dirty way to script a simple feature or to automate something, instead of trying to be a full-blown plugin framework.

If that's what you need, please check out Lukkit instead!