Configuration
Every key in Mirror's mirror.yml, the environment variables that override them, and the Scaffold setting that turns Mirror on.
mirror.yml
Mirror keeps one file, plugins/Mirror/mirror.. Saving it reloads it. A port change needs a restart.
port: 25599
domain: nexus.svc.cluster.local| Key | Default | Environment variable | Meaning |
|---|---|---|---|
port | 25599 | MIRROR_PORT | TCP port Mirror listens on and dials on the other server. Use the same port on every game server. |
domain | nexus. | MIRROR_DOMAIN | Domain used to build the other server's address, as <serverId>.. |
stateHertz | 20 | Not used yet. Changing it has no effect. | |
pingSeconds | 2 | Not used yet. Changing it has no effect. | |
handshakeSeconds | 20 | Not used yet. Changing it has no effect. |
When an environment variable is set, it wins over the file.
Turning Mirror on
Mirror only plays matches when Scaffold's mirror setting is on. Set it on every game server and leave it off on lobbies.
| File | Key | Default | Environment variable |
|---|---|---|---|
plugins/Scaffold/scaffold. | mirror | false | SCAFFOLD_MIRROR |
Changing it needs a restart.
Related Kernel settings
Mirror uses two Kernel values from plugins/Kernel/kernel.:
| Key | Environment variable | Used for |
|---|---|---|
serverId | BRIDGE_SERVER | The other server's address, and picking which server hosts the link. Must be unique. |
region | NEXUS_REGION | Deciding which region each player is in. |
Mirror has no commands or permissions.