[NOTE]
提示: 本项目依赖sumneko的LuaLS,必须先安装LuaLS,才能使用该插件,不支持EmmyLua插件
[!IMPORTANT]
系统限制: 仅支持 Windows 10(x64)、Windows 11 系统,MacOS/Linux 不要安装该插件!!!
🌟 核心特性 (Features)
- ✅ 全面智能补全:通用 API、枚举、自定义数据类型一键自动补全,提升编码效率。
- ✅ 节点树可视化预览:VS Code 原生查看 Ministudio 节点结构,支持快速复制节点名称与类型。
- ✅ 精准类型推断:原生识别 Ministudio 自定义数据类型,提供严格的类型匹配校验。
- ✅ 节点式编码支持:使用节点语法访问实例对象,支持 require 加载节点模块脚本。
🚀 快速开始 (Getting Started)
本插件提供强大的 Lua 智能补全与 类型推导 支持。以下是核心功能特性与开发推荐规范:
使用该插件需要将当前工作区设置为Ministudio项目文件夹,也就是MiniWorldStudioProjects下的文件夹,工作区目录必须有.project文件才能正常使用,且Ministudio必须处于活动状态。
1. 节点属性与方法补全 (Properties & Methods)
访问任何对象节点时,系统会自动推导类型并提供强类型补全提示:
-- 支持节点链查找实例
-- 输入game:和game:GetService("")都会有语法提示
-- 长链持久提示:game:GetService("Players").LocalPlayer也会有语法提示
local Players = game:GetService("Players")
local player = Players.LocalPlayer
-- 属性补全
player.Health = 100
player.MoveSpeed = 16
-- 方法补全
player:Move(Vector3.New(100,1,100))
2. 节点式require加载模块脚本 (ModuleScript)
require(ModuleScript),系统会自动查找对应的节点实例以及模块脚本所对应的实际文件夹路径:
-- 鼠标悬停在require内会提示真实路径
-- 输入UIModules.会触发语法提示
local HUDController = require(UIModules:WaitForChild("HUDController"))
HUDController:Show()
🛠️ 依赖组件 (Dependencies)
💡 下载与安装 (Install)
您可以选择通过 VS Code 插件市场 快速安装,或直接从 GitHub Releases 下载最新构建包。
⚠️ 注意:MiniStudio 客户端插件目前仅支持通过 GitHub Release 手动下载安装。
📦 途径一:VS Code 插件市场 (推荐)
最便捷的安装方式,支持一键安装与自动更新:
- 打开 VS Code,按快捷键
Ctrl + Shift + X 打开扩展市场。
- 在搜索框中输入
MinistudioHelper。
- 点击 Install (安装) 按钮即可完成配置。
📦 途径二:GitHub Releases 下载
适用于离线环境、需要特定版本或安装 MiniStudio 客户端插件:
| 组件名称 |
适合编辑器 / 客户端 |
下载入口 |
说明 |
| MinistudioHelper |
VS Code |
 |
核心VS code端 |
| Ministro |
MiniStudio Client |
 |
仅限 GitHub 下载 |
手动安装步骤 (VSIX)
- 前往对应的 Releases 页面 下载
.vsix 扩展安装包。
- 打开 VS Code,进入 扩展 (Extensions) 视图。
- 点击右上角
... 菜单,选择 从 VSIX 安装... (Install from VSIX...)。
- 选择下载好的包文件并确认安装,随后重启编辑器即可。
Ministudio 客户端插件安装步骤
- 前往
Ministudio在菜单栏->插件(Plugins)->资源(Assets)->导出场景节点(ExportSceneNodes),导出节点json格式到任意文件夹。
- 前往 Releases 页面 下载
.zip客户端插件。
- 将插件压缩包解压到场景节点目录/ServiceNodes/PluginsService下,如果没有就新建
PluginsService文件夹。
- 前往
Ministudio在菜单栏->插件(Plugins)->资源(Assets)->导入场景节点(ImportSceneNodes),按照提示重启studio即可完成插件安装。
⚠️ 注意:Ministudio插件仅支持单个项目独立安装,切换项目需要重新安装。