addons.md

LuaLink Documentation

The project is in an experimental state, so is the documentation - expect things to change quite often.

For new Lua users, this community-contributed documentation may help you to get started.

Navigation

• Home
• External Libraries/API
• Addons
  • Home
  • Usage Example
  • Existing Addons
  • Creating Addon
• Reference

Addons

Addons extend Lua scripting capabilities by adding custom variables and functions.

Usage Example

Addons are distributed as .jar files and should be placed inside your server's plugins directory.

-- Getting addon instance.
local MiniPlaceholders = addons.get("MiniPlaceholders")

-- Retrieving global placeholders,
local globalPlaceholders = MiniPlaceholders.getGlobalPlaceHolders()

In this example, we are getting instance of MiniPlaceholders addon provided by LuaLink-MiniPlaceholders, and using it to retrieve global placeholders. Of course, different addons serve different purposes, some may expose plugins' API, while others may add utility functions.

Existing Addons

List of both official and community-made addons. Please refer to their respective documentation to learn how to interact with them.

• LuaLink-MiniPlaceholders - allows to use MiniPlaceholders' placeholders within LuaLink scripts.
• LuaLink-PlaceholderAPI - allows to use PlaceholderAPI placeholders within LuaLink scripts.
• LuaLink-Vault - allows to interact with Vault plugin.

Creating Addon

Not documented yet. You can use this addon template to get started.