Skip to content

Commit 2208eb9

Browse files
committed
feat(documentation): 更新文档,增加自动构建版和旧版的下载链接
1 parent 5b3275a commit 2208eb9

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# CatSeedLogin 猫种子登陆
22
> 插件在Spigot API 1.13.2环境下开发的, 理论上应该支持1.7 ~ 1.18.1 一般都是低版本向上兼容。
3+
34
## 基础功能:
45
* 注册 登录 修改密码 管理员设置密码
56
* 防止英文id大小写登录bug
@@ -14,14 +15,19 @@
1415
* 进入游戏时游戏名的限制(由数字,字母和下划线组成 “可配置”长度的游戏名才能进入)
1516
* 绑定邮箱,邮箱重置密码功能
1617
* 支持bc端在没有登录时,禁止切换子服,登录后切换子服保持登录
18+
1719
## 下载
18-
* https://github.com/CatSeed/CatSeedLogin/tags
20+
* [自动构建版](https://github.com/zhinghu/CatSeedLogin/actions/workflows/maven.yml)
21+
* [最新版](https://github.com/zhinghu/CatSeedLogin/releases)
22+
* [旧版](https://github.com/CatSeed/CatSeedLogin/tags)
23+
1924
## 使用方式
2025
#### 如果是正常使用:
2126
* 插件放入plugins文件夹重启服务器
2227
#### 如果是配合BungeeCord连接多个子服使用:
2328
* 插件放入登陆服的plugins文件夹重启服务器
2429
* 插件再放入BungeeCord的plugins文件夹重启服务器
30+
2531
## 指令
2632
### 登录
2733
* /login 密码
@@ -79,8 +85,10 @@
7985
* /catseedlogin setPwd 玩家名 密码
8086
### 重载配置文件
8187
* /catseedlogin reload
88+
8289
## 权限
8390
* catseedlogin.command.catseedlogin 管理员指令/catseedlogin 使用权限
91+
8492
## 配置文件
8593
### settings.yml
8694
> \#相同ip注册数量限制
@@ -114,6 +122,7 @@ CommandWhiteList:
114122
AutoKick: 120
115123
\#死亡状态退出游戏是否记录退出位置
116124
DeathStateQuitRecordLocation: true
125+
117126
### sql.yml
118127
如果不使用mysql数据库储存,就请无视此配置
119128
> MySQL:
@@ -124,6 +133,7 @@ DeathStateQuitRecordLocation: true
124133
Database: databaseName
125134
User: root
126135
Password: root
136+
127137
### emailVerify.yml
128138
如果不使用邮箱一系列功能,就请无视此配置
129139
> \#是否开启邮箱系列的功能(false = 不开启)
@@ -135,9 +145,11 @@ EmailSmtpPort: "465"
135145
SSLAuthVerify: true
136146
\#发件人的名字
137147
FromPersonal: "xxx服务器"
148+
138149
### language.yml
139150
语言文件
140151
内容省略...
152+
141153
## BungeeCord使用
142154
你需要在登陆服和bc端装入这个插件,并设置它们的bungeecord.yml配置文件
143155
注意事项1:只需要bc端和一个作为登录用途的服务器装就可以了,不需要全部服务器都装
@@ -152,6 +164,7 @@ Host: 127.0.0.1
152164
Port: 2333
153165
\#验证密钥,类似设置密码一样,这里填写一串无法被人猜到无规律的字符(如果是内网可以不写)
154166
AuthKey: ""
167+
155168
### bc端配置文件
156169
#### bungeecord.yml
157170
> \#设置IP,需要跟子服的一样(暂时只建议使用内网),从这个ip跟子服建立通讯
@@ -162,17 +175,20 @@ Port: 2333
162175
LoginServerName: "lobby"
163176
\#验证密钥,需要跟子服一样
164177
AuthKey: ""
178+
165179
### bc端指令
166180
#### 重載bc端本插件的配置文件
167181
/CatSeedLoginBungee reload
168182
/cslb reload
169-
183+
170184
## 开发者部分
171185
### 事件
172186
CatSeedPlayerLoginEvent
173-
187+
174188
CatSeedPlayerRegisterEvent
189+
175190
### API
176191
CatSeedLoginAPI
192+
177193
## 联系
178-
[点击进入 QQ交流群839815243](http://shang.qq.com/wpa/qunwpa?idkey=91199801a9406f659c7add6fb87b03ca071b199b36687c62a3ac51bec2f258a3)
194+
[点击进入 QQ交流群839815243](http://shang.qq.com/wpa/qunwpa?idkey=91199801a9406f659c7add6fb87b03ca071b199b36687c62a3ac51bec2f258a3)

0 commit comments

Comments
 (0)