Simple Whitelist 1.1.0

Your server. Your guest list.

Simple Whitelist is a free Rust plugin for Oxide and Carbon that lets you control who can join your server. Approve players by Steam ID or permission, manage the whitelist through console commands, and customise the message shown to anyone denied access.

Ideal for private communities, testing servers, and invite-only events.

Features

• Steam ID access — maintain a list of approved players.
• Permission-based access — optionally allow players to join through a permission.
• Separate management permission — let trusted staff manage the whitelist without giving ordinary whitelisted players administrative control.
• Console commands — add or remove players, view the list, check status, and toggle restrictions.
• Custom rejection message — explain why access was denied or tell players how to request entry.
• Saved changes — command-based changes are saved automatically.

How It Works

When the whitelist is enabled, a connecting player can join if:

• Their SteamID64 is in Whitelisted Steam IDs; or
• Use Permission is enabled and they have SimpleWhitelist.Allow.

Both access methods can work together. Enabling permission-based access does not disable the Steam ID list.

When the whitelist is disabled, Simple Whitelist does not restrict connections.

Commands

Run these commands from the server console, RCON, or an authorised player's F1 console. Do not add a / prefix.

Replace <SteamID> with the player's SteamID64, without the brackets.

Adding or removing players and toggling the whitelist automatically saves the changes.

Permissions

Server administrators and the server console can use management commands without the management permission.

Management access does not bypass the connection whitelist. Administrators and players with SimpleWhitelist.Admin must still be approved through their Steam ID or the join permission.

Configuration

Example Configuration

This example leaves restrictions disabled while you set up your player list:

{
  "Whitelist Enabled": false,
  "Use Permission": false,
  "Kick Message": "This is a private server. Please contact an administrator for access.",
  "Whitelisted Steam IDs": [],
  "Version (DO NOT CHANGE)": {
    "Major": 1,
    "Minor": 1,
    "Patch": 0
  }
}

Reload the plugin after manually editing the configuration. Changes made through whitelist commands take effect immediately.

Getting Started

1. Install SimpleWhitelist.cs in your server's plugin folder.
2. Review the generated configuration.
3. From the server console or RCON, add your own SteamID64 using whitelist.add <SteamID>.
4. Add the other players you want to allow.
5. Run whitelist.status to check the current setting.
6. If restrictions are disabled, run whitelist.toggle to enable them.

Using Permissions

To approve players through permissions:

1. Set Use Permission to true and reload the plugin.
2. Grant SimpleWhitelist.Allow to the players or permission groups you want to admit.
3. Grant SimpleWhitelist.Admin separately to trusted staff who need whitelist management commands.

You can continue using the Steam ID list alongside permissions.

Good to Know

• Access is checked when players connect. Enabling the whitelist does not kick players already online.
• Removing a Steam ID affects future connections. It does not disconnect the player.
• Either access method can approve a player. Removing their Steam ID will not block them if they still have the join permission and permission-based access is enabled.
• The list command shows Steam IDs only. It does not list players approved through permissions.

Looking for more server tools? Browse plugins by Bubbafett.