Dominion/docs/en-us/operator/config.md
2024-09-10 17:37:27 +08:00

179 lines
5.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 配置文件参考
```yaml
Database:
Type: sqlite # pgsql, sqlite, mysql
Host: localhost
Port: '5432'
Name: dominion
User: dominion
Pass: dominion
# 语言设置,参考 languages 文件夹下的文件名
Language: zh-cn
# 自动创建领地的半径,单位为方块
# -1表示不开启
AutoCreateRadius: 10
# 默认玩家圈地限制
Limit:
SpawnProtection: 10 # 出生点保护半径 出生点此范围内不允许圈地-1表示不开启
MinY: -64 # 最小Y坐标
MaxY: 320 # 最大Y坐标
SizeX: 128 # X方向最大长度-1表示不限制
SizeY: 64 # Y方向最大长度-1表示不限制
SizeZ: 128 # Z方向最大长度-1表示不限制
Amount: 10 # 最大领地数量-1表示不限制
Depth: 3 # 子领地深度0表示不开启-1表示不限制
Vert: false # 是否自动延伸到 MaxY 和 MinY
OpByPass: true # 是否允许OP无视领地限制
WorldSettings:
some_world_name:
MinY: -64
MaxY: 320
SizeX: 128
SizeY: 64
SizeZ: 128
Amount: 10
Depth: 3
Vert: false
Allow: false
Teleport:
Enable: true
Delay: 0 # 传送延迟 秒
CoolDown: 0 # 传送冷却 秒
# 自动清理长时间未上线玩家的领地(天)
# -1表示不开启
AutoCleanAfterDays: 180
# 圈地工具名称
Tool: ARROW
# 经济设置
# 需要安装 Vault 前置及插件
Economy:
Enable: false
Price: 10.0 # 圈地价格 单位每方块
OnlyXZ: false # 是否只计算xz平面积
Refund: 0.85 # 删除或缩小领地时的退款比例
# 飞行权限节点 - 拥有以下任意一个权限节点的玩家不会被本插件拦截飞行
FlyPermissionNodes:
- essentials.fly
- cmi.command.fly
# 是否允许玩家从 Residence 迁移领地数据
ResidenceMigration: false
# 权限组称号 - 使用权限组当作称号(需要PlaceholderAPI插件)
# 变量: %dominion_group_title%
# 前后缀如需要加颜色请使用这种格式 &#ffffff
GroupTitle:
Enable: false
Prefix: '['
Suffix: ']'
BlueMap: false
Dynmap: false
CheckUpdate: true
Debug: false
Timer: false # 性能测试计时器
```
## 配置说明
### Database
可选数据库Postgresql、Sqlite3`1.33.4-beta` 开始支持Mysql。
- 如果使用 Postgresql 数据库,需要手动创建数据库。
- 如果使用 sqlite 数据库,插件会自动在插件目录下创建数据库文件。配置文件内的 Host、Port、User、Pass 字段不会被使用。
### Language
语言设置,参考 languages 文件夹下的文件名。
### AutoCreateRadius
配置玩家在使用“自动创建”功能时会自动向XYZ三个方向延伸此距离创建领地。
### Limit
玩家使用此插件的一些限制:
- SpawnProtection出生点半径保护此半径范围内普通玩家无法创建领地
- MinY领地的最小Y坐标
- MaxY领地的最大Y坐标
- SizeXX方向最大长度 1表示不限制
- SizeYY方向最大长度 1表示不限制
- SizeZZ方向最大长度 1表示不限制
- Amount每个玩家拥有的最大领地数量 1表示不限制
- Depth子领地深度、0表示不允许子领地、 -1表示不限制
- Vert当设置为 `true`玩家选择区域创建或者自动创建领地会自动将Y向下向上延伸到MinY和MaxY。**同时也会根据 MinY 和 MaxY 的设置自动调整 SizeY 的配置保证数值逻辑一致。**
- WorldSettings单独设置某个世界的圈地规则如不设置则使用上述默认规则
- Allow是否允许在此世界圈地
> 您服务器世界的名称应该避免使用 `default` 这样的特殊单词,否则会导致不可预料的意外错误。
### Teleport
领地传送功能,可以配置是否允许使用传送、传送延迟、两次传送之间的冷却时间。
### AutoCleanAfterDays
配置数据自动清理,-1表示不开启。180表示如果一个玩家超过180天没有上线那么会自动删除此玩家在本插件内的所有数据包括他的领地、他在其他玩家领地内的权限等
### Tool
配置手动圈地时的选取工具。如果配置错误会被设置为默认值“ARROW”箭矢。
### Economy
经济控制支持,让玩家需要花费金钱圈地。使用此特性需要安装 Vault 经济前置插件。
- Enable控制是否启用此功能如果不需要请关闭。修改是否启用需要完整重启服务器不要使用管理插件热重载
- Price每个单位方块价值。
- OnlyXZ是否只计算平面面积价值忽略Y轴
- Refund删除、缩小领地时的退还金钱比例。
### FlyPermissionNodes
飞行权限节点,拥有此列表任意一个权限节点的玩家不会被本插件拦截飞行。
EssentialX飞行权限essentials.fly
CMI飞行权限cmi.command.fly
### ResidenceMigration
是否允许玩家从 Residence 迁移领地数据,打开后玩家可以自行决定要从 Residence 中迁移哪些数据到 Dominion。
### GroupTitle
- Enable是否启用权限组称号
- Prefix称号前缀 (如需要加颜色请使用这种格式 &#ffffff
- Suffix称号后缀 (如需要加颜色请使用这种格式 &#ffffff
关于如何配置详见[权限组称号](../manage-dominion/group-title.md)。
### BlueMap
配置是否在 BlueMap 渲染玩家领地。
### Dynmap
配置是否在 Dynmap 渲染玩家领地。
### CheckUpdate
自动检查更新。
### Debug
调试模式如果遇到bug可以尝试打开此开关后复现问题然后将日志发送给我。