Skip to content

Commit

Permalink
feat(documentation): 更新文档,增加自动构建版和旧版的下载链接
Browse files Browse the repository at this point in the history
  • Loading branch information
shulng committed Jun 8, 2024
1 parent 5b3275a commit 2208eb9
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# CatSeedLogin 猫种子登陆
> 插件在Spigot API 1.13.2环境下开发的, 理论上应该支持1.7 ~ 1.18.1 一般都是低版本向上兼容。
## 基础功能:
* 注册 登录 修改密码 管理员设置密码
* 防止英文id大小写登录bug
Expand All @@ -14,14 +15,19 @@
* 进入游戏时游戏名的限制(由数字,字母和下划线组成 “可配置”长度的游戏名才能进入)
* 绑定邮箱,邮箱重置密码功能
* 支持bc端在没有登录时,禁止切换子服,登录后切换子服保持登录

## 下载
* https://github.com/CatSeed/CatSeedLogin/tags
* [自动构建版](https://github.com/zhinghu/CatSeedLogin/actions/workflows/maven.yml)
* [最新版](https://github.com/zhinghu/CatSeedLogin/releases)
* [旧版](https://github.com/CatSeed/CatSeedLogin/tags)

## 使用方式
#### 如果是正常使用:
* 插件放入plugins文件夹重启服务器
#### 如果是配合BungeeCord连接多个子服使用:
* 插件放入登陆服的plugins文件夹重启服务器
* 插件再放入BungeeCord的plugins文件夹重启服务器

## 指令
### 登录
* /login 密码
Expand Down Expand Up @@ -79,8 +85,10 @@
* /catseedlogin setPwd 玩家名 密码
### 重载配置文件
* /catseedlogin reload

## 权限
* catseedlogin.command.catseedlogin 管理员指令/catseedlogin 使用权限

## 配置文件
### settings.yml
> \#相同ip注册数量限制
Expand Down Expand Up @@ -114,6 +122,7 @@ CommandWhiteList:
AutoKick: 120
\#死亡状态退出游戏是否记录退出位置
DeathStateQuitRecordLocation: true

### sql.yml
如果不使用mysql数据库储存,就请无视此配置
> MySQL:
Expand All @@ -124,6 +133,7 @@ DeathStateQuitRecordLocation: true
Database: databaseName
User: root
Password: root

### emailVerify.yml
如果不使用邮箱一系列功能,就请无视此配置
> \#是否开启邮箱系列的功能(false = 不开启)
Expand All @@ -135,9 +145,11 @@ EmailSmtpPort: "465"
SSLAuthVerify: true
\#发件人的名字
FromPersonal: "xxx服务器"

### language.yml
语言文件
内容省略...

## BungeeCord使用
你需要在登陆服和bc端装入这个插件,并设置它们的bungeecord.yml配置文件
注意事项1:只需要bc端和一个作为登录用途的服务器装就可以了,不需要全部服务器都装
Expand All @@ -152,6 +164,7 @@ Host: 127.0.0.1
Port: 2333
\#验证密钥,类似设置密码一样,这里填写一串无法被人猜到无规律的字符(如果是内网可以不写)
AuthKey: ""

### bc端配置文件
#### bungeecord.yml
> \#设置IP,需要跟子服的一样(暂时只建议使用内网),从这个ip跟子服建立通讯
Expand All @@ -162,17 +175,20 @@ Port: 2333
LoginServerName: "lobby"
\#验证密钥,需要跟子服一样
AuthKey: ""

### bc端指令
#### 重載bc端本插件的配置文件
/CatSeedLoginBungee reload
/cslb reload

## 开发者部分
### 事件
CatSeedPlayerLoginEvent

CatSeedPlayerRegisterEvent

### API
CatSeedLoginAPI

## 联系
[点击进入 QQ交流群839815243](http://shang.qq.com/wpa/qunwpa?idkey=91199801a9406f659c7add6fb87b03ca071b199b36687c62a3ac51bec2f258a3)
[点击进入 QQ交流群839815243](http://shang.qq.com/wpa/qunwpa?idkey=91199801a9406f659c7add6fb87b03ca071b199b36687c62a3ac51bec2f258a3)

0 comments on commit 2208eb9

Please sign in to comment.