ConVars and Server Commands - teliosdev/jailbreak GitHub Wiki
This plugin provides a set of ConVars and Server commands to manage the Jailbreak plugin.
ConVars
sm_jailbreak_round_time
The round time, in seconds. By default, this is 10 minutes - I have found that this is a reasonable time limit. This can vary based on your use case, though. If you change this, it will be reflected on the start of the next round. There is an absolute maximum of 30 minutes.
sm_jailbreak_warden_friendly_fire
Whether or not the warden can set friendly fire. This is enabled by default, but you can disable this if you do not want the wardens to be able to handle friendly fire.
sm_jailbreak_warden_collisions_soft
Whether or not the warden can enable/disable soft collisions. This is enabled by default, but you can disable this if you do not want the wardens to be able to handle soft collisions.
sm_jailbreak_warden_collisions_hard
Whether or not the warden can enable/disable hard collisions. This is enabled by default, but you can disable this if you do not want the wardens to be able to handle hard collisions.
sm_jailbreak_criticals
This defines who gets 100% critical hits. There are 1 of 5 possible values:
0
- Nobody. Nobody gets a 100% critical hit chance. This is the TF2 default.1
- The red team.2
- The blue team (default).3
- The warden.
sm_jailbreak_balance_algorithm
This defines the balancing algorithm used by jailbreak by default. There are 1 of 2 possible values:
0
- None. This means that red and blue are never balanced, and the convarsm_jailbreak_balance_ratio
is ignored. This is not ideal unless you implement your own balance algorithm (in which case, you should useOnJailbreakPreBalance
and returnPlugin_Handled
orPlugin_Stop
).1
- The default. This is the default algorithm, which tries to reach the ratio of blues to reds as defined by thesm_jailbreak_balance_ratio
convar. It starts by building a list of players that can be moved - if they're not in-game, or not on blue team, or have thesm_jailbreak_balance
override (which defaults to ROOT flag only), they cannot be moved. Otherwise, they are added to the list of players that can be moved. That list is sorted based on ping and score - high-ping, low-score players are placed at the top. It then moves each player over to the red team one by one until either the list is empty, or the balance is reached. Note that the list can run out, leaving the game unbalanced; this can only occur ifsm_jailbreak_balance
is abused. (Note: I may, in the future, add a variant of this algorithm that starts to ignore thesm_jailbreak_balance
override if not enough clients are in the list.)
sm_jailbreak_balance_ratio
The desired ratio of blues to reds. If crits are enabled for blues (default),
then this value should probably be 0.5
(default), although your milage may
vary. This is only effectual for the default balance algorithm. This has a
maximum of 3 blues to 1 red (but why would you ever want that??).
sm_jailbreak_group_freeday_count
The number of freedays that a last request can add to a freeday group. By default, this value is 3.
Commands
Some commands that are meant for warden can also be run by an admin at any time; this is checked for by a respective override. See the "Admin Override" description for which override is required.
sm_jailbreak_warden
- Aliases:
sm_warden
,sm_w
Run by a player. If there is a current warden, this is the same as
sm_jailbreak_checkwarden
; otherwise, it checks if the player is on blue,
and the server is in the middle of the round; if so, the player becomes
warden.
sm_jailbreak_unwarden
Aliases:
sm_unwarden
,sm_uw
Run by a player. If the player is the current warden, it removes the player's warden.
sm_jailbreak_checkwarden
- Aliases:
sm_checkwarden
,sm_cw
Run by a player. Checks to see who is the current warden.
sm_jailbreak_warden_friendlyfire
- Aliases:
sm_warden_friendlyfire
,sm_wff
- Admin Override:
sm_jailbreak_warden_friendlyfire
, default: Kick
Run by the warden. If the sm_jailbreak_warden_friendly_fire
is set
to true
, then this enables mp_friendlyfire
, disables
tf_avoidteammates
, and enables tf_avoidteammates_pushaway
.
sm_jailbreak_warden_softcollisions
- Aliases:
sm_warden_softcollisions
,sm_wsc
- Admin Override:
sm_jailbreak_warden_softcollisions
, default: Kick
Run by the warden. If the sm_jailbreak_warden_collisions_soft
is set
to true
, then this enables tf_avoidteammates_pushaway
(set to off
by default by the plugin).
sm_jailbreak_warden_hardcollisions
- Aliases:
sm_warden_hardcollisions
,sm_whc
- Admin Override:
sm_jailbreak_warden_hardcollisions
, default: Kick
Run by the warden. If the sm_jailbreak_warden_collisions_hard
is set
to true
, then this disables tf_avoidteammates
.
sm_jailbreak_warden_menu
- Aliases:
sm_warden_menu
,sm_wm
- Admin Override:
sm_jailbreak_warden_menu
, default: Kick
Run by the warden. This brings up the warden menu.
sm_jailbreak_warden_lastrequest
- Aliases:
sm_warden_lastrequest
,sm_givelr
- Admin Override:
sm_jailbreak_warden_lastrequest
, default: Kick
Run by the warden. This grants a last request to a prisoner. This takes an argument, containing the prisoner's name to target.
sm_jailbreak_forcewarden
- Aliases:
sm_forcewarden
,sm_afw
- Override:
sm_jailbreak_forcewarden
, default: Kick
Run by an admin. This forces a specific person to be warden, overriding whoever was previously was warden. While this will accept input out-of-round, please do not use this command out-of-round!
sm_jailbreak_removewarden
- Aliases:
sm_removewarden
,sm_arw
- Override:
sm_jailbreak_removewarden
, default: Kick
Run by an admin. This removes whoever is currently warden from being warden.
sm_jailbreak_forcefreeday
- Aliases:
sm_forcefreeday
,sm_aff
- Override:
sm_jailbreak_forcefreeday
, default: Slay
Run by an admin. This forces a player into a freeday mode immediately. This works for both reds and blues.
sm_jailbreak_revokefreeday
- Aliases:
sm_revokefreeday
,sm_arf
- Override:
sm_jailbreak_revokefreeday
, default: Slay
Run by an admin. This forces a player that is in a freeday mode out of it immediately. This only works for players who are in freeday mode, but can apply to both reds and blues.