/DesyncedLLSAddon

Desynced Lua documentation for use with Lua Language Server for VSCode.

Primary LanguageLua

Desynced Lua Language Server Addon

This documentation covers the Lua API for Desynced and is to be used with Sumneko's Lua Language Server, using LuaCATS annotation system.

Setup

VS Code

Follow the following steps to get started with this Addon.

  1. Open (or download and install Visual Studio Code).
  2. Install the Lua Language Server's Visual Studio Code extension.
  3. Clone this repo.
  4. Open the mods folder of Desynced with Visual Studio Code.
  5. Inside the mods folder of Desynced, create a new folder called .vscode if it doesn't exist.
  6. Inside of the .vscode directory, create a file called settings.json
  7. Paste the following json into this file, and replace Lua.workspace.library with the path this repo has been cloned to.
{
    "Lua.runtime.version": "Lua 5.4",
    "Lua.workspace.checkThirdParty": false,
    "Lua.workspace.library": [
        "path\\to\\DesyncedLLSAddon\\library"
    ]
}