features/restriction/join/

features/restriction/join/ holds join restriction's settings.yml, commands.yml and messages.yml. Join restriction explains how staff use it.

settings.yml

enabled: false
allow: []
resumeBypass:
  authentication: false
  registration: false

`enabled`

Advanced

Takestrue or false

Defaultfalse

Affectswhether providers can be join-restricted, for every provider that does not set its own value

`allow`

Advanced

Takesa list of signals: linked, recognized

Default[]

Affectswhich players still get through while a provider is restricted, for every provider that does not set its own list

linked lets players with an account at the provider through, recognized players that recognition recognises. Listing recognized does not turn recognition on.

`resumeBypass.authentication`

Takestrue or false

Defaultfalse

Affectswhether a login that was already waiting when the restriction started may finish

`resumeBypass.registration`

Takestrue or false

Defaultfalse

Affectswhether a registration that was already waiting when the restriction started may finish

Neither lets new attempts through. The scenario must also allow resuming with allowResume.

Under features.restriction.join of a provider's entry in providers/providers.yml. Both fields fall back to the shared settings when absent, and the provider's features.restriction.enabled must not be false.

providers:
  - id: "credential"
    features:
      restriction:
        join:
          enabled: true
          allow:
            - linked
            - recognized