Whitelist

A whitelist system that utilizes Sonoran CMS's game whitelist system.

All players of your server must have their API ID setup and must be given a rank that has whitelist permissions for the specified server.

Looking for VPS, web, or dedicated hosting? Check out our official server hosting!

This resource is a whitelist system that utilizes Sonoran CMS's game whitelist system by checking against that whitelist upon each player connection.

Installation

1. Download the Resource

Forge

You can download a copy here.

Ensure that you download the one that has forge in the name.

Fabric

You can download a copy here.

Ensure that you download the one that has fabric in the name.

Bukkit/Spigot/Paper

You can download a copy here.

Ensure that you download the one that has plugin in the name.

2. Install the Resource

Follow the standard resource installation guide for the whitelist resource, available here.

3. Setup Whitelist Permissions

Navigate to the Rank Manager within the Administrative Panel.

Administrative Panel > Ranks

Sonoran CMS Departments & Ranks

For users in your Sonoran CMS community to be accepted through the whitelist, they'll need to be granted permission for the whitelist through rank permissions. You will need to grant each rank the permission of Allow Whitelist that you want to be allowed through the whitelist. You will want to grant each rank with the permission of Block Whitelist if you want them to be blocked from passing through the whitelist.

Block Whitelist will ALWAYS overrule Allow Whitelist If a user is granted both Block Whitelist and Allow Whitelist through various ranks they will be blocked from the whitelist. Block will always overrule allow.

Sonoran CMS - Rank Manager Server Permissions

4. Add your API ID

Ensure all players have added their API ID to the CMS!

Configuration

Forge

The config file is called cmswhitelist-common.toml in the config folder of your Minecraft server folder.

[SonoranCMS]
	#This is your SonoranCMS Community ID.
	"Community ID" = ""
	#This is your SonoranCMS API key.
	"Community API Key" = ""
	#Which identifier to use, either UUID or Username. UUID is preferred.
	"Identifier Type" = "UUID"
	#The server ID found in SonoranCMS that this whitelist should check against.
	"Server ID" = 1

Value Name	Description	Default
Server ID	This is the game server ID set in the CMS management panel.	1
Community ID	This is the community ID that is found in the API Integration section of the management panel.	""
Community API Key	This is the API key listed in the API Integration section of the management panel.	""
Identifier Type	This controls whether a player's UUID or username is used for identifying.	"UUID" (Recommended)

Fabric

The config file is called sonorancms.json in the config folder of your Minecraft server folder.

{
  "CMS_Settings": {
    "Community_ID": "",
    "Community_API_Key": "",
    "Identifier": "UUID",
    "Server_ID": 1
  }
}

Value Name	Description	Default
Server_ID	This is the game server ID set in the CMS management panel.	1
Community_ID	This is the community ID that is found in the API Integration section of the management panel.	""
Community_API_Key	This is the API key listed in the API Integration section of the management panel.	""
Identifier	This controls whether a player's UUID or username is used for identifying.	"UUID" (Recommended)

Bukkit/Spigot/Paper

The config file is called config.yml in the plugins/SonoranCMSWhitelist folder of your Minecraft server folder.

CommunityID: ''
CommunityAPIKey: ''
Identifier: UUID
ServerID: 1

Value Name	Description	Default
ServerID	This is the game server ID set in the CMS management panel.	1
CommunityID	This is the community ID that is found in the API Integration section of the management panel.	''
CommunityAPIKey	This is the API key listed in the API Integration section of the management panel.	''
Identifier	This controls whether a player's UUID or username is used for identifying.	UUID (Recommended)