Skip to main content
GLuaLS works without any configuration. Change settings only when you need to, such as turning off a warning or picking a formatting style. Project settings are stored in a .gluarc.json file in your project folder. Commit it so everyone working on the project gets the same results.

Settings panel

The settings panel edits .gluarc.json for you, so you never have to write JSON.
The GLua Settings panel with the Format category open
Open it in any of these ways:
  • Click GLuaLS in the status bar and choose Open GLuaLS Settings
  • Run GLuaLS: Open GLuaLS Settings from the Command Palette (Ctrl+Shift+P)
  • Right-click a .gluarc.json file in the Explorer
In a multi-root workspace, you choose which folder to configure. Click Save to write your changes, or turn on Auto-save settings at the top of the panel.

Edit .gluarc.json directly

You can also edit the file by hand. Add only the settings you want to change and leave everything else out, so you keep the defaults:
.gluarc.json
The $schema line gives you completion and descriptions for every setting while you type. To create the file, right-click your project folder and choose Create GLuaLS Settings.
If a project has .gluarc.json, GLuaLS uses only that file. Without it, GLuaLS reads .luarc.json, .emmyrc.json or .emmyrc.lua, in that order, so existing configs from other Lua tools keep working.

Settings in several folders

In a multi-root workspace, each folder is analysed with its own settings. They start from the defaults and change only the keys the folder’s own config file sets, so a folder with no config file uses the defaults, and one folder’s config never reaches another folder’s files. This holds for every setting, including Garry’s Mod settings such as gmod.fileParamDefaults, whichever order the folders come in. The Garry’s Mod folder’s addons and gamemodes layer on the folder’s config the same way (see Opening a whole Garry’s Mod folder). A few settings are read once for the whole workspace, so they add up across the folders: the file extensions, require patterns, require-like functions and non-standard symbols under runtime, and the libraries, ignores and roots under workspace and resource.

Settings by section

Garry's Mod

Realms, scripted classes, hooks, net messages and VGUI

Diagnostics

Turn warnings on or off and change how they show

Formatting

Presets, style options and external formatters

Workspace

Libraries, ignored files and multi-root projects

Completion

Snippets and automatic require lines

Hints and hover

Inlay hints, hover, code lens and highlighting

Runtime and strict mode

Syntax, require handling and stricter type checks

Garry's Mod annotations

How the Garry’s Mod annotations are downloaded

VS Code settings

A few options only exist as VS Code settings, such as the debugger and annotation download options. Open VS Code Settings and search for gluals to see them. Many .gluarc.json options also have a matching gluals.* VS Code setting. These are handy for personal preferences, such as turning off inlay hints. When both are set, the VS Code setting wins. Use .gluarc.json for anything the whole project should share.