Workshop VS Code Extension

Overview

The Workshop VS Code Extension provides first-class tooling for developing with BrickLua in BrickVerse projects, streamlining scripting workflows inside the BrickVerse workshop.

Features

This extension includes a Language Server Protocol (LSP) implementation that enables:

• Intelligent autocompletion for BrickLua and engine APIs
• Document formatting for BrickLua scripts
• Syntax highlighting tailored to BrickLua
• Real-time diagnostics and error reporting
• Inline type hints and validation feedback
• Go-to definition, hover info, and symbol navigation
• Improved overall developer experience and productivity

About BrickLua

BrickLua is a customized extension of Lua 5.4 (powered by LuaJIT 0.6.1) built specifically for Brick Engine, the runtime powering the brickverse.gg platform. It enhances standard Lua with additional systems and tooling designed for scalable game development.

Build

Install dependencies and compile:

npm install
npm run compile

VSIX Packaging

Create a local installable VSIX package:

npm run package:vsix

Create a pre-release VSIX package:

npm run package:vsix:pre

Generated VSIX files are created in the repository root.

Generated Language Artifacts

The following files are generated and should not be edited directly:

• syntaxes/bricklua.tmLanguage.json
• language-configuration.json

Generation sources:

• resources/default-lua-api.json
• resources/default-engine-api.json
• resources/default-engine-docs.json
• syntaxes/bricklua.tmLanguage.base.json
• language-configuration.base.json

Engine API split:

• default-engine-api.json is intended to be generated by Engine CI/CD.
• default-engine-docs.json is human-maintained hover/docs metadata merged at runtime.

Note: language/snippet/resource contribution files are kept at the extension package root (not src/) because VS Code loads contribution paths from the packaged extension root.

Regenerate language artifacts manually:

npm run generate:language

See CONTRIBUTING.md for full contributor workflow.