# Auto Completion & IntelliSense

To enhance your development experience with LuaLink, it is recommended to set up auto completion with IntelliSense.

Getting this up and running is really simple. Choose your IDE and follow instructions below:


# 1. Install Lua Extension

Download and install sumneko Lua extension. You can do this manually, or use built-in extension manager if available.


# 2. Get LuaLink LLS Addon

Clone or download our addon. It contains Lua stubs for common Java and Bukkit types and enables auto-completion of class names.

Cloning is recommended so you can update it easily.

git clone https://github.com/LuaLink/lualink-lls-addon

Updating is as simple as executing git pull inside the cloned directory.

Note: Stubs are based on JDK 21 and latest Paper API snapshot. Repository is updated on daily basis so if recently added API is missing, just pull changes from remote or download and replace files manually.


# 3. Configure Lua Extension

The last step is to configure sumneko Lua extension to make it recognize and index downloaded Lua stubs, and use our runtime plugin.

  • Open the settings for the Lua extension.
  • Add a new entry to Lua.workspace.library and enter the path to your lualink-lls-addon folder.
  • Set Lua.runtime.plugin to lualink-lls-addon/plugin.lua.
    • This setting requires editing the settings.json for the extension directly.

Note: It should be possible to just add the lualink-lls-addon folder to Lua.workspace.userThirdParty and have the plugin load only for LuaLink scripts. We could never get this to work however. So if you figure it out - please open a new issue or join our Discord.

Not working? Join our Discord server and ask for help. We will do our best to help you set it up.