Authentication is a plugin designed with private servers in mind. It makes it possible to setup one without having to worry about Steam Groups nor SteamIDs. Just choose a password of your preference and you're ready to go.
After wake up, players will be requested to enter the /auth command along with the password the server owner should have shared with them.
There's a limited time to enter the command after the wake up, if players fail to authenticate before the time runs they're kicked from the server. A maximum amount of retries can also be configured.
After wake up, players will be requested to enter the /auth command along with the password the server owner should have shared with them.
There's a limited time to enter the command after the wake up, if players fail to authenticate before the time runs they're kicked from the server. A maximum amount of retries can also be configured.
Usage
- Place Authentication.cs in the plugins folder.
- Type in the server console: auth password [new password]
- Done!
Chat Commands
Syntax: /auth command [required] (optional)- /auth [password]Authenticates player
- /auth password
Shows current password - /auth password [new password]
Sets new password - /auth toggle (on/off)
Toggles authentication on/off - /auth status
Shows the status of the plugin (on/off) - /auth timeout
Shows current timeout - /auth timeout [new timeout]
Sets new timeout - /auth help
Shows in-game commands - /auth retries
Shows current maximum retries - /auth retries [new retries]
Sets new maximum retries
Permissions
This plugin uses the permission system. To assign a permission, use oxide.grant <user or group> <name or steam id> <permission>. To remove a permission, use oxide.revoke <user or group> <name or steam id> <permission>.- authentication.edit
Allows usage of all edit commands.
Configuration
The settings and options can be configured in the Authentication file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.- ENABLED
Whether the plugin is enabled or not. - PASSWORD
The argument of the /auth command. - PREVENT_CHAT
Prevent non-authenticated player from chatting. - PREVENT_CHAT_PASSWORD
Prevent users from telling the password in the chat by replacing it with '*'s.
Warning: This can cause issues with other plugins that modify the chat. Report any bugs you find. - TIMEOUT
Maximum amount of time that players have to authenticate before being kicked. - RETRIES
Maximum amount of wrong password retries before a user is forcefully kicked.
Localization
The default messages are in the Authentication file under the lang/en directory. To add support for another language, create a new language folder (e.g. de for German) if not already created, copy the default language file to the new folder and then customize the messages.- PASSWORD_REQUEST
The message that will be displayed BEFORE authentication. {TIMEOUT} is automatically replaced by the TIMEOUT variable below. - AUTHENTICATION_TIMED_OUT
The error message that appears on the kicked screen. - AUTHENTICATION_SUCCESSFUL
The message that will be displayed AFTER authentication.