Skip to content

Commit 1c960a2

Browse files
committed
Basic auto completion docs
1 parent c0d3b9c commit 1c960a2

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

autocompletion.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
order: 92
3+
icon: zap
4+
---
5+
# Auto Completion & Intellisense
6+
7+
<details>
8+
<summary><strong>VSCode / VSCodium Setup</strong></summary>
9+
10+
If you want auto completion and intellisense for LuaLink scripts in VSCode (or VSCodium), follow these simple steps:
11+
12+
### 1. Install the Lua Extension
13+
14+
- Install the **sumneko Lua** extension:
15+
- [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
16+
- [Open VSX](https://open-vsx.org/extension/sumneko/lua)
17+
18+
### 2. Get the LuaLink LLS Addon
19+
20+
- Clone (recommended) or download [LuaLink/lualink-lls-addon](https://github.com/LuaLink/lualink-lls-addon)
21+
- Cloning is recommended so you can update it easily:
22+
```bash
23+
git clone https://github.com/LuaLink/lualink-lls-addon
24+
```
25+
26+
### 3. Configure the Extension
27+
28+
- Open the settings for the Lua extension.
29+
- Add a new entry to `Lua.workspace.library` and enter the path to your `lualink-lls-addon` folder.
30+
- Set `Lua.runtime.plugin` to `lualink-lls-addon/plugin.lua`.
31+
- This setting requires editing the `settings.json` for the extension directly.
32+
33+
#### Note
34+
35+
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, but in testing this didn't work. If you figure it out, please open an issue or join our Discord!
36+
37+
### Done!
38+
39+
If you did everything right, you should now get auto completion and intellisense for LuaLink in your Lua files. This should make developing scripts much easier!
40+
41+
</details>
42+
43+
<!-- Add more IDE instructions below as needed -->

0 commit comments

Comments
 (0)