Skip to content

Basic auto completion docs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 25, 2025
Merged

Basic auto completion docs #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c960a2
Basic auto completion docs
Saturn745 May 25, 2025
ee7a858
rephrase and reformat
Grabsky May 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions autocompletion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
order: 92
icon: zap
---
# 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:

=== **Visual Studio Code**   |   **VSCodium**

<br>

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

{.list-icon}
- **Trusted Sources**
- [**:icon-link: VSCode Marketplace** (marketplace.visualstudio.com)](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
- [**:icon-link: Open VSX** (open-vsx.org)](https://open-vsx.org/extension/sumneko/lua)

---

#### 2. Get LuaLink LLS Addon
Clone or download [**our addon**](https://github.com/LuaLink/lualink-lls-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.
```bash
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](https://github.com/LuaLink/docs/issues) or [join our Discord](https://discord.gg/xYcjBKqkDz).

===

**Not working?** [Join our Discord server](https://discord.gg/xYcjBKqkDz) and ask for help. We will do our best to help you set it up.

<!-- Add more IDE instructions below as needed -->