-
Notifications
You must be signed in to change notification settings - Fork 23
Pregame
Person8880 edited this page Jan 6, 2019
·
14 revisions
The pregame plugin provides a way to customise the pre-game time. It offers four modes:
-
TIME
- The old mode where you set a fixed pre-game length using thePreGameTimeInSeconds
option. Once that time is up, the game starts. This does not require any commanders to start the game. -
ONE_COMMANDER_COUNTDOWN
- In this mode, the game will wait until one team has a commander. Once they do, either the other team gets a commander and the game starts, or thePreGameTimeInSeconds
duration passes with only one commander and the game starts. UnlikeMAX_WAIT_TIME
, this mode starts thePreGameTimeInSeconds
timer only after one team has a commander. -
MAX_WAIT_TIME
- In this mode, once either both teams get a commander, or thePreGameTimeInSeconds
duration has expired and one team has a commander, the game starts. Note that unlikeONE_COMMANDER_COUNTDOWN
, this mode starts thePreGameTimeInSeconds
timer immediately from the start of the map/end of the last round. -
MIN_PLAYER_COUNT
- In this mode, the game is only allowed to start when the number of human players on playing teams equals or exceedsMinPlayers
and there are two commanders.
The default config looks something like this:
{
"ShowCountdown": true,
"PreGameTimeInSeconds": 45,
"CountdownTimeInSeconds": 15,
"Mode": "ONE_COMMANDER_COUNTDOWN",
"MinPlayers": 0,
"AbortIfNoCom": false,
"AllowAttackPreGame": true,
"StartDelayInSeconds": 30,
"__Version": "1.7"
}
The file should be called "PreGame.json" and should be placed in the directory defined as your plugin config directory (default is config://shine/plugins).
Option | Description |
---|---|
Mode | Defines the mode of operation. Should be one of the modes listed above. |
MinPlayers | When using the MIN_PLAYER_COUNT mode, this determines how many human players must be present before the game is allowed to start. |
ShowCountdown | Determines whether to display a countdown on player's screens for when the round will start. |
PreGameTimeInSeconds | See the above descriptions of the modes. |
CountdownTimeInSeconds | Time to wait when both teams have a commander before starting the game. |
AbortIfNoCom | If you are using the ONE_COMMANDER_COUNTDOWN or MAX_WAIT_TIME mode, then the countdown to start will be aborted if a commander leaves the chair and this is set to true. |
AllowAttackPreGame | If set to false, then attacking is denied for the entire pre-game. |
StartDelayInSeconds | If set to a time (in seconds) greater than 0, it will force the game to wait this long after a map change until a game can start. |