Skip to content

Commit 5bb82e4

Browse files
zhibeiggzhibeigg
committed
docs(readme): 更新项目文档结构和功能描述
feat(readme): 添加技能系统详细分类和冷却时间操作说明 feat(readme): 扩展脚本引擎功能描述和触发器系统详情 feat(readme): 新增选择器系统和碰撞系统说明 feat(readme): 添加状态管理和伤害系统描述 feat(readme): 完善第三方插件集成列表和项目结构 feat(readme): 更新配置文件结构和数据存储信息 feat(readme): 添加ZRead AI文档资源链接
1 parent 80568d1 commit 5bb82e4

File tree

1 file changed

+217
-83
lines changed

1 file changed

+217
-83
lines changed

‎README.md‎

Lines changed: 217 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -14,100 +14,253 @@
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)
1616
[![Ask ZRead](https://img.shields.io/badge/ZRead-Ask_AI-00b0aa?style=for-the-badge)](https://zread.ai/zhibeigg/Orryx)
17+
1718
</div>
1819

1920
---
2021

21-
## 核心特性
22-
23-
<table>
24-
<tr>
25-
<td width="50%">
22+
## 特色功能
2623

2724
### 技能系统
28-
- 多触发方式（主动/被动/按键/事件）
29-
- 技能冷却、等级、经验管理
30-
- 技能组与职业绑定
3125

32-
</td>
33-
<td width="50%">
26+
| 技能类型 | 说明 |
27+
|--------------------------|-------------|
28+
| **被动技能 (Passive)** | 自动触发，无需手动释放 |
29+
| **直接释放 (Direct)** | 按键即释放 |
30+
| **直接指向性 (Direct Aim)** | 带指示器的指向性技能 |
31+
| **蓄力释放 (Pressing)** | 长按蓄力后释放 |
32+
| **蓄力指向性 (Pressing Aim)** | 蓄力型指向性技能 |
33+
34+
- 技能等级与经验管理
35+
- 技能点升级系统
36+
- 技能冷却管理
37+
- 技能升级前检测与成功执行钩子
38+
- 按键绑定系统（支持多键组合如 `G+F`）
39+
40+
### 冷却时间系统
41+
42+
| 操作 | 说明 |
43+
|-----------|---------------------------------------|
44+
| **重置冷却** | `cooldown reset` |
45+
| **增加冷却** | `cooldown add <tick>` - 延长倒计时 |
46+
| **减少冷却** | `cooldown take <tick>` - 缩短倒计时 |
47+
| **设置冷却** | `cooldown set <tick>` - 重设倒计时 |
48+
| **获取倒计时** | `cooldown get` / `cooldown countdown` |
49+
| **检测冷却** | `cooldown has` - 是否在冷却中 |
50+
51+
### 职业系统
52+
53+
- 职业绑定技能组
54+
- 职业等级与经验
55+
- 职业升级获取技能点
56+
- 职业最大法力值/精力值配置
57+
- 职业属性系统集成
58+
59+
### 资源管理
60+
61+
| 资源类型 | 功能 |
62+
|------------------|--------------------|
63+
| **法力值 (Mana)** | 给予/消耗/设置、充足检查、自然恢复 |
64+
| **精力值 (Spirit)** | 给予/消耗/设置、充足检查、自然恢复 |
65+
| **经验系统** | 自定义经验算法、升级配置 |
3466

3567
### 脚本引擎
36-
- Kether 表达式语言支持
37-
- Kotlin 脚本 (KTS) 热重载
38-
- 复杂逻辑轻松实现
3968

40-
</td>
41-
</tr>
42-
<tr>
43-
<td width="50%">
69+
**Kether 脚本** - 40+ 内置动作
70+
- 基础：延迟、同步、条件判断、流程控制
71+
- 技能：冷却管理、法力/精力操作、伤害计算
72+
- 效果：粒子特效、动画、音效
73+
- 数学：矩阵变换、四元数、向量运算
74+
- 选择器：几何体范围选择、目标筛选
75+
- 射线：光线追踪、碰撞检测
4476

45-
### 资源管理
46-
- 法力值 (Mana) 系统
47-
- 精力值 (Spirit) 系统
48-
- 完整经验与升级机制
77+
**Kotlin 脚本 (KTS)** - 热重载支持
78+
- 脚本编译缓存
79+
- 文件监视自动重载
80+
- 完整 Kotlin 语法支持
81+
82+
### 触发器系统 (80+)
83+
84+
<details>
85+
<summary><b>Bukkit 原生事件 (40+)</b></summary>
86+
87+
- 玩家加入/退出/踢出
88+
- 玩家伤害（前/后）
89+
- 玩家移动/跳跃
90+
- 物品操作（消耗、掉落、损坏、拾取）
91+
- 交互事件（实体、方块）
92+
- 聊天/命令
93+
- 等级/经验变化
94+
- 更多...
95+
96+
</details>
97+
98+
<details>
99+
<summary><b>Orryx 事件 (15+)</b></summary>
100+
101+
- 技能：释放、检查、冷却增加/减少/设置
102+
- 法力值：增加、减少、恢复、治疗、上升、下降
103+
- 精力值：增加、减少、恢复、治疗、上升、下降
104+
- 职业：更改（前/后）、清除
105+
- 等级：升级、降级
106+
- 经验：增加、减少
107+
- 技能点：增加、减少
108+
- 标志：玩家标志变更、全局标志变更
109+
- 按键：按下、抬起、持续
49110

50-
</td>
51-
<td width="50%">
111+
</details>
112+
113+
<details>
114+
<summary><b>第三方插件事件</b></summary>
115+
116+
- **DragonCore**：DragonEntity 加入/离开、缓存加载、按键、数据包、槽位
117+
- **GermPlugin**：客户端连接、按键事件
118+
- **DungeonPlus**：副本开始/结束/离开
119+
120+
</details>
121+
122+
### 选择器系统
123+
124+
| 几何体 | 说明 |
125+
|-------|------|
126+
| Range | 圆形范围 |
127+
| Sector | 扇形范围 |
128+
| Annular | 环形范围 |
129+
| AABB | 轴对齐包围盒 |
130+
| OBB | 有向包围盒 |
131+
| RayHit | 射线击中 |
132+
| Frustum | 视锥体 |
133+
| Floor | 地板范围 |
134+
135+
**目标流筛选**：Self、Origin、Direct、Offset、Type、Teammate、Team、PVP、Amount、Server、World
136+
137+
### 碰撞系统
138+
139+
- 球体碰撞 (Sphere)
140+
- 胶囊体 (Capsule)
141+
- 轴对齐包围盒 (AABB)
142+
- 有向包围盒 (OBB)
143+
- 射线 (Ray)
144+
- 复合体 (Composite)
145+
146+
### 状态管理
147+
148+
- 玩家状态机系统
149+
- 状态类型：眩晕、格挡、躲避、技能状态、普通攻击、蓄力攻击
150+
- 状态前置条件检查
151+
- 状态入场/退出钩子
52152

53153
### 多端 UI
54-
- Bukkit 原生 UI
55-
- GermPlugin 支持
56-
- DragonCore 支持
57154

58-
</td>
59-
</tr>
60-
</table>
155+
| 端 | 功能 |
156+
|----------------|-----------|
157+
| **Bukkit** | 原生 UI 界面 |
158+
| **GermPlugin** | HUD、动画、UI |
159+
| **DragonCore** | 自定义 UI、物品 |
160+
161+
### 伤害系统
162+
163+
伤害类型：物理、魔法、火焰、真伤、自伤、控制台、自定义
164+
165+
---
166+
167+
## 第三方插件集成
168+
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 系统 |
186+
187+
---
61188

62189
## 快速开始
63190

64191
### 安装
65192

66-
1. 下载 [最新版本](https://github.com/zhibeigg/Orryx/releases) 的 Orryx
67-
2. 将 JAR 文件放入服务器 `plugins` 目录
193+
1. 下载 [最新版本](https://github.com/zhibeigg/Orryx/releases)
194+
2. 放入服务器 `plugins` 目录
68195
3. 重启服务器
69-
4. 编辑 `plugins/Orryx/config.yml` 进行配置
196+
4. 编辑 `plugins/Orryx/config.yml`
70197

71198
### 依赖
72199

73-
| 类型 | 依赖项 |
74-
|--------|---------------------------------------------------------------------|
75-
| **必需** | [TabooLib](https://github.com/TabooLib/taboolib) (已内置) |
76-
| **可选** | PlaceholderAPI, MythicMobs, DragonCore, GermPlugin, AttributePlus 等 |
200+
| 类型 | 依赖项 |
201+
|-----|--------|
202+
| **必需** | TabooLib (已内置) |
203+
| **可选** | 见上方第三方插件列表 |
204+
205+
---
77206

78207
## 项目结构
79208

80209
```
81210
Orryx/
82-
├── core/ # 核心模块
83-
│ ├── skill/ # 技能系统
84-
│ ├── station/ # 事件触发器
85-
│ ├── kether/ # Kether 脚本引擎
86-
│ ├── kts/ # Kotlin 脚本系统
87-
│ ├── job/ # 职业系统
88-
│ └── damage/ # 伤害计算
89-
├── module/ # 功能模块
90-
│ ├── mana/ # 法力值
91-
│ ├── spirit/ # 精力值
92-
│ ├── state/ # 状态管理
93-
│ └── ui/ # UI 渲染
94-
└── api/ # 公开 API
211+
├── api/ # 公开 API (30+ 事件和接口)
212+
│ ├── events/ # 事件系统
213+
│ ├── interfaces/ # API 接口
214+
│ └── collider/ # 碰撞系统
215+
├── core/ # 核心模块
216+
│ ├── skill/ # 技能系统
217+
│ ├── job/ # 职业系统
218+
│ ├── station/ # 触发器系统 (80+)
219+
│ ├── kether/ # Kether 脚本引擎 (40+ 动作)
220+
│ ├── kts/ # Kotlin 脚本系统
221+
│ ├── selector/ # 选择器系统
222+
│ ├── damage/ # 伤害系统
223+
│ └── common/timer/ # 冷却时间系统
224+
├── module/ # 功能模块
225+
│ ├── mana/ # 法力值
226+
│ ├── spirit/ # 精力值
227+
│ ├── state/ # 状态管理
228+
│ └── ui/ # UI 渲染 (Bukkit/Germ/Dragon)
229+
└── compat/ # 第三方插件兼容
230+
```
231+
232+
### 配置文件
233+
95234
```
235+
plugins/Orryx/
236+
├── config.yml # 主配置
237+
├── skills/ # 技能定义
238+
├── jobs/ # 职业定义
239+
├── stations/ # 中转站定义
240+
├── keys.yml # 按键配置
241+
├── state.yml # 状态机配置
242+
├── selectors.yml # 选择器预设
243+
├── experiences/ # 经验算法
244+
├── ui/ # UI 配置
245+
├── lang/ # 语言文件
246+
└── kts/ # Kotlin 脚本
247+
```
248+
249+
---
96250

97251
## 构建
98252

99253
### 发行版本
100-
构建可直接运行的插件（不含 TabooLib 本体）：
101254
```bash
102255
./gradlew build
103256
```
104257

105-
### 开发版本
106-
构建用于开发的 API 包：
258+
### 开发版本 (API 包)
107259
```bash
108260
./gradlew taboolibBuildApi -PDeleteCode
109261
```
110-
> `-PDeleteCode` 参数移除逻辑代码以减少体积
262+
263+
---
111264

112265
## API 使用
113266

@@ -133,52 +286,33 @@ dependencies {
133286
}
134287
```
135288

136-
## 第三方集成
137-
138-
<details>
139-
<summary><b>支持的插件列表</b></summary>
140-
141-
| 插件 | 功能 |
142-
|---------------------|-----------|
143-
| **PlaceholderAPI** | 变量占位符 |
144-
| **MythicMobs** | 怪物管理集成 |
145-
| **DragonCore** | 自定义 UI/物品 |
146-
| **GermPlugin** | 动画和 UI |
147-
| **Adyeshach** | NPC 系统 |
148-
| **AttributePlus** | 属性系统 |
149-
| **RedisChannel** | 多服数据同步 |
150-
| **ProtocolLib** | 数据包处理 |
151-
| **PacketEvents** | 数据包处理 |
152-
| **OriginAttribute** | 属性系统 |
153-
| **SX-Attribute** | 属性系统 |
154-
155-
</details>
289+
---
156290

157291
## 数据存储
158292

159-
支持多种数据库后端：
293+
| 类型 | 说明 |
294+
|------------|---------|
295+
| **SQLite** | 默认，开箱即用 |
296+
| **MySQL** | 生产环境推荐 |
297+
| **H2** | 轻量级嵌入式 |
298+
| **Redis** | 可选缓存层 |
160299

161-
- **SQLite** (默认) - 无需配置，开箱即用
162-
- **MySQL** - 生产环境推荐
163-
- **H2** - 轻量级嵌入式数据库
164-
- **Redis** - 可选缓存层
300+
---
165301

166302
## 文档资源
167303

168304
- [飞书 Wiki](https://o0vvjwgpeju.feishu.cn/wiki/Syzzw7aQwixJ4YkXoOAcyYkfnOg) - 完整使用文档
169305
- [DeepWiki AI](https://deepwiki.com/zhibeigg/Orryx) - AI 问答助手
170-
- [API 文档](https://github.com/zhibeigg/Orryx) - 开发者参考
306+
- [ZRead AI](https://zread.ai/zhibeigg/Orryx) - AI 问答助手
307+
308+
---
171309

172310
## 统计
173311

174312
<div align="center">
175313

176314
[![bStats](https://bstats.org/signatures/bukkit/Orryx.svg)](https://bstats.org/plugin/bukkit/Orryx/24289/)
177315

178-
</div>
179-
180-
<div align="center">
181-
182316
*Powered by TabooLib*
183317

184318
</div>

0 commit comments

Comments
 (0)