Server Password

Server Password 1.0.0

Blocks gameplay with a keypad ui until the correct password is entered
Documentation License Version History Discussion
image.jpg



This Rust plugin requires players to enter a password before they're allowed to play on the server. It displays a secure keypad UI on join, freezes the player until the correct code is entered, and kicks them after too many failed attempts. Verified players won't see the UI again unless you want them to. Perfect for private servers, testing environments, or event whitelists.

Permissions

  • serverpassword.bypass - Allows players to skip the password check entirely and play without entering anything.

Configuration

JSON: 
{
  "Version": "1.0.0",
  "Password Settings": {
    "Enabled": false,
    "Password": "1234",
    "Case Sensitive": false,
    "Maximum Failed Attempts Before Kick": 3,
    "Hide Input As Asterisks": true,
    "Maximum Input Length": 12,
    "Remember Verified Player Until Disconnect": true,
    "Show UI Again On Respawn If Not Verified": true,
    "Hide UI On Join If Already Verified": true,
    "Auto Submit When Code Complete": true,
    "Kick Lockout Time After Failure Seconds": 300
  },
  "UI Style Settings": {
    "Overlay Background Color (HEX)": "24201B",
    "Overlay Transparency (0..1)": 0.5,
    "Code Display Background Color (HEX)": "2B2F33",
    "Code Display Transparency (0..1)": 0.78,
    "Code Text Color (HEX)": "F3F5F7",
    "Title Text Color (HEX)": "F3F5F7",
    "Subtitle Text Color (HEX)": "F3F5F7",
    "Keypad Button Background Color (HEX)": "8E949A",
    "Keypad Button Transparency (0..1)": 0.8,
    "Keypad Button Text Color (HEX)": "F3F5F7",
    "Keypad Button Hover Color (HEX)": "8BC34A",
    "Keypad Button Pressed Color (HEX)": "6FA83B",
    "Keypad Button Selected Color (HEX)": "8BC34A",
    "Keypad Button Disabled Color (HEX)": "4D5258",
    "Clear Button Background Color (HEX)": "C85C5C",
    "Clear Button Transparency (0..1)": 0.7,
    "Clear Button Text Color (HEX)": "F3F5F7",
    "Clear Button Hover Color (HEX)": "E07A7A",
    "Clear Button Pressed Color (HEX)": "A13F3F",
    "Clear Button Selected Color (HEX)": "D36A6A",
    "Clear Button Disabled Color (HEX)": "5A2E2E",
    "Attempts Text Color (HEX)": "ECEFF1"
  }
}
Password Settings
  • Enabled - Enables or disables the entire password system.
  • Password - The password players must enter to unlock gameplay.
  • Case Sensitive - Whether the password is case-sensitive.
  • Maximum Failed Attempts Before Kick - How many incorrect tries are allowed before the player is kicked.
  • Hide Input As Asterisks - Whether to show * instead of the actual characters as players type.
  • Maximum Input Length - Limits how many characters players can enter.
  • Remember Verified Player Until Disconnect - If true, keeps the player verified until they leave the server.
  • Show UI Again On Respawn If Not Verified - Whether to show the keypad UI again after death if not yet verified.
  • Hide UI On Join If Already Verified - Whether to hide the UI for players who already passed the password check.
  • Auto Submit When Code Complete - If true, automatically tries the password when enough characters are entered.
  • Kick Lockout Time After Failure Seconds - Time the player is blocked from joining after failing all attempts.
Ui Style Settings
  • Overlay Background Color - The background tint behind the UI (e.g. for screen dimming).
  • Overlay Transparency - How transparent the full-screen overlay is.
  • Code Display Background Color - Background color behind the entered digits.
  • Code Display Transparency - Transparency for the code display background.
  • Code Text Color - Color of the actual password digits.
  • Title Text Color - Color of the main title at the top of the keypad.
  • Subtitle Text Color - Color of the subtitle below the title.
  • Keypad Button Background Color - Base color for keypad buttons.
  • Keypad Button Transparency - Transparency for keypad buttons.
  • Keypad Button Text Color - Color of the numbers on keypad buttons.
  • Keypad Button Hover Color - Color when the button is hovered.
  • Keypad Button Pressed Color - Color when the button is pressed.
  • Keypad Button Selected Color - Color for selected button state (if applicable).
  • Keypad Button Disabled Color - Color for a disabled keypad button.
  • Clear Button Background Color - Base color for the “Clear” button.
  • Clear Button Transparency - Transparency for the “Clear” button.
  • Clear Button Text Color - Text color for the “Clear” button.
  • Clear Button Hover Color - Color when hovering over the "Clear" button.
  • Clear Button Pressed Color - Color when the “Clear” button is pressed.
  • Clear Button Selected Color - Color for selected “Clear” button state.
  • Clear Button Disabled Color - Color for disabled “Clear” button.
  • Attempts Text Color - Color of the text showing remaining attempts.

Localization

JSON: 
{
  "Error.NoPermission": "You do not have permission to use this command.",
  "Locked.Generic": "You must enter the server password first.",
  "UI.Header": "Server Password",
  "UI.Subtitle": "Enter the password to join the server",
  "UI.AttemptsLeftFormat": "Attempts left: {0}",
  "UI.ClearButtonLabel": "C",
  "Toast.WrongPassword": "Wrong password.",
  "Toast.Unlocked": "Welcome!",
  "Kick.BaseReason": "Too many incorrect password attempts.",
  "Kick.Generic": "Kicked.",
  "Kick.TryAgainIn": "Try again in {0}."
}
Author
VisEntities
License duration
Unlimited
Price
12.99 USD
First release
Last update

Ratings

0.00 star(s) 0 reviews
Donate

Also by VisEntities

Back
Top
Chat commands start with a /, while console commands can be entered directly in the F1 console or server console. Use find <keyword> in console to search for available commands related to the plugin. Parameters in < > are required, while [ ] are optional.
This plugin uses Oxide's permission system. Grant or revoke permissions using oxide.grant and oxide.revoke. You can assign them to individual players or groups using their Steam id or group name.
Settings are stored in the config file found under the config/ directory. You can edit this file manually, then reload the plugin to apply your changes.
Persistent data is saved in the data/ directory. This includes things like saved settings, usage stats, or player progress depending on the plugin. Deleting a data file will reset stored progress or customizations.
Language files are located in the lang/ folder. To translate messages, copy the en.json file into your target language folder (e.g. fr, de) and edit the values. Reload the plugin after changes to apply new messages.
This section lists public methods exposed by the plugin for use in other plugins. You can call these via the CallHook method. Ensure the plugin is loaded before calling its API to avoid null reference errors.
These are custom hooks that other plugins can listen for. Simply define a method with the same name and expected parameters in your plugin to handle the event. Hooks are triggered at key moments and are useful for extending or reacting to plugin behavior.
These hooks are injected into the game's code using Harmony. They let the plugin run code at key points in the game's internal logic. You can return values to block or modify behavior. Use with caution — these are powerful and can affect core mechanics.
Cart

Cart

Total -