sm-plugins/crouchboostfix
1
0
Fork 0
mirror of https://github.com/t5mat/crouchboostfix.git synced 2025-12-06 18:08:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
mat 2022-01-25 13:36:56 +02:00
parent f1770526c7
commit 976fff8f92
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,30 +1,31 @@
# boostfix # crouchboostfix
A [SourceMod](https://www.sourcemod.net/about.php) plugin for CS:GO servers which fixes buggy push triggers & prevents crouchboosting. A [SourceMod](https://www.sourcemod.net/about.php) plugin that prevents crouchboosting.
"Crouchboosting" is the act of crouching/uncrouching while touching a trigger in order to exit and then immediately enter it again. In the case of push triggers, or triggers with `AddOutput basevelocity`, this results in unintentional speed boosts. Crouchboosting is easier on higher tickrates, and can be done pretty consistently on *surf_cookiejar*'s start for example.
## Usage ## Usage
- `boostfix_pushfix <0/1>` (default 1) - Enables the [original pushfix implementation](https://forums.alliedmods.net/showthread.php?t=267131) `crouchboostfix_enabled <0/1>` (default 1) - Enables/disables the plugin
- `boostfix_crouchboostfix <0/1>` (default 1) - Prevents crouchboosting on push triggers ## Installation
**[EndTouchFix](https://github.com/rumourA/End-Touch-Fix)** is required.
## Notes ## Notes
- **This plugin requires [EndTouchFix](https://github.com/rumourA/End-Touch-Fix) to work correctly** Use **[PushFixDE](https://github.com/GAMMACASE/PushFixDE)** to fix client prediction errors in push triggers. This plugin is incompatible with any other [pushfix](https://forums.alliedmods.net/showthread.php?t=267131) implementation.
- **This plugin requires [RNGFix](https://github.com/jason-e/rngfix) gamedata**
- **This plugin should NOT be used alongside pushfix.** If you're running [SurfTimer](https://github.com/surftimer/Surftimer-Official), pushfix is [built-in](https://github.com/surftimer/Surftimer-Official/blob/b6a71e9ebde21cb865464c932de116baec199bf6/addons/sourcemod/scripting/surftimer/hooks.sp#L713) and should be disabled for this plugin to work correctly.
- **This plugin prevents crouchboosting ONLY on push triggers.** The same functionality can be applied for trigger_multiple boosts (surf_whiteout b1) or any other trigger, but requires a more in-depth integration with the timer plugin being used.
## Technical Overview ## Technical Overview
"Crouchboosting" is the act of crouching/uncrouching while touching a trigger in order to exit and then immediately enter it again. In the case of push triggers, this results in unintentional speed boosts. Crouchboosting is easier on higher tickrates, and can be done pretty consistently on surf_cookiejar for example. When a player starts touching a trigger too soon after their last EndTouch, and either:
When a player starts touching a push trigger too soon after their last EndTouch, and either:
- their last EndTouch was caused by a mid-air duck, or - their last EndTouch was caused by a mid-air duck, or
- this StartTouch was caused by a mid-air unduck - this StartTouch was caused by a mid-air unduck
... this StartTouch is considered "invalid", and the plugin disables pushing so the player doesn't get boosted again. ... the player is considered to have crouchboosted.
In this case,
- For `trigger_multiple/trigger_push/trigger_gravity`, outputs are prevented from being queued (`OnStartTouch/OnEndTouch`) until after the next EndTouch
- For `trigger_push`, pushing is prevented until after the next EndTouch