ClusterSync

Configuration

Configuration reference for ClusterSync.

Settings are read when the server starts. Changes take effect after the next restart.

MapTag must be unique, and should be treated as permanent

MapTag must be different on every map, and should be treated as permanent. Two maps sharing a code will not sync correctly. Changing a map's code after it has been running can make out-of-date tribe data reappear on that map.

Map identity

Setting	Default	What it does
`MapTag`	required	This map's short code, e.g. `TI`. Must be unique across the cluster. 1–32 characters, case sensitive. Cannot be left as `MAP`.
`MapDisplayName`	`""`	The map name players see on relayed chat and tribe log lines, shown as `[Island]`. Empty uses `MapTag`. Safe to change any time.

What to synchronize

Setting	Default	What it does
`SyncTribeMembership`	`true`	The main feature. Keeps tribe membership, ranks, rank groups, governance and tribe names the same on every map. `false` leaves this map's tribes independent.
`SyncTribeRoster`	`true`	Shows a tribe's full member list on every map, and makes the server's tribe member limit correct everywhere.
`SyncTribeLog`	`true`	Shares tribe log entries between maps. This map's own log works normally either way.
`SyncGlobalChat`	`true`	Shares global chat between maps. Both directions.
`SyncTribeChat`	`true`	Shares tribe chat between maps, delivered only to that tribe. Both directions.
`SyncAllianceChat`	`true`	Shares alliance chat between maps, delivered only to tribes in that alliance. Both directions.
`ChatCommandPrefixes`	`["/", "!"]`	Chat starting with any of these is treated as another plugin's command and is not shared between maps. `[]` shares everything.
`DebugLogging`	`false`	Verbose logging for support. Produces a large amount of output.

Database

Every map must point at the same database

That shared database is what makes the cluster a cluster.

Setting	Default	What it does
`Database.MysqlHost`	`127.0.0.1`	Hostname or IP of the database, reachable from every map.
`Database.MysqlUser`	required	Needs permission to create and modify tables.
`Database.MysqlPass`	required	Password for that user.
`Database.MysqlDB`	`tribeclustersync`	Database name. Tables are created automatically.
`Database.MysqlPort`	`3306`	Port the database listens on.