{"id":50791435,"url":"https://github.com/cuihairu/kode","last_synced_at":"2026-06-12T11:30:28.318Z","repository":{"id":346719035,"uuid":"1191285270","full_name":"cuihairu/kode","owner":"cuihairu","description":"KBEngine Development Environment","archived":false,"fork":false,"pushed_at":"2026-04-24T03:47:19.000Z","size":533,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-24T05:33:03.194Z","etag":null,"topics":["kbengine"],"latest_commit_sha":null,"homepage":"https://cuihairu.github.io/kode/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cuihairu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-25T05:01:45.000Z","updated_at":"2026-04-24T03:47:23.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/cuihairu/kode","commit_stats":null,"previous_names":["cuihairu/kode"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cuihairu/kode","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuihairu%2Fkode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuihairu%2Fkode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuihairu%2Fkode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuihairu%2Fkode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cuihairu","download_url":"https://codeload.github.com/cuihairu/kode/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuihairu%2Fkode/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34243051,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-12T02:00:06.859Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kbengine"],"created_at":"2026-06-12T11:30:27.121Z","updated_at":"2026-06-12T11:30:28.312Z","avatar_url":"https://github.com/cuihairu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kode - KBEngine Development Environment\n\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)\n[![VS Code](https://img.shields.io/badge/VS_Code-1.50.0+-blue.svg)](https://code.visualstudio.com/)\n[![TypeScript](https://img.shields.io/badge/TypeScript-4.x-blue.svg)](https://www.typescriptlang.org/)\n\n\u003e **Kode** (KBEngine IDE) - 面向 KBEngine 的 VS Code 开发辅助扩展\n\n## 📖 简介\n\n**Kode** 是一个为 [KBEngine](https://github.com/kbengine/kbengine) 游戏服务器框架提供语言支持、导航和辅助面板的 VSCode 扩展。\n\nKBEngine 是一个开源的 MMO 游戏服务器框架，采用独特的分布式架构。Kode 为 KBEngine 的实体定义（`.def`）文件提供专业的开发工具支持。\n\n## ✨ 核心功能\n\n### 🎨 语法高亮\n- ✅ 完整的 `.def` 文件语法高亮\n- ✅ 源码对齐的基础/容器/细节语义高亮\n- ✅ 容器类型（ARRAY, FIXED_DICT, TUPLE）高亮\n- ✅ 源码对齐的 Flags / DetailLevel 高亮\n\n### 💡 智能提示 (IntelliSense)\n- ✅ 类型自动补全\n- ✅ Flags 智能提示\n- ✅ DetailLevel 提示\n- ✅ XML 标签提示\n- ✅ **钩子方法自动补全 (30+ hooks)**\n\n### 📝 代码片段\n- ✅ 17 个常用代码模板\n- ✅ 一键插入属性定义\n- ✅ 快速生成方法定义\n\n### 📚 悬停文档\n- ✅ 类型详细说明\n- ✅ Flags 用途解释\n- ✅ 使用建议\n- ✅ **钩子完整文档** (调用时机、函数签名、使用示例、源码位置)\n\n### 🔍 跳转定义\n- ✅ 从 `entities.xml` 跳转到 `.def` 文件\n- ✅ 快速定位实体定义\n\n### ✅ 语法检查\n- ✅ 实时语法验证\n- ✅ 源码可证实的 Flags / DetailLevel / 必填字段校验\n- ✅ 类型有效性检查\n\n### 🌲 实体浏览器\n- ✅ 侧边栏显示所有实体\n- ✅ 实体类型标识（Cell/Base/Client）\n- ✅ 快速导航\n\n### 🔗 钩子系统 (Hooks System)\n- ✅ 30+ KBEngine 钩子支持\n- ✅ 12 个分类：生命周期、网络、数据库、移动、空间、视野、位置、传送、陷阱、Cell、脚本、系统\n- ✅ 完整的钩子文档和使用示例\n- ✅ 源码位置标注\n\n### 🔥 热更新支持\n- ✅ 热更新代码片段（4个）\n- ✅ KBEngine.reloadScript() 智能提示\n- ✅ importlib.reload() Python 脚本热更新\n- ✅ 重载相关悬停文档和使用示例\n\n### 🖥️ 服务器管理\n- ✅ 10个组件启动/停止控制\n- ✅ 实时状态显示（停止/启动中/运行中）\n- ✅ 进程 PID 显示\n- ✅ 组件独立日志输出\n- ✅ 状态栏显示运行数量\n- ✅ 支持自定义路径和环境变量\n\n### 📊 日志查看集成\n- ✅ logger 连接入口与状态说明\n- ✅ WebView 可视化界面\n- ✅ 多级过滤（级别、组件、关键词）\n- ✅ 正则表达式搜索\n- ✅ 日志导出（txt/log/json 格式）\n- ✅ 彩色日志级别显示\n\n当前 logger 协议适配尚未完成，扩展会明确提示该能力暂不支持，而不是假装已经接通官方协议。\n\n### 🐛 嵌入式 Python 调试支持\n- ✅ 自定义调试配置（.kbengine/debug.json）\n- ✅ 组件特定调试设置\n- ✅ 自动生成 launch.json\n- ✅ 通过 telnet 提示引导开启调试\n- ✅ 按 PID 附加到 KBEngine 组件进程\n- ✅ 路径映射配置\n\n### 📈 监控面板\n- ✅ 基于 machine + watcher 的运行态监控\n- ✅ CPU、内存、实体数量与已核实 watcher 指标展示\n- ✅ 系统概览卡片\n- ✅ 组件详细指标卡片\n- ✅ 可视化图表（柱状图、曲线图）\n- ✅ 数据导出（JSON 格式）\n\n监控数据依赖 `machine` 发现和 `watcher` 查询共同提供。若 watcher 无响应，面板只保留 machine 返回的基础状态，不再把缺失的 watcher 指标伪装成完整遥测。\n\n### 🔗 Python ↔ Def 双向跳转\n- ✅ 实体定义映射管理器\n- ✅ 从生成的 Python 文件跳转回 .def 定义\n- ✅ Python 文件智能提示（自动补全属性和方法）\n- ✅ 自动扫描和建立映射关系\n- ✅ 支持多个 Python 生成路径配置\n\n### 📊 实体依赖关系图\n- ✅ 自动分析实体继承关系\n- ✅ 可视化实体依赖图（使用 Mermaid.js）\n- ✅ 显示 Base/Cell/Client 实体类型\n- ✅ 统计信息面板（实体数量、最大深度、最常引用实体）\n- ✅ 从图跳转到实体定义文件\n- ✅ 支持导出图表（PNG/SVG 格式）\n\n### 🛠️ 代码生成器\n- ✅ 实体创建向导（逐步引导）\n- ✅ 5 个预定义模板（账号、角色、NPC、物品、空实体）\n- ✅ 自动生成 .def 文件（符合 KBEngine 格式）\n- ✅ 自动生成 Python 文件（包含钩子方法）\n- ✅ 自动在 entities.xml 中注册实体\n- ✅ 支持自定义属性和方法定义\n- ✅ 可配置输出路径和选项\n\n## 🚀 安装\n\n### 从 VSCode Marketplace 安装\n\n```bash\ncode --install-extension cuihairu.kode\n```\n\n或在 VSCode 中搜索 `Kode - KBEngine Development Environment`\n\n### 手动安装\n\n```bash\n# 克隆仓库\ngit clone https://github.com/cuihairu/kode.git\n\n# 安装依赖\ncd kode\npnpm install\n\n# 编译\npnpm run compile\n\n# 打包\npnpm run package\n\n# 安装\ncode --install-extension kode-0.1.0.vsix\n```\n\n## 📘 文档\n\n- 配置与使用文档位于 [docs/](./docs/)\n- 配置说明重点见 [docs/guide/configuration.md](./docs/guide/configuration.md)\n- 本项目已添加 VitePress 文档站点，可通过 `pnpm run docs:dev` 本地预览\n\n## 🔖 版本策略\n\n当前阶段默认沿用 `0.1.x` 作为修复与完善版本线。\n\n- 修复问题、补充文档、增强现有功能：继续使用 `0.1.x`\n- 只有在出现明确的新阶段功能升级时，才考虑提升到 `0.2.0`\n\n## 📸 截图\n\n### 语法高亮和智能提示\n截图素材尚未整理完成。当前可通过 `F5` 启动扩展开发主机，在 `.def` 文件中直接预览语法高亮、智能提示、悬停文档与诊断效果。\n\n### 实体浏览器\n实体浏览器与服务器控制面板的界面截图将随文档资源一并补充；现阶段建议结合 [docs/](./docs/) 中的功能说明和本地调试窗口进行验证。\n\n## 🛠️ 开发\n\n### 环境要求\n\n- Node.js `^20.19.0 || \u003e=22.12.0`（推荐直接使用 `.nvmrc` 中的版本）\n- Git\n- VSCode 1.50.0 或更高版本\n\n### 开发步骤\n\n```bash\n# 1. 克隆仓库\ngit clone git@github.com:cuihairu/kode.git\n\n# 2. 安装依赖\ncd kode\npnpm install\n\n# 3. 在 VSCode 中打开项目\ncode .\n\n# 4. 按 F5 启动调试\n# 会打开一个新的 VSCode 窗口（扩展开发主机）\n\n# 5. 在新窗口中测试功能\n```\n\n### 项目结构\n\n```\nkode/\n├── src/\n│   ├── extension.ts              # 主入口文件\n│   ├── languageProviders.ts      # 语言能力\n│   ├── explorerProviders.ts      # 树视图与导航\n│   ├── kbengineMetadata.ts       # KBEngine 元数据\n│   └── ...\n├── syntaxes/\n│   └── kbengine.tmLanguage.json  # 语法高亮规则\n├── snippets/\n│   └── kbengine.json             # 代码片段\n├── resources/\n│   └── docs/                     # 项目文档\n├── .vscode/\n│   └── launch.json               # 调试配置\n├── package.json                  # 扩展配置\n├── tsconfig.json                 # TypeScript 配置\n└── README.md                     # 本文件\n```\n\n### 测试\n\n```bash\n# 运行测试\npnpm test\n\n# 编译\npnpm run compile\n\n# 监听模式编译\npnpm run watch\n\n# 文档\npnpm run docs:dev\n```\n\n## 📖 使用文档\n\n详细的使用文档和开发指南，请查看：\n\n- [VitePress 文档](./docs/) - 新版文档入口\n- [设计文档](./resources/docs/vscode-extension-design.md) - 完整的设计方案\n- [快速开始](./resources/docs/vscode-extension-summary.md) - 开发者指南\n- [命名方案](./resources/docs/plugin-name-suggestions.md) - 品牌设计\n\n## 🤝 贡献\n\n欢迎贡献代码！请查看 [CONTRIBUTING.md](./CONTRIBUTING.md) 了解详情。\n\n### 贡献指南\n\n1. Fork 本仓库\n2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)\n3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)\n4. 推送到分支 (`git push origin feature/AmazingFeature`)\n5. 开启 Pull Request\n\n## 📝 许可证\n\n本项目采用 Apache-2.0 许可证 - 详见 [LICENSE](LICENSE) 文件\n\n## 🙏 致谢\n\n- [KBEngine](https://github.com/kbengine/kbengine) - 优秀的游戏服务器框架\n- [VS Code](https://github.com/microsoft/vscode) - 强大的代码编辑器\n- 所有贡献者\n\n## 📞 联系方式\n\n- GitHub Issues: [https://github.com/cuihairu/kode/issues](https://github.com/cuihairu/kode/issues)\n- Email: cuihairu@gmail.com\n\n## 🌟 Star History\n\n如果这个项目对你有帮助，请给一个 Star ⭐\n\n---\n\n**Kode** - 让 KBEngine 开发更高效！ 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcuihairu%2Fkode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcuihairu%2Fkode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcuihairu%2Fkode/lists"}