Skip to content

Commit eb12466

Browse files
committed
docs(README): 重写项目文档以改进结构和内容
feat(README): 添加项目徽章和快速开始指南 docs(README): 更新安装说明和依赖信息 refactor(README): 重新组织项目结构描述 docs(README): 添加构建说明和API使用示例 feat(README): 添加第三方集成插件列表 docs(README): 更新数据存储和文档资源信息 chore(README): 添加统计信息和版权声明
1 parent 8b54926 commit eb12466

File tree

1 file changed

+167
-18
lines changed

1 file changed

+167
-18
lines changed

README.md

Lines changed: 167 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,192 @@
1+
<div align="center">
2+
13
# Orryx
24

3-
![pEFaJDs.png](https://s21.ax1x.com/2025/01/16/pEFaJDs.png)
5+
<img src="https://s21.ax1x.com/2025/01/16/pEFaJDs.png" alt="Orryx Logo" width="400">
6+
7+
**跨时代技能插件,支持实现复杂逻辑,为稳定高效而生**
8+
9+
[![Version](https://img.shields.io/badge/version-1.31.68-blue?style=for-the-badge)](https://github.com/zhibeigg/Orryx/releases)
10+
[![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)
13+
14+
[![Wiki](https://img.shields.io/badge/Wiki-开始使用-darkred?style=for-the-badge&logo=gitbook)](https://o0vvjwgpeju.feishu.cn/wiki/Syzzw7aQwixJ4YkXoOAcyYkfnOg)
15+
[![Ask DeepWiki](https://img.shields.io/badge/DeepWiki-Ask_AI-00D4AA?style=for-the-badge)](https://deepwiki.com/zhibeigg/Orryx)
16+
17+
</div>
18+
19+
---
20+
21+
## 核心特性
22+
23+
<table>
24+
<tr>
25+
<td width="50%">
26+
27+
### 技能系统
28+
- 多触发方式(主动/被动/按键/事件)
29+
- 技能冷却、等级、经验管理
30+
- 技能组与职业绑定
31+
32+
</td>
33+
<td width="50%">
34+
35+
### 脚本引擎
36+
- Kether 表达式语言支持
37+
- Kotlin 脚本 (KTS) 热重载
38+
- 复杂逻辑轻松实现
39+
40+
</td>
41+
</tr>
42+
<tr>
43+
<td width="50%">
444

5-
[![Static Badge](https://img.shields.io/badge/%E4%B8%AD%E6%96%87-%E5%BC%80%E5%A7%8B%E4%BD%BF%E7%94%A8WIKI-orryx?style=flat-square&logo=n8n&logoColor=darkred&color=darkred)](https://o0vvjwgpeju.feishu.cn/wiki/Syzzw7aQwixJ4YkXoOAcyYkfnOg)
6-
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/zhibeigg/Orryx)
7-
> 跨时代技能插件,支持实现复杂逻辑,为稳定高效而生。
8-
## 构建发行版本
45+
### 资源管理
46+
- 法力值 (Mana) 系统
47+
- 精力值 (Spirit) 系统
48+
- 完整经验与升级机制
949

10-
[<img src="https://camo.githubusercontent.com/a654761ad31039a9c29df9b92b1dc2be62d419f878bf665c3288f90254d58693/68747470733a2f2f77696b692e70746d732e696e6b2f696d616765732f362f36392f5461626f6f6c69622d706e672d626c75652d76322e706e67" alt="" width="300">](https://github.com/TabooLib/taboolib)
50+
</td>
51+
<td width="50%">
1152

12-
Orryx是免费的, 发行版本用于正常使用, 不含 TabooLib 本体。
53+
### 多端 UI
54+
- Bukkit 原生 UI
55+
- GermPlugin 支持
56+
- DragonCore 支持
57+
58+
</td>
59+
</tr>
60+
</table>
61+
62+
## 快速开始
63+
64+
### 安装
65+
66+
1. 下载 [最新版本](https://github.com/zhibeigg/Orryx/releases) 的 Orryx
67+
2. 将 JAR 文件放入服务器 `plugins` 目录
68+
3. 重启服务器
69+
4. 编辑 `plugins/Orryx/config.yml` 进行配置
70+
71+
### 依赖
72+
73+
| 类型 | 依赖项 |
74+
|--------|---------------------------------------------------------------------|
75+
| **必需** | [TabooLib](https://github.com/TabooLib/taboolib) (已内置) |
76+
| **可选** | PlaceholderAPI, MythicMobs, DragonCore, GermPlugin, AttributePlus 等 |
77+
78+
## 项目结构
1379

1480
```
15-
./gradlew build
81+
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
1695
```
1796

18-
## 构建开发版本
19-
20-
开发版本包含 TabooLib 本体, 用于开发者使用, 但不可运行。
97+
## 构建
2198

99+
### 发行版本
100+
构建可直接运行的插件(不含 TabooLib 本体):
101+
```bash
102+
./gradlew build
22103
```
104+
105+
### 开发版本
106+
构建用于开发的 API 包:
107+
```bash
23108
./gradlew taboolibBuildApi -PDeleteCode
24109
```
110+
> `-PDeleteCode` 参数移除逻辑代码以减少体积
25111
26-
> 参数 -PDeleteCode 表示移除所有逻辑代码以减少体积。
112+
## API 使用
27113

28-
## 使用API
114+
### Gradle (Kotlin DSL)
115+
```kotlin
116+
repositories {
117+
maven("https://www.mcwar.cn/nexus/repository/maven-public/")
118+
}
29119

120+
dependencies {
121+
compileOnly("org.gitee.orryx:orryx:1.31.68:api")
122+
}
30123
```
124+
125+
### Gradle (Groovy)
126+
```groovy
31127
repositories {
32-
maven("https://www.mcwar.cn/nexus/repository/maven-public/")
128+
maven { url 'https://www.mcwar.cn/nexus/repository/maven-public/' }
33129
}
34130
35131
dependencies {
36-
compileOnly("org.gitee.orryx:orryx:{VERSION}:api")
132+
compileOnly 'org.gitee.orryx:orryx:1.31.68:api'
37133
}
38134
```
39135

40-
> {VERSION} 处填写版本号 如 1.0.0
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>
156+
157+
## 数据存储
158+
159+
支持多种数据库后端:
160+
161+
- **SQLite** (默认) - 无需配置,开箱即用
162+
- **MySQL** - 生产环境推荐
163+
- **H2** - 轻量级嵌入式数据库
164+
- **Redis** - 可选缓存层
165+
166+
## 文档资源
167+
168+
- [飞书 Wiki](https://o0vvjwgpeju.feishu.cn/wiki/Syzzw7aQwixJ4YkXoOAcyYkfnOg) - 完整使用文档
169+
- [DeepWiki AI](https://deepwiki.com/zhibeigg/Orryx) - AI 问答助手
170+
- [API 文档](https://github.com/zhibeigg/Orryx) - 开发者参考
171+
172+
## 统计
173+
174+
<div align="center">
175+
176+
[![bStats](https://bstats.org/signatures/bukkit/Orryx.svg)](https://bstats.org/plugin/bukkit/Orryx/24289/)
177+
178+
</div>
179+
180+
<div align="center">
181+
182+
*Powered by TabooLib*
183+
184+
</div>
185+
186+
---
187+
188+
<div align="center">
189+
190+
**Orryx** © 2024-2025
41191

42-
## BStats
43-
[![](https://bstats.org/signatures/bukkit/Orryx.svg)](https://bstats.org/plugin/bukkit/Orryx/24289/)
192+
</div>

0 commit comments

Comments
 (0)