Skip to content

Commit 0046c70

Browse files
committed
docs(Plugin-Integration):对齐了表格格式并调整了列宽
docs(Client-Engine-Integration):添加了新的客户端引擎集成文档 docs(README):更新了版本号、依赖版本和功能描述 docs(CLAUDE):更新了架构概览和文档资源
1 parent c71f311 commit 0046c70

File tree

4 files changed

+319
-77
lines changed

4 files changed

+319
-77
lines changed

CLAUDE.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
1919

2020
## 架构概览
2121

22-
Orryx 是一个 Minecraft 技能插件,支持 1.12-1.21 版本,基于 Kotlin 2.1.20 和 TabooLib 6.2 框架。
22+
Orryx 是一个 Minecraft 技能插件,支持 1.12-1.21 版本,基于 Kotlin 2.1.20 和 TabooLib 6.2.4 框架。
2323

2424
### 分层架构
2525

@@ -28,18 +28,23 @@ src/main/kotlin/org/gitee/orryx/
2828
├── api/ # 公开 API 层 - 对外暴露的接口、事件、碰撞系统
2929
├── core/ # 核心层 - 技能、职业、触发器、Kether脚本、选择器
3030
├── module/ # 功能模块 - 法力值、精力值、状态机、UI、经验
31-
├── compat/ # 兼容层 - 第三方插件集成(DragonCore、GermPlugin、MythicMobs等)
31+
├── compat/ # 兼容层 - 第三方插件集成
3232
├── dao/ # 数据层 - 缓存、存储、序列化
33-
└── command/ # 命令系统
33+
├── command/ # 命令系统
34+
└── utils/ # 工具类
3435
```
3536

37+
### 兼容插件
38+
39+
DragonCore、GermPlugin、ArcartX、MythicMobs、AstraXHero、AttributePlus、DungeonPlus、Nodens、PacketEvents、PlaceholderAPI、ProtocolLib
40+
3641
### 核心系统
3742

3843
- **技能系统** (`core/skill/`): 5种技能类型(被动、直接、指向性、蓄力、蓄力指向性)
39-
- **触发器系统** (`core/station/`): 90+ 触发器,处理 Bukkit 事件和第三方插件事件
44+
- **触发器系统** (`core/station/`): 100+ 触发器,处理 Bukkit 事件和第三方插件事件
4045
- **Kether 脚本** (`core/kether/`): 74 个动作文件,用于技能逻辑编写
41-
- **选择器系统** (`core/selector/`): 几何体范围选择(圆形、扇形、OBB、射线等
42-
- **碰撞系统** (`api/collider/`): 球体、胶囊体、AABB、OBB、射线碰撞检测
46+
- **选择器系统** (`core/selector/`): 几何体范围选择(圆形、扇形、环形、OBB、射线、视锥等
47+
- **碰撞系统** (`api/collider/`): 球体、胶囊体、AABB、OBB、射线、复合体碰撞检测
4348

4449
### API 入口
4550

@@ -48,7 +53,7 @@ val api = Orryx.api() // 获取 API 实例
4853
api.skillAPI.castSkill(player, "fireball", 5)
4954
```
5055

51-
主要 API 接口:`ISkillAPI``IJobAPI``IProfileAPI``IKeyAPI``ITaskAPI``ITimerAPI`
56+
主要 API 接口:`ISkillAPI``IJobAPI``IProfileAPI``IKeyAPI``ITaskAPI``ITimerAPI``IReloadAPI``IConsumptionValueAPI``IMiscAPI`
5257

5358
### 协程作用域
5459

@@ -69,13 +74,26 @@ api.skillAPI.castSkill(player, "fireball", 5)
6974

7075
运行时配置位于 `plugins/Orryx/`,模板在 `src/main/resources/`
7176
- `config.yml` - 主配置(数据库、UI端、缓存等)
77+
- `keys.yml` - 按键配置
78+
- `bloom.yml` - Bloom 泛光配置
79+
- `buffs.yml` - Buff 配置
80+
- `npc.yml` - NPC 配置
81+
- `selectors.yml` - 选择器配置
82+
- `state.yml` - 状态配置
7283
- `skills/` - 技能定义
7384
- `jobs/` - 职业定义
7485
- `stations/` - 中转站定义
75-
- `keys.yml` - 按键配置
86+
- `controllers/` - 控制器定义
87+
- `experiences/` - 经验配置
88+
- `status/` - 状态定义
89+
- `ui/` - UI 配置
90+
- `lang/` - 语言文件
91+
- `placeholders/` - 占位符配置
7692

7793
## 文档资源
7894

7995
- [飞书 Wiki](https://o0vvjwgpeju.feishu.cn/wiki/Syzzw7aQwixJ4YkXoOAcyYkfnOg)
8096
- [API 文档](docs/API.md)
81-
- [插件集成文档](docs/Plugin-Integration.md)
97+
- [OrryxMod 客户端协议文档](docs/Plugin-Integration.md)
98+
- [客户端引擎集成文档](docs/Client-Engine-Integration.md)
99+
- [实体字段文档](docs/EntityField.md)

README.md

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
**跨时代技能插件,支持实现复杂逻辑,为稳定高效而生**
88

9-
[![Version](https://img.shields.io/badge/version-1.31.68-blue?style=for-the-badge)](https://github.com/zhibeigg/Orryx/releases)
9+
[![Version](https://img.shields.io/badge/version-1.36.93-blue?style=for-the-badge)](https://github.com/zhibeigg/Orryx/releases)
1010
[![Minecraft](https://img.shields.io/badge/Minecraft-1.12--1.21-green?style=for-the-badge&logo=minecraft)](https://www.minecraft.net/)
11-
[![Kotlin](https://img.shields.io/badge/Kotlin-2.0.21-purple?style=for-the-badge&logo=kotlin)](https://kotlinlang.org/)
12-
[![TabooLib](https://img.shields.io/badge/TabooLib-6.2-orange?style=for-the-badge)](https://github.com/TabooLib/taboolib)
11+
[![Kotlin](https://img.shields.io/badge/Kotlin-2.1.20-purple?style=for-the-badge&logo=kotlin)](https://kotlinlang.org/)
12+
[![TabooLib](https://img.shields.io/badge/TabooLib-6.2.4-orange?style=for-the-badge)](https://github.com/TabooLib/taboolib)
1313

1414
[![Wiki](https://img.shields.io/badge/Wiki-开始使用-darkred?style=for-the-badge&logo=gitbook)](https://o0vvjwgpeju.feishu.cn/wiki/Syzzw7aQwixJ4YkXoOAcyYkfnOg)
1515
[![Ask DeepWiki](https://img.shields.io/badge/DeepWiki-Ask_AI-00D4AA?style=for-the-badge)](https://deepwiki.com/zhibeigg/Orryx)
@@ -66,23 +66,18 @@
6666

6767
### 脚本引擎
6868

69-
**Kether 脚本** - 40+ 内置动作
69+
**Kether 脚本** - 74 个内置动作
7070
- 基础:延迟、同步、条件判断、流程控制
7171
- 技能:冷却管理、法力/精力操作、伤害计算
7272
- 效果:粒子特效、动画、音效
7373
- 数学:矩阵变换、四元数、向量运算
7474
- 选择器:几何体范围选择、目标筛选
7575
- 射线:光线追踪、碰撞检测
7676

77-
**Kotlin 脚本 (KTS)** - 热重载支持
78-
- 脚本编译缓存
79-
- 文件监视自动重载
80-
- 完整 Kotlin 语法支持
81-
82-
### 触发器系统 (80+)
77+
### 触发器系统 (100+)
8378

8479
<details>
85-
<summary><b>Bukkit 原生事件 (40+)</b></summary>
80+
<summary><b>Bukkit 原生事件 (44)</b></summary>
8681

8782
- 玩家加入/退出/踢出
8883
- 玩家伤害(前/后)
@@ -96,7 +91,7 @@
9691
</details>
9792

9893
<details>
99-
<summary><b>Orryx 事件 (15+)</b></summary>
94+
<summary><b>Orryx 事件 (28)</b></summary>
10095

10196
- 技能:释放、检查、冷却增加/减少/设置
10297
- 法力值:增加、减少、恢复、治疗、上升、下降
@@ -115,6 +110,7 @@
115110

116111
- **DragonCore**:DragonEntity 加入/离开、缓存加载、按键、数据包、槽位
117112
- **GermPlugin**:客户端连接、按键事件
113+
- **ArcartX**:按键(按下/释放/简单/组合)、鼠标点击、自定义数据包、实体加入/离开、客户端通道
118114
- **DungeonPlus**:副本开始/结束/离开
119115

120116
</details>
@@ -132,7 +128,7 @@
132128
| Frustum | 视锥体 |
133129
| Floor | 地板范围 |
134130

135-
**目标流筛选**:Self、Origin、Direct、Offset、Type、Teammate、Team、PVP、Amount、Server、World
131+
**目标流筛选**:Self、Origin、Direct、Offset、Type、Teammate、Team、PVP、Amount、Server、World、Current、Joiner
136132

137133
### 碰撞系统
138134

@@ -157,6 +153,7 @@
157153
| **Bukkit** | 原生 UI 界面 |
158154
| **GermPlugin** | HUD、动画、UI |
159155
| **DragonCore** | 自定义 UI、物品 |
156+
| **ArcartX** | UI、脚本、变量 |
160157

161158
### 伤害系统
162159

@@ -166,23 +163,22 @@
166163

167164
## 第三方插件集成
168165

169-
| 插件 | 功能 |
170-
|---------------------|------------------|
171-
| **Nodens** | 自定义系统扩展 |
172-
| **DungeonPlus** | 副本系统集成 |
173-
| **AttributePlus** | 属性系统 |
174-
| **AstraXHero** | 英雄系统 |
175-
| **MythicMobs** | 怪物管理、机制、条件、目标选择器 |
176-
| **DragonArmourers** | 模型系统 |
177-
| **DragonCore** | UI、自定义物品、动画、数据包 |
178-
| **GermPlugin** | UI、HUD、动画、按键 |
179-
| **CloudPick** | 镐子系统 |
180-
| **OriginAttribute** | 属性系统 |
181-
| **packetevents** | 数据包处理 |
182-
| **ProtocolLib** | 数据包处理 |
183-
| **PlaceholderAPI** | 变量占位符 |
184-
| **GlowAPI** | 发光效果 |
185-
| **Adyeshach** | NPC 系统 |
166+
| 插件 | 功能 |
167+
|---------------------|---------------------------|
168+
| **ArcartX** | UI、动画、模型、音效、Glimmer 脚本集成 |
169+
| **Nodens** | 属性系统、伤害处理器、治疗处理器 |
170+
| **DungeonPlus** | 副本系统集成、条件检查 |
171+
| **AttributePlus** | 属性系统 |
172+
| **AstraXHero** | 英雄属性系统、战斗数据 |
173+
| **MythicMobs** | 怪物管理、机制、条件、目标选择器 |
174+
| **DragonCore** | UI、动画、时装、粒子、模型、数据包 |
175+
| **GermPlugin** | UI、HUD、动画、时装、特效、按键 |
176+
| **CloudPick** | 时装、粒子、动画、音乐、GUI、HUD、模型、槽位 |
177+
| **GDDTitle** | 龙核 HUD 标题 |
178+
| **packetevents** | FOV 数据包处理 |
179+
| **ProtocolLib** | FOV 数据包处理 |
180+
| **PlaceholderAPI** | 变量占位符 |
181+
| **Adyeshach** | NPC 虚拟实体系统 |
186182

187183
---
188184

@@ -215,35 +211,40 @@ Orryx/
215211
├── core/ # 核心模块
216212
│ ├── skill/ # 技能系统
217213
│ ├── job/ # 职业系统
218-
│ ├── station/ # 触发器系统 (80+)
219-
│ ├── kether/ # Kether 脚本引擎 (40+ 动作)
220-
│ ├── kts/ # Kotlin 脚本系统
214+
│ ├── station/ # 触发器系统 (100+)
215+
│ ├── kether/ # Kether 脚本引擎 (74 个动作)
221216
│ ├── selector/ # 选择器系统
222217
│ ├── damage/ # 伤害系统
223218
│ └── common/timer/ # 冷却时间系统
224219
├── module/ # 功能模块
225220
│ ├── mana/ # 法力值
226221
│ ├── spirit/ # 精力值
227222
│ ├── state/ # 状态管理
228-
│ └── ui/ # UI 渲染 (Bukkit/Germ/Dragon)
229-
└── compat/ # 第三方插件兼容
223+
│ └── ui/ # UI 渲染 (Bukkit/Germ/Dragon/ArcartX)
224+
├── compat/ # 第三方插件兼容
225+
└── utils/ # 工具类
230226
```
231227

232228
### 配置文件
233229

234230
```
235231
plugins/Orryx/
236232
├── config.yml # 主配置
237-
├── skills/ # 技能定义
238-
├── jobs/ # 职业定义
239-
├── stations/ # 中转站定义
240233
├── keys.yml # 按键配置
234+
├── bloom.yml # Bloom 泛光配置
235+
├── buffs.yml # Buff 配置
236+
├── npc.yml # NPC 配置
241237
├── state.yml # 状态机配置
242238
├── selectors.yml # 选择器预设
239+
├── skills/ # 技能定义
240+
├── jobs/ # 职业定义
241+
├── stations/ # 中转站定义
242+
├── controllers/ # 控制器定义
243243
├── experiences/ # 经验算法
244+
├── status/ # 状态定义
244245
├── ui/ # UI 配置
245246
├── lang/ # 语言文件
246-
└── kts/ # Kotlin 脚本
247+
└── placeholders/ # 占位符配置
247248
```
248249

249250
---
@@ -271,7 +272,7 @@ repositories {
271272
}
272273

273274
dependencies {
274-
compileOnly("org.gitee.orryx:orryx:1.31.68:api")
275+
compileOnly("org.gitee.orryx:orryx:1.36.93:api")
275276
}
276277
```
277278

@@ -282,7 +283,7 @@ repositories {
282283
}
283284
284285
dependencies {
285-
compileOnly 'org.gitee.orryx:orryx:1.31.68:api'
286+
compileOnly 'org.gitee.orryx:orryx:1.36.93:api'
286287
}
287288
```
288289

@@ -321,6 +322,6 @@ dependencies {
321322

322323
<div align="center">
323324

324-
**Orryx** © 2024-2025
325+
**Orryx** © 2024-2026
325326

326327
</div>

0 commit comments

Comments
 (0)