This repository contains a Language Server Protocol implementation for the ExplorerScript language and IDE integration plugins.
- On-the-fly error checking
- Syntax highlighting
- Auto-complete
- Hover hints
- Document symbol provider (e.g. "Outline" in VS Code)
- Workspace symbol provider (global symbol search, Ctrl/Cmd+T in VS Code)
- Go to definition (Ctrl/Cmd click to jump to a symbol)
- Signature help (show macro/operation signatures while typing)
- Reads actor, object and performer data from ROM
- Download the latest VS Code extension release (.vsix file).
- Open the "Extensions" tab in the primary sidebar and click the "…" button > Install from VSIX....
- Select your downloaded .vsix file and click Install.
- Proceed with "Project Setup" below.
In order to use ExplorerScript language features in JetBrains IDEs, you will need to install syntax highlighting support and the language server plug-in separately.
- Download the source code of the latest release as a .zip file.
- Unpack the .zip file into a folder.
- Open the Settings dialog by pressing Ctrl+Alt+S on Windows/Linux or Cmd+, on macOS.
- Click Editor > TextMate Bundles.
- Click the "+" button and select the downloaded folder. A new item
explorerscript-vscode-extension
should now be visible at the end of the list. - Click Ok to save and quit the Settings dialog. ExplorerScript files (
.exps
) should now have syntax highlighting.
TBD
- Open a project containing ExplorerScript files (e.g. a
.skytemple
folder) and open any ExplorerScript (.exps
) file. - Configure the path to your ROM in settings. The path can either be absolute or relative to the workspace directory (
{workspace folder}/rom.nds
is used by default).- In VS Code, navigate to File > Preferences > Settings (or Code > Settings > Settings on macOS), then configure the ROM path under Extensions > ExplorerScript > Rom Path. You can use the Workspace tab to configure a path specific to your current workspace.