docs: 完善文档

This commit is contained in:
2023-12-25 03:34:14 +08:00
parent b3045644cb
commit 9addfa2c7b
2 changed files with 20 additions and 16 deletions

View File

@@ -18,22 +18,11 @@ redis-url: "redis://localhost:6379?clientName=HamsterBall"
# 只有在同一个频道名的子服才能互相通信
channel-prefix: ""
# 是否在子服端更新玩家信息
# 默认情况下BC 统一管理玩家信息,包括记录 UUID 和玩家名称
# 如果一个子服同时拥有多个 BC 入口
# 且每个 BC 入口为不同的玩家名称分配不同的 UUID
# 则可以启用该功能以防止 UUID 紊乱的问题
game-server-update-player-info: false
# 本服务器信息
server-info:
# 服务器唯一识别码,最长 32 字符
# 需要与 BC 端中 config.yml 里填写的服务器 ID 一致,否则插件跨服传送功能将失效
# 推荐格式:全小写英文+横杠+数字尾号
# 例如:
# survival-1, survival-2生存1区生存2区
# plot-1, plot-2地皮1区地皮2区
# resource-1, resource-2资源1区资源2区
# 需要与 BC 端中 config.yml 里填写的服务器 ID 一致
# 否则插件跨服传送等诸多功能将失效
id: "test-1"
# 服务端名称,常用于展示给玩家看
name: "测试1区"
@@ -45,15 +34,26 @@ server-info:
# 不填则自动获取 server.properties 文件中的设置
# port: 25577
# 是否在子服端更新玩家信息
# 默认情况下BC 统一管理玩家信息,包括记录 UUID 和玩家名称
# 如果一个群组服同时拥有多个 BC 入口
# 且每个 BC 入口为不同的玩家名称分配不同的 UUID
# (例如正版、盗版双入口,或网易多入口接同一个子服)
# 则可以启用该功能以防止 UUID 紊乱的问题
game-server-update-player-info: false
# 数据库连接池配置
# 如果注释该选项则默认使用 HamsterCore 中的连接池配置
# 否则 HamsterBall 将会使用与 HamsterCore 不同的数据库链接
# 如果你需要让每个服务器单独存储仓鼠球信息
# 这个选项就会很有用
#datasource:
# # 数据库链接驱动地址
# driver: "com.mysql.jdbc.Driver"
# # 数据库链接填写格式:
# # jdbc:mysql://{数据库地址}:{数据库端口}/{使用的库名}?参数
# # 除非你知道自己在做什么,否则不建议随意更改参数
# url: "jdbc:mysql://sql.hamster3.cn:3306/Test1?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&autoReconnect=true&useSSL=false&allowPublicKeyRetrieval=true"
# url: "jdbc:mysql://localhost:3306/Test1?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&autoReconnect=true&useSSL=false&allowPublicKeyRetrieval=true"
# # 用户名
# username: "Test"
# # 密码