# CustomScreenMenu 插件文档
> 一个高性能、完全可定制的游戏内菜单插件，适用于现代 Minecraft 服务器。
> 内置原生 Folia 支持。
> 如有任何错误报告或建议，请加入 [官方 Discord](https://discord.gg/YpZNACup)。
> 开源版本不提供技术支持。购买或捐赠是鼓励作者继续开发，并获得插件支持和帮助的好方法。
---
## 核心功能
- **面向未来**: 在最新 Minecraft 版本上稳定运行，与 Folia 兼容。
- **命令驱动**: 使用单个命令即可打开或关闭任何屏幕。
- **情景模式友好**: 玩家首次加入时自动显示个人开始菜单。
- **3-D 项目展示**: 悬停、可旋转的持有物品模型。
- **可扩展**: 与 ItemsAdder、betterhud 等无缝集成。
---
## 命令
| 命令 | 描述 |
|---|---|
| `/cursormenu run ` | 使用给定的名称打开自定义菜单。 |
| `/cursormenu stop` | 立即关闭当前活动菜单。 |
| `/cursormenu items ` | 在手中显示物品的 3-D 模型。 |
| `/cursormenu itemsstop` | 结束当前 3-D 项目预览。 |
| `/cursormenu reload` | 重新加载所有配置文件的内容（编辑后必需）。 |
---
## 亮点
- **360° 相机环绕** 菜单或项目。
- **登录触发**: 决定菜单是否应该在每次登录时自动打开。
- **3-D 模型设置**: 自定义模型数据、旋转开关、发光开关。
- **文本放置**: 任何屏幕文本的精确 X、Y、Z 偏移量和倾斜角度。
- **即时传送**: 玩家进入菜单时传送至指定位置。
- …以及更多可配置的选项。
---
PlaceholderAPI：
%cursormenu_current_menu% – 当前打开的菜单名称
%cursormenu_selected_option% – 当前突出显示的选项名称
%cursormenu_display_item_id% – 当前显示的物品 ID
%cursormenu_clicked_option% – 刚刚点击的文本布局组件的键
%cursormenu_menu_world% – 菜单所在的区域
%cursormenu_button_x% – 所选按钮的 X 坐标
%cursormenu_button_y% – 所选按钮的 Y 坐标
%cursormenu_button_z% – 所选按钮的 Z 坐标
%cursormenu_is_attacking_or_breaking% – 确定玩家是否正在攻击并破坏方块，如果为真则为是，如果为假则为否
---
## 集成
| 插件 | 附加功能 |
|---|---|
| **ItemsAdder** | 悬浮 3-D 模型、实时附魔和描述显示、自定义物品面板。 |
| **betterhud** | 将菜单元素直接渲染到玩家 HUD 上，以获得无缝外观。 |
---
## 演示视频
- [演示 1 – 菜单交互](https://screenapp.io/app/#/shared/FE9dc_W2KS)
- [演示 2 – 3-D 项目可视化](https://screenapp.io/app/#/shared/kDub6qt8tW)
- [演示 3 – 高级菜单设计](https://screenapp.io/app/#/shared/kpuJv5S5rO)
# CustomScreenMenu 插件文档