feat: 更新了README.md和配置文件说明

zhinghu · Aug 9, 2024 · b652fd9 · b652fd9
1 parent 2b46ee3
commit b652fd9
Showing 1 changed file with 115 additions and 106 deletions.
diff --git a/README.md b/README.md
@@ -1,33 +1,33 @@
 # CatSeedLogin 猫种子登陆
-> 插件在Spigot API 1.13.2环境下开发的， 理论上应该支持1.7 ~ 1.18.1 一般都是低版本向上兼容。
- 
+> 插件在Spigot API 1.13.2环境下开发的， 理论上应该支持1.12 ~ 1.21 一般都是低版本向上兼容。
+
 ## 基础功能:
-*  注册 登录 修改密码 管理员设置密码
-*  防止英文id大小写登录bug
-*  登录前隐藏背包
-*  防止玩家登录之后,被别人顶下线
-*  下线之后 “可配置” 秒内不能重新进入服务器（防止某些bug）
-*  没有登录之前禁止移动,交互,攻击,发言,使用指令,传送,点击背包物品,丢弃物品,拾取物品
-*  限制同ip的帐号同时在线/注册的数量
-*  登录之前在配置文件指定的世界出生点,登录之后自动返回下线地点（可配置取消）
-*  储存默认使用的是SQLite（也支持Mysql，需要配置文件sql.yml中配置打开）
-*  密码加密储存,Crypt默认加密方式
-*  进入游戏时游戏名的限制（由数字,字母和下划线组成 “可配置”长度的游戏名才能进入）
-*  绑定邮箱，邮箱重置密码功能
-*  支持bc端在没有登录时，禁止切换子服，登录后切换子服保持登录
- 
+* 注册 登录 修改密码 管理员设置密码
+* 防止英文id大小写登录bug
+* 登录前隐藏背包
+* 防止玩家登录之后,被别人顶下线
+* 下线之后 “可配置” 秒内不能重新进入服务器（防止某些bug）
+* 没有登录之前禁止移动,交互,攻击,发言,使用指令,传送,点击背包物品,丢弃物品,拾取物品
+* 限制同ip的帐号同时在线/注册的数量
+* 登录之前在配置文件指定的世界出生点,登录之后自动返回下线地点（可配置取消）
+* 储存默认使用的是SQLite（也支持Mysql，需要配置文件sql.yml中配置打开）
+* 密码加密储存,Crypt默认加密方式
+* 进入游戏时游戏名的限制（由数字,字母和下划线组成 “可配置”长度的游戏名才能进入）
+* 绑定邮箱，邮箱重置密码功能
+* 支持bc端在没有登录时，禁止切换子服，登录后切换子服保持登录
+
 ## 下载
 * [自动构建版](https://github.com/zhinghu/CatSeedLogin/actions/workflows/maven.yml)
 * [最新版](https://github.com/zhinghu/CatSeedLogin/releases)
 * [旧版](https://github.com/CatSeed/CatSeedLogin/tags)
 
 ## 使用方式
-#### 如果是正常使用：
+### 如果是正常使用：
 * 插件放入plugins文件夹重启服务器
-#### 如果是配合BungeeCord连接多个子服使用：
+### 如果是配合BungeeCord连接多个子服使用：
 * 插件放入登陆服的plugins文件夹重启服务器
 * 插件再放入BungeeCord的plugins文件夹重启服务器
- 
+
 ## 指令
 ### 登录
 * /login 密码
@@ -85,110 +85,119 @@
 * /catseedlogin setPwd 玩家名 密码
 ### 重载配置文件
 * /catseedlogin reload
- 
+
 ## 权限
 * catseedlogin.command.catseedlogin 管理员指令/catseedlogin 使用权限
- 
+
 ## 配置文件
 ### settings.yml
-> \#相同ip注册数量限制  
-IpRegisterCountLimit: 2  
-\#相同ip登录数量限制  
-IpCountLimit: 2  
-\#登录点,默认是world主世界出生点,推荐用指令设置  
-SpawnLocation: 世界名:x轴:y轴:z轴:yaw:pitch  
-\#是否限制中文ID  
-LimitChineseID: true  
-\#游戏ID最小长度  
-MinLengthID: 2  
-\#游戏ID最大长度  
-MaxLengthID: 15  
-\#登陆之前不受到伤害  
-BeforeLoginNoDamage: true  
-\#离开服务器重新进入的间隔限制 单位：tick（如果设置3秒则是60）  
-ReenterInterval: 60  
-\#登陆之后是否返回退出地点  
-AfterLoginBack: true  
-\#登录之前是否强制在登陆地点  
-CanTpSpawnLocation: true  
-\#登陆之前允许执行的指令 (支持正则表达式)  
-CommandWhiteList:  
-  \- /(?i)l(ogin)?(\z| .\*)  
-  \- /(?i)reg(ister)?(\z| .\*)  
-  \- /(?i)resetpassword?(\z| .\*)  
-  \- /(?i)repw?(\z| .\*)  
-  \- /(?i)worldedit cui  
-\#设置自动踢出未登录的玩家 (默认120秒，小于1秒则关闭此功能)  
-AutoKick: 120  
-\#死亡状态退出游戏是否记录退出位置  
+```yaml
+#相同ip注册数量限制
+IpRegisterCountLimit: 2
+#相同ip登录数量限制
+IpCountLimit: 2
+#登录点,默认是world主世界出生点,推荐用指令设置
+SpawnLocation: 世界名:x轴:y轴:z轴:yaw:pitch
+#是否限制中文ID
+LimitChineseID: true
+#游戏ID最小长度
+MinLengthID: 2
+#游戏ID最大长度
+MaxLengthID: 15
+#登陆之前不受到伤害
+BeforeLoginNoDamage: true
+#离开服务器重新进入的间隔限制 单位：tick（如果设置3秒则是60）
+ReenterInterval: 60
+#登陆之后是否返回退出地点
+AfterLoginBack: true
+#登录之前是否强制在登陆地点
+CanTpSpawnLocation: true
+#登陆之前允许执行的指令 (支持正则表达式)
+CommandWhiteList:
+  - /(?i)l(ogin)?(\z| .\*)
+  - /(?i)reg(ister)?(\z| .\*)
+  - /(?i)resetpassword?(\z| .\*)
+  - /(?i)repw?(\z| .\*)
+  - /(?i)worldedit cui
+#设置自动踢出未登录的玩家 (默认120秒，小于1秒则关闭此功能)
+AutoKick: 120
+#死亡状态退出游戏是否记录退出位置
 DeathStateQuitRecordLocation: true
-
+```
+
 ### sql.yml
-如果不使用mysql数据库储存，就请无视此配置  
-> MySQL:  
-\#是否开启数据库功能（false = 不开启）  
-  Enable: false  
-  Host: 127.0.0.1  
-  Port: '3306'  
-  Database: databaseName  
-  User: root  
-  Password: root  
-
-### emailVerify.yml 
-如果不使用邮箱一系列功能，就请无视此配置  
-> \#是否开启邮箱系列的功能（false = 不开启）  
-Enable: false  
-EmailAccount: "[email protected]"  
-EmailPassword: "123456"  
-EmailSmtpHost: "smtp.qq.com"  
-EmailSmtpPort: "465"  
-SSLAuthVerify: true  
-\#发件人的名字  
- FromPersonal: "xxx服务器"  
-
+如果不使用mysql数据库储存，就请无视此配置
+```yaml
+MySQL:
+  #是否开启数据库功能（false = 不开启）
+  Enable: false
+  Host: 127.0.0.1
+  Port: '3306'
+  Database: databaseName
+  User: root
+  Password: root
+```
+
+### emailVerify.yml
+如果不使用邮箱一系列功能，就请无视此配置
+```yaml
+#是否开启邮箱系列的功能（false = 不开启）
+Enable: false
+EmailAccount: "[email protected]"
+EmailPassword: "123456"
+EmailSmtpHost: "smtp.qq.com"
+EmailSmtpPort: "465"
+SSLAuthVerify: true
+#发件人的名字
+FromPersonal: "xxx服务器"
+```
+
 ### language.yml
-语言文件  
+语言文件
 内容省略...
- 
+
 ## BungeeCord使用
-你需要在登陆服和bc端装入这个插件，并设置它们的bungeecord.yml配置文件  
-注意事项1：只需要bc端和一个作为登录用途的服务器装就可以了，不需要全部服务器都装  
-注意事项2：不要与现有服务器端口冲突，或被占用，这是本插件自己需要占用的一个端口  
+你需要在登陆服和bc端装入这个插件，并设置它们的bungeecord.yml配置文件
+注意事项1：只需要bc端和一个作为登录用途的服务器装就可以了，不需要全部服务器都装
+注意事项2：不要与现有服务器端口冲突，或被占用，这是本插件自己需要占用的一个端口
 ### 子服配置文件
 #### bungeecord.yml
-> \#是否开启bungeecord模式（false = 不开启）  
-Enable: false  
-\#设置IP（暂时只建议使用内网），会使用这个ip开启一个通讯服务与bc建立端通讯  
-Host: 127.0.0.1  
-\#设置端口  
-Port: 2333  
-\#验证密钥，类似设置密码一样，这里填写一串无法被人猜到无规律的字符（如果是内网可以不写）  
-AuthKey: ""  
-
+```yaml
+#是否开启bungeecord模式（false = 不开启）
+Enable: false
+#设置IP（暂时只建议使用内网），会使用这个ip开启一个通讯服务与bc建立端通讯
+Host: 127.0.0.1
+#设置端口
+Port: 2333
+#验证密钥，类似设置密码一样，这里填写一串无法被人猜到无规律的字符（如果是内网可以不写）
+AuthKey: ""
+```
+
 ### bc端配置文件
 #### bungeecord.yml
-> \#设置IP，需要跟子服的一样（暂时只建议使用内网），从这个ip跟子服建立通讯  
-Host: 127.0.0.1  
-\#设置端口  
-Port: 2333  
-\#作为登录服的服务器  
-LoginServerName: "lobby"  
-\#验证密钥，需要跟子服一样  
+```yaml
+#设置IP，需要跟子服的一样（暂时只建议使用内网），从这个ip跟子服建立通讯
+Host: 127.0.0.1
+#设置端口
+Port: 2333
+#作为登录服的服务器
+LoginServerName: "lobby"
+#验证密钥，需要跟子服一样
 AuthKey: ""
-
+```
+
 ### bc端指令
 #### 重載bc端本插件的配置文件
-/CatSeedLoginBungee reload  
-/cslb reload  
- 
+* /CatSeedLoginBungee reload
+* /cslb reload
+
 ## 开发者部分
 ### 事件
-CatSeedPlayerLoginEvent
-
-CatSeedPlayerRegisterEvent
-
+* CatSeedPlayerLoginEvent
+* CatSeedPlayerRegisterEvent
+
 ### API
-CatSeedLoginAPI
- 
+* CatSeedLoginAPI
+
 ## 联系
-[点击进入 QQ交流群839815243](http://shang.qq.com/wpa/qunwpa?idkey=91199801a9406f659c7add6fb87b03ca071b199b36687c62a3ac51bec2f258a3)
+[点击进入 QQ交流群839815243](http://shang.qq.com/wpa/qunwpa?idkey=91199801a9406f659c7add6fb87b03ca071b199b36687c62a3ac51bec2f258a3)