config.yml
plugins/CloudGuild/config.yml 是插件的主设定,第一次启动时自动生成,文件里的注释是繁体中文。
写法约定
- 金额、贡献、活跃都是整数。
- 时间写成
30s、5m、3h、7d、1w,可以组合:1d12h。写0= 不限 / 没有。写错时使用默认值。 - 文字支持
&颜色代码、&#RRGGBB与 MiniMessage(<gradient:#7ad1ff:#c9b6ff>…</gradient>)。 - 没写的键使用默认值:升级后新版本新增的设定不会写进你的文件。
- 数字会被限制在合理范围,例如
vault.rows: 9实际当成6。
修改后怎么生效
| 设定 | 生效方式 |
|---|---|
database.*、sync.*、menu.cloudui、activity.online-interval | 重启服务器 |
| 其他全部 | /cg admin reload |
指令别名(command-aliases)
command-aliases: [cg]
玩家输入列表里的指令时,云公会会在指令执行之前把它改写成 /cloudguild,所以一律交给云公会处理,即使其他插件也注册了 /cg。
- 不分大小写,可以写多个,例如
[cg, guild, 公会]。 - 只影响玩家;控制台请用
cloudguild(或没有冲突时的cg)。 - 清空成
[]则不做任何处理。主指令/cloudguild永远可以用。
数据库(database)
database:
type: sqlite
file: data.db
host: 127.0.0.1
port: 3306
database: cloudguild
username: root
password: ''
parameters: 'useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=utf8&useUnicode=true'
table-prefix: 'cg_'
pool-size: 8
| 键 | 默认 | 作用 |
|---|---|---|
type | sqlite | sqlite = 单服,数据存在 plugins/CloudGuild/data.db;mysql(MariaDB 也填 mysql)= 多个子服共用,要跨服一定要用 MySQL |
file | data.db | SQLite 文件名(放在 plugins/CloudGuild/ 里);/cg admin migrate sqlite 也从这里读 |
host / port | 127.0.0.1 / 3306 | MySQL 地址与端口 |
database | cloudguild | MySQL 数据库名称(要先建好) |
username / password | root / 空 | MySQL 账号密码 |
parameters | 见上 | 额外的 JDBC 参数 |
table-prefix | cg_ | 表格名称前缀,只能用字母、数字、下划线(最多 32 个字)。所有子服要一样 |
pool-size | 8 | MySQL 连接数(最少 2);SQLite 固定 1 |
数据库连不上时,插件会在控制台显示原因并停用自己。表格列表见 数据库。
跨服(sync)
sync:
enabled: auto
server-name: ''
interval-ticks: 20
| 键 | 默认 | 作用 |
|---|---|---|
enabled | auto | auto = 使用 MySQL 时自动开启;true / false 强制开关 |
server-name | 空 | 这个子服在 BungeeCord / Velocity 的名称。跨服回据点一定要和代理端一致;也用来分辨子服,每个子服的名字不能重复。留空 = 自动产生代号 auto-xxxxxxxx(存在 plugins/CloudGuild/server-id.txt),资料照样同步,但其他子服的成员不能跨服回到这个子服的据点 |
interval-ticks | 20 | 多久读一次其他子服的变动(公会聊天、资金、成员……),单位 tick(20 = 1 秒) |
详见 跨服设置。
名称与标签(name、tag)
name:
min-length: 2
max-length: 8
pattern: '^[\p{IsHan}A-Za-z0-9_]+$'
color-permission: 'cloudguild.create.color'
blacklist: [管理員, 服主, admin, owner]
rename-cost: 50000
description-max-length: 64
tag:
enabled: true
min-length: 2
max-length: 4
pattern: '^[\p{IsHan}A-Za-z0-9]+$'
format: '&7[&b{tag}&7] '
| 键 | 默认 | 作用 |
|---|---|---|
name.min-length / max-length | 2 / 8 | 去掉颜色代码后的字数(中文、英文都算 1) |
name.pattern | 见上 | 允许的字符(正则表达式,比对去掉颜色代码后的名称);写错时控制台警告并使用默认 |
name.color-permission | cloudguild.create.color | 有这个权限才能在名称里用颜色代码;留空 = 大家都可以 |
name.blacklist | 见上 | 名称与标签不能包含这些字(不分大小写) |
name.rename-cost | 50000 | 改名花费的公会资金 |
name.description-max-length | 64 | 公会介绍最多几个字(最少 8) |
tag.enabled | true | 是否使用标签 |
tag.min-length / max-length | 2 / 4 | 标签 字数 |
tag.pattern | 见上 | 标签允许的字符 |
tag.format | '&7[&b{tag}&7] ' | %cloudguild_tag_formatted% 的格式;没有标签时是空字符串 |
显示(display)
display:
no-guild: '&7無公會'
format: '&f[{color}{name}&f]'
%cloudguild_display% 的格式:有公会时用 format({color} 等级颜色、{name} 名称、{tag} 标签、{level} 等级),没有公会时显示 no-guild。
建立公会(create)
create:
money: 10000
points: 0
exp-level: 0
items: []
broadcast: true
commands: []
default-icon: WHITE_BANNER
| 键 | 默认 | 作用 |
|---|---|---|
money | 10000 | 建立费用(Vault 金币);0 = 不用。没有经济插件时,大于 0 会让玩家无法建立 |
points | 0 | 建立费用(PlayerPoints 点券) |
exp-level | 0 | 需要的原版经验等级(只检查不扣除) |
items | [] | 需要的物品(扣除),写法 材质:数量,例如 ['DIAMOND:5', 'GOLD_INGOT:32'] |
broadcast | true | 建立与解散时全服公告 |
commands | [] | 建立后以控制台执行,{player} 玩家名、{guild} 公会名称(不含颜色) |
default-icon | WHITE_BANNER | 预设公会图示(材质);之后可以用 /cg icon 换成手上的物品 |
加入(join)
join:
default-mode: apply
rejoin-cooldown: 3h
invite-expire: 5m
application-expire: 3d
max-applications: 3
remind-no-guild: true
| 键 | 默认 | 作用 |
|---|---|---|
default-mode | apply | 新公会的加入方式:open 直接加入 / apply 申请审核 / closed 只能邀请 |
rejoin-cooldown | 3h | 主动退出公会后多久不能加入其他公会(被踢、公会解散不算) |
invite-expire | 5m | 邀请多久过期 |
application-expire | 3d | 申请多久过期 |
max-applications | 3 | 一位玩家同时最多申请几个公会 |
remind-no-guild | true | 没有公会的玩家上线时提醒(可点击打开公会列表) |
见 建立与加入。
职位(ranks、default-rank)
职位、权重、人数上限与 16 项职位权限,见 职位与等级。
等级(levels)
每个等级的人数、升级花费、活跃需求、维护费、活跃衰减、据点数、仓库页数、颜色与免费增益,见 职位与等级。
公会银行(bank)
bank:
min-deposit: 100
contribution-per-money: 0.1
activity-per-money: 0.01
quick-amounts: [1000, 10000, 100000]
log-size: 100
| 键 | 默认 | 作用 |
|---|---|---|
min-deposit | 100 | 每次最少存多少 |
contribution-per-money | 0.1 | 每存 1 元,自己得到多少贡献(可以是小数,最后取整数) |
activity-per-money | 0.01 | 每存 1 元,公会得到多少活跃 |
quick-amounts | [1000, 10000, 100000] | 银行菜单的三个快速存款金额(也用在 /cg deposit 的 Tab 补全) |
log-size | 100 | 每个公会保留几笔银行记 录(最少 10) |
每日签到(signin)
signin:
enabled: true
contribution: 20
activity: 10
streak-bonus: 5
streak-max: 7
multipliers:
vip: 1.5
mvp: 2
commands: []
计算方式与例子见 银行、签到与活跃。
活跃(activity)
activity:
online-interval: 5m
online-activity: 1
online-contribution: 1
daily-time: '04:00'
| 键 | 默认 | 作用 |
|---|---|---|
online-interval | 5m | 每隔多久结算一次在线成员(最少 1 分钟,改了要重启) |
online-activity | 1 | 每位在线成员让公会增加的活跃 |
online-contribution | 1 | 每位在线成员自己得到的贡献 |
daily-time | '04:00' | 每日结算(维护费、活跃衰减)的时间,服务器时区,HH:mm;写错时使用 04:00 |
见 银行、签到与活跃。
公会据点(home)
home:
warmup: 3
cancel-on-move: true
cooldown: 30
blocked-worlds: []
见 公会据点。
友伤(pvp)
pvp:
friendly-fire: false
ally-damage: false
ignore-worlds: []
| 键 | 默认 | 作用 |
|---|---|---|
friendly-fire | false | 新公会默认是否允许成员互相伤害 |
ally-damage | false | 同盟之间是否可以互相伤害 |
ignore-worlds | [] | 这些世界不管友伤设定(例如竞技场);公会增益在这些世界也会暂时移除 |
公会聊天(chat)
chat:
guild-format: '&a[公會] {rank} &f{player}&7: &f{message}'
ally-format: '&d[同盟] &7{guild} &f{player}&7: &f{message}'
spy-format: '&8[監聽 {guild}] {player}: {message}'
quick-prefix: '#'
allow-color: false
见 聊天与公告。
公告(notice)
notice:
max: 20
cost: 0
title-max-length: 16
content-max-length: 200
| 键 | 默认 | 作用 |
|---|---|---|
max | 20 | 每个公会保留几则公告(超过时删掉最旧的) |
cost | 0 | 发布公告花费的公会资金 |
title-max-length | 16 | 标题最多几个字(最少 4) |
content-max-length | 200 | 内容最多几个字(最少 10) |
同盟与敌对(relation)
relation:
enabled: true
max-allies: 3
max-enemies: 5
request-expire: 1d
见 同盟、敌对与公会战。
公会战(war)
war:
enabled: true
min-level: 3
cost: 5000
preparation: 10m
duration: 1h
cooldown: 1d
kill-contribution: 5
reward-funds: 5000
reward-activity: 500
loot-percent: 5
broadcast: true
每个键的说明见 同盟、敌对与公会战。
公会仓库(vault)
vault:
enabled: true
rows: 6
| 键 | 默认 | 作用 |
|---|---|---|
enabled | true | 是否开放公会仓库 |
rows | 6 | 每页几排(1 ~ 6) |
页数由等级的 vault-pages 决定。见 公会仓库。
菜单(menu)
menu:
cloudui: true
cancel-word: '取消'
input-timeout-seconds: 90
date-format: 'yyyy-MM-dd HH:mm'
| 键 | 默认 | 作用 |
|---|---|---|
cloudui | true | 装了云界面 CloudUI 时,公会主页使用云界面画面(不能显示的玩家仍使用箱子菜单)。改了要重启。见 云界面公会 |
cancel-word | 取消 | 在聊天栏输入(公会名称、存款金额、公告……)时,输入这个字取消 |
input-timeout-seconds | 90 | 在聊天栏输入时,超过几秒没输入就自动取消(最少 10) |
date-format | yyyy-MM-dd HH:mm | 菜单与 /cg info 的日期格式(Java 日期格式) |
从其他插件导入(import)
import:
playerguild:
type: sqlite
file: plugins/PlayerGuild/PlayerGuild.db
host: 127.0.0.1
port: 3306
database: mc
username: root
password: ''
parameters: 'useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=utf8'
/cg admin import playerguild 读取的 PlayerGuild 数据库:type: sqlite 读 file(相对于服务器根目录),type: mysql 用下面的连线。见 从 PlayerGuild 导入。