routing.yml
Every setting of routing.yml.
routing.yml names the servers players are sent to while a login waits for them (step) and once they are logged in (complete). Routing players explains them with examples.
Every target has the same fields: target, forcedHosts and attempts.
defaults
The targets for every scenario that does not set its own.
Takesa target
Default"auth"
Affectswhere a player is sent while their login waits for them, such as for a password
A blank target, with no scenario target either, leaves the player where they are.
Takesa target
Default"survival"
Affectswhere a player goes once their login is done
A blank target, with no scenario target either, leaves the player where they are. A player who finished while joining receives the completion messages on the first server they reach.
defaults:
step:
target: "auth"
complete:
target: "survival"
forcedHosts: false
scenarios: {}Target fields
Takesa server name from the proxy's configuration, or ""
Affectsthe server the player is sent to
A server the proxy does not know disconnects the player with routing.missingServer.
Takestrue or false
Defaultfalse on defaults.complete; elsewhere the value of the less specific target
Affectswhether the player is sent to the server the proxy forces for the hostname they joined through
target is used for hostnames without a forced host. When Velocity lists several servers for a hostname, the first one is used. See The player's hostname.
attempts
How often Identica tries to move the player when the server refuses them. See When a server turns the player away.
Advanced
Takes"NONE", "RETRY_ONCE", "RETRY_LIMITED", or "UNTIL_REACHED"
Affectshow many attempts are made
| Mode | Attempts |
|---|---|
NONE | one |
RETRY_ONCE | two |
RETRY_LIMITED | maxAttempts |
UNTIL_REACHED | until the server accepts the player |
Advanced
Takesan integer
Affectsthe number of attempts of RETRY_LIMITED
Other modes ignore it.
Advanced
Takestrue or false
Affectswhether Identica forgets the route as soon as the player reaches the server
With false, Identica keeps the route until a later route replaces it.
Advanced
Takestrue or false
Affectswhether Identica forgets the route once its attempts are used up
With false, Identica keeps the failed route until a later route replaces it.
Takesa map keyed by authentication, registration or migration, in any case
Default{}
Affectsthe step and complete targets of one scenario
Add a scenario only when it should differ from defaults.
scenarios:
registration:
step:
target: "register"
complete:
target: "tutorial"Advanced
Takesa map keyed by stage id, such as provider
Affectsthe step target while the player waits in that stage of the scenario
Advanced
Takesa map keyed by step name, such as enrollment
Affectsthe step target while the player waits at that step
A step override wins over a stage override.
scenarios:
registration:
overrides:
stages:
provider:
target: "register-fallback"
steps:
enrollment:
target: "choose-provider"