staff_auth_config
Staff Auth Config — config entry.
Entry Information
| Property | Value |
|---|---|
| Entry ID | staff_auth_config |
| Type | Config |
| Color | Orange |
| Icon | mdi:shield-lock |
Description
Configuration entry for StaffAuth. Defines permission, messages, sounds, and security settings. Event handling is done by [btc.renaud.staffauth.events.AuthListeners].
Fields
| Field | Type | Description |
|---|---|---|
staffPermission | String | Permission that marks a player as staff and requires authentication. |
maxAttempts | Int | Maximum failed attempts before the player is kicked. 0 = disabled. |
maxAttemptsKickMessage | Var<String> | Kick message when max attempts exceeded. Use {attempts} placeholder. |
registerMessage | Var<String> | Message sent when an unregistered staff joins. |
loginMessage | Var<String> | Message sent when a registered staff joins. |
guiTitle | Var<String> | Title of the GUI authentication menu. |
blockMessage | Var<String> | Message sent when interacting while unauthenticated. |
successMessage | Var<String> | Message sent on successful authentication. |
guiLoginPrompt | Var<String> | Subtitle shown on the GUI login screen before password entry. |
wrongPasswordMessage | Var<String> | Message sent on wrong password. Use {attempts} and {max} placeholders. |
minPasswordLength | Int | Minimum password length. |
passwordTooShortMessage | Var<String> | Message when password is too short. Use {length} placeholder. |
passwordMismatchMessage | Var<String> | Message sent on password mismatch during registration. |
successSound | Sound | Sound played on successful authentication. |
errorSound | Sound | Sound played on authentication error. |
useGuiWhenAvailable | Boolean | Whether to use the GUI menu when the GUI extension is available. |
preventFallDamage | Boolean | Whether to prevent fall damage for unauthenticated players. |
sessionTimeoutMinutes | Int | Session timeout in minutes. 0 = no timeout. |
Usage Example
- entry: staff_auth_config
name: "Staff Auth Config"
staffPermission: ""
maxAttempts: 0
maxAttemptsKickMessage: ""
registerMessage: ""
loginMessage: ""
guiTitle: ""
blockMessage: ""
successMessage: ""
guiLoginPrompt: ""
wrongPasswordMessage: ""
minPasswordLength: 0
passwordTooShortMessage: ""
passwordMismatchMessage: ""
successSound: ""
errorSound: ""
useGuiWhenAvailable: false
preventFallDamage: false
sessionTimeoutMinutes: 0