Strafe hud

-- Strafe trainer HUD for StrafesNET games

-- Defaults for the preferences menu; anything changed there is saved to PREFS_FILE.
local DEFAULT_PREFS = {
	reset = Enum.KeyCode.E, -- clears jump history and averages
	menu = Enum.KeyCode.Semicolon, -- the ':' key; Roblox reports it unshifted
	scale = 1,
	height = 100, -- px from the bottom of the screen to the panel
	opacity = 55, -- panel background, %
	popups = true,
	-- Custom crosshair (xh); replaces the game's cursor crosshair while on.
	crosshair = true,
	xhStyle = "cross", -- cross, crossdot, x, circle, dot
	xhLength = 6,
	xhGap = 4,
	xhThickness = 2,
	xhDynamic = true, -- widen the gap while turning; off keeps the crosshair static
	xhSpread = 6, -- extra gap in px at full turn rate
	xhRotation = 0,
	xhOutline = true,
	xhHue = 0,
	xhSat = 0,
	xhVal = 1,
	xhAlpha = 1,
}
local PREFS_FILE = "strafe_trainer_prefs.json"

-- Fixed to match how the game reads movement, so they stay out of the menu.
local TURN_DEADZONE = 0.5 -- rad/s of yaw before a frame counts as "turning"
local SPEED_WINDOW = 0.1 -- seconds of position samples used for speed
local AIR_MARGIN = 0.3 -- studs above the ground baseline that count as airborne
local HISTORY = 10 -- jumps in the rolling average
local RAY_LENGTH = 50
local MIN_STRAFE_SPEED = 2 -- studs/s; slower than this there's no velocity to strafe across
local LATERAL_MIN = 0.5 -- sin of the angle between keys and velocity; under it the keys push along, not across

-- Used when the game's style can't be read: every key allowed, like Autohop.
local FALLBACK_STYLE = { name = "Autohop", keys = { w = 1, a = 1, s = 1, d = 1 } }
local STYLE_KEY = { forward = "w", left = "a", back = "s", right = "d" } -- move -> the game's key field
-- The game's movement keys; the style decides which of them count.