From 8d989dfa7d93f2a32b04a62fd31d38a28f56c9cf Mon Sep 17 00:00:00 2001 From: Mikusch Date: Mon, 18 Jan 2021 10:56:39 +0100 Subject: [PATCH] Add recommended configuration to README --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 37dcfed..9fd8759 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ -# Team Fortress 2 Bunnyhopping +# Team Fortress 2 Bunnyhop This is a simple SourceMod plugin that allows players to bunnyhop in Team Fortress 2. -Unlike most other bunnyhop plugins, this implementation makes you jump before the engine zeroes out your z-velocity, preserving 100% of your speed and making each jump feel buttery smooth. +Unlike most other bunnyhop plugins, this implementation makes you jump before the engine zeroes out your z-velocity, +preserving 100% of your speed and making each jump feel buttery smooth. ## Features @@ -11,7 +12,7 @@ Unlike most other bunnyhop plugins, this implementation makes you jump before th * Works well even with high ping * Allows jumping while ducked * Unlimited speed while bunnyhopping - * Prevents `CTFGameMovement::PreventBunnyJumping` from getting called + * Prevents `CTFGameMovement::PreventBunnyJumping` from clamping your speed * Support for TF2-specific actions in mid-air (e.g. Scout's air dash, B.A.S.E. Jumper parachute, etc.) * Fully compatible with my [all-class air dash](https://github.com/Mikusch/air-dash) plugin @@ -22,8 +23,17 @@ Unlike most other bunnyhop plugins, this implementation makes you jump before th ## ConVars +The plugin creates the following console variables, configurable in `cfg/sourcemod/plugin.tf-bhop.cfg`: + * `sv_enablebunnyhopping ( def. "1" )` - Allow player speed to exceed maximum running speed * `sv_autobunnyhopping ( def. "1" )` - Players automatically re-jump while holding jump button * `sv_duckbunnyhopping ( def. "1" )` - Allow jumping while ducked -It is recommended to set `sv_airaccelerate` to at least `150` if you intend to use this plugin. +### Recommended Configuration + +I recommend the following server configuration for a smooth experience. These are personal preference, so choose values that you are comfortable with: + +``` +sv_airaccelerate 150 // Increase acceleration when in the air +tf_parachute_maxspeed_xy 99999.9f // Prevent speed clamping when deploying a parachute +```