Skip to content

Commit 825b2d1

Browse files
committed
feat: 添加事件倒计时插件功能并更新文档
添加多个事件倒计时功能图片和示例配置文件 扩展README文档,增加功能展示和详细配置说明 重命名插件为EventsCountdown以反映功能扩展
1 parent 1abe4ab commit 825b2d1

9 files changed

Lines changed: 208 additions & 9 deletions

README.md

Lines changed: 160 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# ExamCountdown 高考倒计时插件
1+
# EventsCountdown 事件倒计时插件
22

3-
一个为Minecraft服务器设计的高考倒计时插件,会在玩家加入游戏时显示距离高考剩余的时间。
3+
一个为Minecraft服务器设计的事件倒计时插件,会在玩家加入游戏时显示距离特定事件(如高考)的剩余时间。
4+
5+
![高考倒计时](img/高考倒计时.png)
6+
*高考倒计时效果示例*
47

58
## 快速开始
69

710
1. 将插件JAR文件放入服务器的 `plugins` 文件夹
811
2. 重启服务器生成配置文件
9-
3. 编辑 `plugins/ExamCountdown/config.yml` 进行个性化配置
12+
3. 编辑 `plugins/EventsCountdown/config.yml` 进行个性化配置
1013
4. 使用 `/ec reload` 重载配置或重启服务器
1114

1215
## 核心功能
@@ -17,33 +20,181 @@
1720
- 👤 **个人设置** - 允许玩家控制是否显示倒计时
1821
- 🔄 **自动更新** - 定时刷新倒计时信息
1922

23+
## 功能展示
24+
25+
### 高考倒计时
26+
![高考倒计时](img/高考倒计时.png)
27+
*高考倒计时效果 - 显示距离高考的剩余时间*
28+
29+
### 元旦倒计时
30+
![元旦倒计时](img/元旦倒计时.png)
31+
*元旦倒计时效果 - 迎接新年的倒计时*
32+
33+
### 服务器公告
34+
![服务器公告](img/服务器公告.png)
35+
*服务器公告功能 - 显示重要服务器信息*
36+
37+
### 服务器状态
38+
![服务器状态](img/服务器状态.png)
39+
*服务器状态显示 - 实时监控服务器性能*
40+
41+
### 玩家加入欢迎
42+
![玩家加入欢迎](img/玩家加入欢迎.png)
43+
*玩家加入欢迎信息 - 新玩家加入时的欢迎语*
44+
45+
### 每日笑话
46+
![每日笑话](img/每日笑话.png)
47+
*每日笑话功能 - 为玩家带来欢乐*
48+
49+
### MC冷知识
50+
![MC冷知识](img/MC冷知识.png)
51+
*MC冷知识分享 - 有趣的游戏知识*
52+
2053
## 命令与权限
2154

2255
### 命令
23-
- `/examcountdown``/ec` - 主命令
56+
- `/eventscountdown``/ec` - 主命令
2457
- `/ec on/off/toggle` - 控制倒计时显示
2558
- `/ec reload` - 重载配置(需要管理员权限)
2659

2760
### 权限
28-
- `examcountdown.use` - 基础命令权限(默认所有玩家)
29-
- `examcountdown.admin` - 管理员权限(默认仅OP)
61+
- `eventscountdown.use` - 基础命令权限(默认所有玩家)
62+
- `eventscountdown.admin` - 管理员权限(默认仅OP)
3063

3164
## 配置说明
3265

3366
详细配置说明请查看生成的 `config.yml` 文件,其中包含了完整的占位符和PAPI变量说明。
3467

68+
### 配置示例
69+
70+
插件支持多种配置模式,以下是一些常用配置示例:
71+
72+
#### 高考倒计时配置
73+
```yaml
74+
exam-date-pattern: "06-07 09:00:00"
75+
display-format: |-
76+
&b&l{year}年高考倒计时: &f&l{days}天 {hours}小时 {minutes}分钟 {seconds}秒
77+
&a&o{litemotto}
78+
litemotto-prompt: "请生成一句积极向上的高考励志语句,鼓舞人心。不要包含任何前后缀、额外的文字或解释。"
79+
```
80+
81+
#### 元旦倒计时配置
82+
```yaml
83+
exam-date-pattern: "01-01 00:00:00"
84+
display-format: |-
85+
&b&l{year}年元旦倒计时: &f&l{days}天 {hours}小时 {minutes}分钟 {seconds}秒
86+
&a&o{litemotto}
87+
litemotto-prompt: "请生成一句迎接新年的积极祝福语句,温馨美好。不要包含任何前后缀、额外的文字或解释。"
88+
```
89+
90+
#### 服务器公告配置
91+
```yaml
92+
display-format: |-
93+
&a&l服务器公告 &f&l»
94+
&a亲爱的玩家们,为提升服务器稳定性,我们将在本周六凌晨2点进行例行维护,
95+
&a期间将暂时关闭所有游戏模式,请提前做好准备,维护完成后将开启全新活动奖励,敬请期待,感谢!
96+
```
97+
98+
#### 服务器状态配置
99+
```yaml
100+
display-format: |-
101+
&a&l服务器状态 &f&l»
102+
&a延迟: &f%player_ping%ms &a在线: &f%server_online%/%server_max_players%
103+
&aTPS: &f%server_tps%
104+
```
105+
106+
#### 玩家加入欢迎配置
107+
```yaml
108+
display-format: |-
109+
&a&l欢迎新玩家 &f&l»
110+
&a{litemotto}
111+
litemotto-prompt: "请生成一句热情的玩家欢迎语,友好真挚。欢迎%player_name%加入服务器,不要包含任何前后缀、额外的文字或解释。"
112+
```
113+
114+
#### 每日笑话配置
115+
```yaml
116+
display-format: |-
117+
&d&l今日笑话 &f&l»
118+
&b&o{litemotto}
119+
litemotto-prompt: "请生成一句有趣的笑话或幽默段子。不要包含任何前后缀、额外的文字或解释。"
120+
```
121+
122+
#### MC冷知识配置
123+
```yaml
124+
display-format: |-
125+
&d&l你知道吗? &f&l»
126+
&b&o{litemotto}
127+
litemotto-prompt: "请生成一条关于《我的世界》游戏的冷知识或实用小技巧。不要包含任何前后缀、额外的文字或解释。"
128+
```
129+
35130
## PlaceholderAPI支持
36131
37132
插件提供丰富的PAPI变量,具体变量列表和用法请参考配置文件中的详细注释。
38133
134+
### 主要占位符变量
135+
136+
插件提供以下主要占位符变量,可在配置文件中使用:
137+
138+
- `%eventscountdown_days%` - 剩余天数
139+
- `%eventscountdown_hours%` - 剩余小时数
140+
- `%eventscountdown_minutes%` - 剩余分钟数
141+
- `%eventscountdown_seconds%` - 剩余秒数
142+
- `%eventscountdown_year%` - 事件年份
143+
- `%eventscountdown_exam_date%` - 完整事件日期 (yyyy-MM-dd HH:mm:ss)
144+
- `%eventscountdown_exam_date_short%` - 简短事件日期 (yyyy-MM-dd)
145+
- `%eventscountdown_exam_date_chinese%` - 中文完整事件日期 (yyyy年MM月dd日 HH:mm:ss)
146+
- `%eventscountdown_exam_date_chinese_short%` - 中文简短事件日期 (yyyy年MM月dd日)
147+
- `%eventscountdown_litemotto%` - 当前格言内容
148+
- `%eventscountdown_litemotto_enabled%` - LiteMotto插件是否可用 (true/false)
149+
- `%eventscountdown_formatted%` - 格式化的倒计时
150+
151+
### 使用示例
152+
153+
在配置文件中使用占位符:
154+
```yaml
155+
display-format: |-
156+
&b&l事件倒计时: &f&l%eventscountdown_days%天 %eventscountdown_hours%小时
157+
&a&o%eventscountdown_litemotto%
158+
```
159+
160+
## 高级功能
161+
162+
### 多事件支持
163+
插件支持配置多个不同的事件倒计时,只需在配置文件中设置不同的日期模式即可。
164+
165+
### 自定义显示格式
166+
支持使用Minecraft颜色代码和格式代码来自定义显示效果:
167+
- `&0` - 黑色
168+
- `&1` - 深蓝色
169+
- `&2` - 深绿色
170+
- `&3` - 湖蓝色
171+
- `&4` - 深红色
172+
- `&5` - 紫色
173+
- `&6` - 金色
174+
- `&7` - 灰色
175+
- `&8` - 深灰色
176+
- `&9` - 蓝色
177+
- `&a` - 绿色
178+
- `&b` - 天蓝色
179+
- `&c` - 红色
180+
- `&d` - 粉红色
181+
- `&e` - 黄色
182+
- `&f` - 白色
183+
- `&k` - 随机字符
184+
- `&l` - 粗体
185+
- `&m` - 删除线
186+
- `&n` - 下划线
187+
- `&o` - 斜体
188+
- `&r` - 重置格式
189+
190+
### LiteMotto集成
191+
插件深度集成LiteMotto插件,可以自动生成与事件相关的励志语句、祝福语等内容。
192+
39193
## 构建与开发
40194

41195
```bash
42196
# 构建插件
43197
mvn clean package
44-
45-
# 运行测试
46-
mvn test
47198
```
48199

49200
## 许可证

img/MC冷知识.png

21.4 KB
Loading

img/元旦倒计时.png

11.9 KB
Loading

img/服务器公告.png

26.7 KB
Loading

img/服务器状态.png

18.8 KB
Loading

img/每日笑话.png

22 KB
Loading

img/玩家加入欢迎.png

21.5 KB
Loading

img/高考倒计时.png

21.5 KB
Loading
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# EventsCountdown事件倒计时插件配置示例文件
2+
# 此文件为用户配置参考,包含配置示例
3+
# 使用方法:根据需要复制对应配置到 plugins/EventsCountdown/config.yml 中
4+
# 配置完成后使用 /ec reload 命令重载配置
5+
6+
# 高考倒计时配置
7+
exam-date-pattern: "06-07 09:00:00"
8+
display-format: |-
9+
&b&l{year}年高考倒计时: &f&l{days}天 {hours}小时 {minutes}分钟 {seconds}秒
10+
&a&o{litemotto}
11+
litemotto-prompt: "请生成一句积极向上的高考励志语句,鼓舞人心。不要包含任何前后缀、额外的文字或解释。"
12+
13+
# 元旦倒计时配置
14+
exam-date-pattern: "01-01 00:00:00"
15+
display-format: |-
16+
&b&l{year}年元旦倒计时: &f&l{days}天 {hours}小时 {minutes}分钟 {seconds}秒
17+
&a&o{litemotto}
18+
litemotto-prompt: "请生成一句迎接新年的积极祝福语句,温馨美好。不要包含任何前后缀、额外的文字或解释。"
19+
20+
# 服务器公告配置
21+
display-format: |-
22+
&a&l服务器公告 &f&l»
23+
&a亲爱的玩家们,为提升服务器稳定性,我们将在本周六凌晨2点进行例行维护,
24+
&a期间将暂时关闭所有游戏模式,请提前做好准备,维护完成后将开启全新活动奖励,敬请期待,感谢!
25+
26+
# 服务器状态配置
27+
display-format: |-
28+
&a&l服务器状态 &f&l»
29+
&a延迟: &f%player_ping%ms &a在线: &f%server_online%/%server_max_players%
30+
&aTPS: &f%server_tps%
31+
32+
# 玩家加入欢迎配置
33+
display-format: |-
34+
&a&l欢迎新玩家 &f&l»
35+
&a{litemotto}
36+
litemotto-prompt: "请生成一句热情的玩家欢迎语,友好真挚。欢迎%player_name%加入服务器,不要包含任何前后缀、额外的文字或解释。"
37+
38+
# 每日笑话配置
39+
display-format: |-
40+
&d&l今日笑话 &f&l»
41+
&b&o{litemotto}
42+
litemotto-prompt: "请生成一句有趣的笑话或幽默段子。不要包含任何前后缀、额外的文字或解释。"
43+
44+
# MC冷知识配置
45+
display-format: |-
46+
&d&l你知道吗? &f&l»
47+
&b&o{litemotto}
48+
litemotto-prompt: "请生成一条关于《我的世界》游戏的冷知识或实用小技巧。不要包含任何前后缀、额外的文字或解释。"

0 commit comments

Comments
 (0)