Skip to content

Reserved Slots

Person8880 edited this page Jul 25, 2021 · 11 revisions

Overview

The reserved slots plugin allows you to reserve a set amount of player slots for certain players.

In order to get players to be allowed in a reserved slot, you should give them access to sh_reservedslot.

If a player without reserved slot access attempts to connect to a reserved slot, they are immediately denied connection, with a "Server is full" message. They do not load the map.

Available modes

TakeSlotInstantly = true

This is the default mode. As an example:

The server has a real max of 24 players, and is set to use 2 reserved slots. When the server is at 10/24, the server browser shows 10/22. A player with reserved slot access joins. The server browser now shows 11/23, as this player has used a reserved slot and increased the max player count.

At 18/24, another reserved slot user joins, and the server browser now says 19/24. Now 5 more players can connect, regardless of reserved slot access, and fill the server to 24/24. The server browser will also show 24/24 at max capacity.

TakeSlotInstantly = false

As an example:

The server has a real max of 24 players, and is set to use 2 reserved slots. When the server is 10/24, the server browser shows 10/22. A player with reserved slot access joins. The server browser now shows 11/22, as it has not yet reached 22 players.

When it reaches 22/24, the server browser shows 22/22 and now only reserved slot access players may connect. If reserved slot users connect, the server browser will show 24/22 at max capacity.

Config

The default config will look something like this:

{
    "Slots": 2,
    "TakeSlotInstantly": true,
    "SlotType": "PLAYABLE"
}

The file should be called "ReservedSlots.json" and should be placed in the directory defined as your plugin config directory (default is config://shine/plugins).

Option Description
Slots Determines how many slots to hold as reserved.
TakeSlotInstantly Determines whether a player with reserved slot access instantly uses up a reserved slot when they join, even if the server is not full.
SlotType Determines which slots should be reserved. Can be either:
  • PLAYABLE - reserves non-spectator slots only.
  • ALL - reserves both player and spectator slots, starting from spectator slots.
    NOTE: the server browser only shows reserved player slots. If you reserve only spectator slots, the browser will still show them as available.

Commands

Command Chat Command Arguments Description
sh_setresslots !resslots <slots> Sets the number of reserved slots and saves it.
Clone this wiki locally