cuihairu/kode

English | 中文
> Kode (KBEngine Development Environment) - A VS Code development assistant extension for KBEngine
## Introduction
Kode is a VS Code extension that provides language support, navigation, and helper panels for the KBEngine game server framework.
KBEngine is an open-source MMO game server framework built on a distributed architecture. Kode targets KBEngine's entity definition (.def) files and provides syntax highlighting, completion, hover information, navigation, and diagnostics, along with panels for entity browsing, server control, logs, monitoring, and the dependency graph, plus a code generator.
## Daily Builds
The repository automatically builds from main every day and publishes a rolling release to the nightly tag on Releases: each build replaces the previous release's assets and notes (including build time, commit, and an asset table). The tag stays nightly; versioned releases (v0.1.0–v0.1.3) are cut manually from the released 0.1.x line. The scheduled build skips automatically for that day when the default branch has no new commits within 48 hours. The build pipeline lives in .github/workflows/daily-build.yml.
| Asset | Platform | Install |
| kode-nightly.vsix | Windows / macOS / Linux (universal for VS Code ≥1.82) | Download and run code --install-extension kode-nightly.vsix |
> Published on the VS Code Marketplace: cuihairu.kode-kbengine
## Testing Scope
CI and local development split into three paths by what changed — editing one line of docs should not trigger a full compile.
1. Docs changes (.md, docs/, images): no compile. The main CI
workflow's paths-ignore already skips these paths.
2. Code changes: run only the touched subset, not the whole suite.
pnpm test -- --testPathPatterns=
3. Full run (pnpm test): triggered only by package.json / pnpm-lock.yaml,
.github/, Docker/Compose config changes, or before a release.
## Core Features
### Syntax Highlighting
[Syntax highlighting for .def files]
[Source-backed semantic highlighting for primitives/containers/detail values]
[Highlighting for container types (ARRAY, FIXEDDICT, TUPLE)]
[Source-backed Flags / DetailLevel highlighting]
### IntelliSense
[Type auto-completion]
[Flags suggestions]
[DetailLevel suggestions]
[XML tag suggestions]
[Hook method completion (36 hooks, each with its KBEngine source call-site location)]
### Code Snippets
[11 common .def templates + 4 Python hot-reload templates (snippets/kbengine-python.json) + 2 types.xml type-alias templates (ARRAY uses the engine's syntax; engine-unregistered types such as BOOL/TUPLE have been removed)]
[One-click insertion of property definitions]
[Quick generation of method definitions]
[Snippet generation from the selection (Generate Snippet from Selection, merged into .vscode/kbengine-custom.code-snippets)]
### Hover Documentation
[Detailed type descriptions]
[Explanations of Flags usage]
[Usage recommendations]
[Hook documentation (invocation timing, function signatures, usage examples, source locations)]
### Go to Definition
[Navigate from entities.xml to .def files]
[Quick location of entity definitions]
[Def references (Shift+F12) across defs, including self-property access, receiver RPC calls and unsaved buffers]