NWScript Language Server

Language server for NWScript, the scripting language used by Neverwinter Nights: Enhanced Edition. Provides IDE features for .nss files in VS Code.

Features

• Completions -- all symbols across your workspace with auto-import, plus local variables and parameters (sorted by relevance)
• Go to Definition -- jump to function/constant/struct definitions (prefers implementations over forward declarations)
• Find References -- find all usages of a symbol across the workspace
• Rename Symbol -- rename functions, constants, and local variables across all files
• Hover -- type signatures, doc comments, and source file for functions, structs, constants, variables, and local variables/parameters
• Signature Help -- parameter hints as you type function calls
• Diagnostics -- real-time parser errors on keystroke, compiler errors on save (via nwn_script_comp)
• Unused Import Detection -- grayed-out #include directives that aren't referenced, with quick-fix removal
• Unused Variable Detection -- grayed-out local variables and parameters that are never used, with quick-fix removal
• Unused Function Detection -- grayed-out functions never referenced anywhere in the workspace, with quick-fix removal
• Refactoring: Extract Variable -- extract an expression to a local variable. Works with cursor position (place cursor on a function call) or selection. Infers the type automatically and triggers rename
• Refactoring: Extract Function -- select statements to extract into a new function. Detects variables from outer scopes and passes them as parameters. Works inside nested blocks (if/else-if/while/for)
• Refactoring: Extract to File -- move a function to a new file. Creates the file, adds #include, removes the function from the current file, and opens file rename in the explorer
• Auto-update includes on file rename -- renaming a .nss file (in explorer or via Extract to File) automatically updates all #include directives across the workspace
• Code Lens -- reference counts above functions, structs, and global variables/constants
• Document Links -- Ctrl+Click #include directives to open the resolved file
• Inlay Hints -- parameter name hints at call sites (e.g. nObjectType: 1, sTemplate: "goblin01")
• Workspace Symbol Search -- find any symbol across the workspace with Ctrl+T
• Document Symbols -- outline view of functions, structs, and constants
• Folding Ranges -- collapse functions, structs, control flow blocks, #include groups, and comment blocks
• Code Formatting -- full document, range, and on-type formatting with configurable style
• Semantic Highlighting -- AST-based highlighting for function calls, parameters, struct names, and field access
• Syntax Highlighting -- TextMate grammar for NWScript

Setup

1. Install the extension
2. Open a folder containing .nss files

The LSP automatically discovers source directories from nasher.cfg if present. If your project doesn't use Nasher, it indexes the workspace root.

Vanilla Scripts and Engine Built-ins

The LSP automatically finds your NWN:EE installation (via NWN_ROOT env var, Steam, Beamdog, or GOG) and extracts all vanilla .nss scripts from the game's KEY/BIF files. This means:

• #include "nw_i0_generic" and other vanilla includes resolve automatically
• Go-to-definition works on vanilla functions (opens the extracted source)
• nwscript.nss (engine built-in definitions) is included automatically
• Your workspace files always take priority over vanilla scripts

If auto-detection doesn't find your installation, set it explicitly:

"nwscriptLsp.nwnRoot": "C:/Program Files (x86)/Steam/steamapps/common/Neverwinter Nights"

If you don't need vanilla scripts and only want nwscript.nss (engine built-ins), you can disable the extraction for faster startup:

"nwscriptLsp.extractVanillaScripts": false

Compiler Diagnostics

For on-save compiler diagnostics, the extension needs nwn_script_comp (the NWN script compiler). It looks for a bundled copy next to the extension binary, then falls back to PATH. You can also set an explicit path:

"nwscriptLsp.compilerPath": "C:/path/to/nwn_script_comp.exe"

For best results with Nasher-based projects, run nasher compile at least once so the .nasher/cache/ directory exists -- the LSP compiles against this cache to avoid false positives.

Settings

All settings are under the nwscriptLsp namespace. Open Settings (Ctrl+,) and search for "nwscript" to see them in the UI, or click the links below to jump directly to each setting.

General

Inlay Hints

Formatter

The extension registers itself as the default formatter for NWScript and enables format-on-save automatically. To disable formatting entirely, add to your settings:

"[nwscript]": {
    "editor.formatOnSave": false,
    "editor.defaultFormatter": null
}

To enable format-on-type (auto-formats as you type }, ;, and Enter):

"[nwscript]": {
    "editor.formatOnType": true
}

Project Structure Support

The LSP works with any NWScript project layout:

• Nasher projects -- automatically reads nasher.cfg (in workspace root and immediate subdirectories) to discover source directories
• Multi-root workspaces -- scans all workspace folders
• Plain folders -- if no nasher.cfg is found, indexes the workspace root directly
• Extra include dirs -- use includeDirs to add directories outside the workspace (e.g., shared libraries)