迷你世界UGC3.0脚本开发的离线文档与VS Code助手。
本项目将官方开发者文档 https://dev-wiki.mini1.cn/ugc-wiki/ 整理成可快速检索的离线版本，并提供相应VS Code插件，帮助开发者直接获得自动补全、悬停说明和参数提示。
本项目与迷你世界官方不存在任何关联。文档内容的版权归官方所有，请以官网为准。
| 目录 | 内容 |
|---|---|
| wiki/ | 官方全部页面的Markdown副本，以及全部函数的API 索引、事件的事件索引、机器可读的wiki_index.json |
| extension/ | VS Code插件 |
| tools/ | 抓取官网、转换文档、生成并打包插件的脚本 |
| assets/ | 本文档用到的图片 |
输入Backpack:等全局模块名，可以补全该模块下的方法，鼠标停留可以查看说明、参数和官方示例；self:GetComponent("Move")之后接着补全移动组件的方法，Ctrl+Alt+D打开光标处函数的离线文档。完整功能见插件说明。
补全和悬停的功能需要先安装Lua 扩展（sumneko.lua）来实现，本插件负责提供API定义。
直接安装：从Releases下载.vsix，然后执行code --install-extension <文件名>.vsix。
自行构建并安装：
python tools/gen_extension.py
code --install-extension extension/dist/miniworld-ugc-wiki-<版本号>.vsix
构建只需要Python 3.8以上，不需要Node.js，也不需要联网。版本号是文档的抓取日期，运行结束时会打印安装包路径。
官网更新后，抓取一次即可同时更新文档和插件：
pip install -r requirements.txt
python tools/update_wiki.py
列出一个Lua项目调用了哪些官方接口，以及哪些在官方文档里查不到（可能是未公开接口）：
python tools/compare_usage.py <Lua代码目录>
本项目的代码（tools/和extension/的源文件）采用MIT许可证。
以下内容来自迷你世界官方，版权归官方所有，不在此许可范围内：wiki/、插件里由官方文档生成的类型定义和离线文档、提取自官方脚本的tools/event_values.json。