Skip to content

Commit

Permalink
docs: 💥 Rebranded referenced to Improved Match Timer
Browse files Browse the repository at this point in the history
Convars remain unchanged as that would create uneccisary work for tournament organizers who would then have to update all their configs. The goal of this fork is not to create more work, but to create less.
  • Loading branch information
Shigbeard committed Jun 8, 2024
1 parent 9e96d08 commit a023f5f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ The Progressive Ruleset ("Pro Ruleset" for short) incorporates this plugin that
# Why Use This Plugin?
All current competitive rulesets for the 5CP gametype include a timer that sets a hard time limit on matches. Match timers reduce competitive integrity in the 5CP gametype. In its current form, the timer kills comebacks, causes anticlimactic endings, and encourages teams to run down the clock.

Improved Match Timer reduces the length of matches without encouraging timer related strategies. It allows for exciting comebacks, makes every match end in a last capture, and discourages running down the clock.
Enhanced Match Timer reduces the length of matches without encouraging timer related strategies. It allows for exciting comebacks, makes every match end in a last capture, and discourages running down the clock.

# How to Install
You'll need SourceMod installed on your server before installing Improved Match Timer.
You'll need SourceMod installed on your server before installing Enhanced Match Timer.

Place the addons folder into the tf directory.

# How to Use
Improved Match Timer creates a new cvar named "mp_timelimit_improved" which is by default 0. This means that the plugin by default does nothing. I recommend that you change this cvar only through ruleset related configs. I've provided a modified rgl_6s_5cp_scrim config that contains "mp_timelimit_improved 1" as an example.
Enhanced Match Timer creates a new cvar named "mp_timelimit_improved" which is by default 0. This means that the plugin by default does nothing. I recommend that you change this cvar only through ruleset related configs. I've provided a modified rgl_6s_5cp_scrim config that contains "mp_timelimit_improved 1" as an example.

The plugin is only active on cp_ maps when mp_timelimit is above 0 and mp_timelimit_improved is set to 1. These conditions must be met before the match begins. If the plugin is active, you should see the phrase "Running Improved Match Timer..." in chat after the match starts. If you need to toggle the plugin, simply exec a config with mp_timelimit_improved changed before readying up.
The plugin is only active on cp_ maps when mp_timelimit is above 0 and mp_timelimit_improved is set to 1. These conditions must be met before the match begins. If the plugin is active, you should see the phrase "Running Enhanced Match Timer..." in chat after the match starts. If you need to toggle the plugin, simply exec a config with mp_timelimit_improved changed before readying up.

Additionally, the plugin will not activate if the score difference is greater than the threshold defined by mp_timelimit_improved_threshold. For instance, if this convar is set to 1, then the win difference between both teams must be 1 or lower in order to activate the plugin. If the timer expires with a win difference of 2 or more, the match would end as normal.

Expand All @@ -27,4 +27,4 @@ The Progressive Ruleset ("Pro Ruleset" for short) incorporates this plugin that

sm_improvedtimers_chat: If 1 (default), prints timer related notifications to chat.

mp_timelimit_improved_threshold: The win difference threshold for activating the improved match timer features. Anything above this number of rounds between the teams will end the match at the end of the timer. Set to -1 to disable (default)
mp_timelimit_improved_threshold: The win difference threshold for activating the Enhanced Match Timer features. Anything above this number of rounds between the teams will end the match at the end of the timer. Set to -1 to disable (default)

0 comments on commit a023f5f

Please sign in to comment.