ToggleSprint default off¶

Tap your Sprint or Sneak key once to keep it held; tap again to let go. A status line shows what your movement is doing. Some servers forbid this kind of mod.

Identifier: toggle-sprint
Tab: HUD
Default: Off. Inside it, toggle sprint is on and toggle sneak is off.
HUD element: Yes, the status line. Bottom left, offset 4, 4.
Writes: The pressed state of the vanilla Sprint and Sneak key bindings; with Flight boost on, your own flight speed
Sends anything: No

Check the server's rules first

Some servers forbid toggle-sprint and toggle-sneak mods. The module is off by default for that reason. Xol does not claim that any server permits it.

What it does¶

While a toggle is on, the module keeps that vanilla key binding in its pressed state, with the same call the game itself makes for a real key press. That is the whole effect.

It never sets sprinting or sneaking on the player and never touches movement.
Whether you actually sprint is still decided by the game, by every one of its rules.
No packet is added, delayed, reordered, canceled or edited. The game behaves as it does while the key is physically held.

Tap or hold¶

A short press of the key you bound to vanilla Sprint (or Sneak) flips the toggle. A press that turned the toggle on and is then held for longer than 0.3 seconds counts as a normal hold, so letting go turns it off again. The toggle only reacts while the module is on, you are in a world and no screen is open.

Sneak is never a toggle while you fly or ride, where the game needs the key held.

When it lets go¶

Situation	Behavior
A screen is open (inventory, chat, menus)	The module leaves the keys alone. The game releases every key while a screen is open, and the module does not fight that; the toggle comes back when the screen closes.
You tap the key again	The toggle turns off, and the key returns to its real physical state.
You switch the module off	The keys are released and the toggles cleared.
You leave the world or change world	The keys are released and the toggles cleared.

Flight boost¶

Off by default. While you fly in creative or spectator mode and hold the Sprint key, your local flight speed is multiplied by Boost amount. It does nothing in survival or adventure mode, and your flight speed goes back to normal as soon as you let go or stop flying. This changes how fast you move, which is why it is off unless you switch it on.

Status line¶

With Show status text on, the element shows one of:

Text	Meaning
`Sprinting (Toggled)`	The sprint toggle is on
`Sprinting (Key Held)`	You are physically holding the Sprint key
`Sprinting (Vanilla)`	You are sprinting without either, for example after a double tap forward
`Sneaking (Toggled)`	The sneak toggle is on
`Sneaking (Key Held)`	You are physically holding the Sneak key
`Flying`, `Flying (4x boost)`	You are flying, with the boost amount while Flight boost is active
`Descending`	Sneaking while flying
`Riding`	You are riding something
`Dismounting`	Sneaking while riding
nothing	None of the above

The HUD editor shows Sprinting (Toggled) as its sample. With the status line off, the toggles still work; the module just draws nothing.

Settings¶

Setting	Identifier	Type	Options or range	Default	Description
Toggle sprint	`toggle-sprint`	On or off		On	Tap the Sprint key to keep it held. Off: the key works as it does in vanilla.
Toggle sneak	`toggle-sneak`	On or off		Off	Tap the Sneak key to keep it held. It is never a toggle while you fly or ride, where the key has to be held.
Flight boost	`fly-boost`	On or off		Off	While flying in creative or spectator mode, hold the Sprint key to fly faster. It never does anything in survival.
Boost amount	`fly-boost-amount`	Decimal	1 to 10x, step 0.5	4x	How much faster than normal flight.
Show status text	`status-text`	On or off		On	Show the line that says whether you are sprinting, sneaking, flying or riding.
Format	`style`	Choice	Sprinting (Toggled) · [ Sprinting (Toggled) ] · Custom	Sprinting (Toggled)	How the text is put together.

The status line is a text element and also has the shared text rows and the visibility rows every HUD element has.

Multiplayer¶

Holds the vanilla Sprint and Sneak key state for you and nothing else: every vanilla rule still applies and no packet is added or changed. Flight boost, which is off unless you switch it on, raises your local flight speed while the Sprint key is held, and only while you are flying in creative or spectator mode. Some servers forbid toggle-sprint and toggle-sneak mods; check their rules.

See Multiplayer and fair play for how every module is reviewed.