You are viewing a potentially older version of this package. View all versions.
Cray-ShotSpeedometer-0.1.0 icon

ShotSpeedometer

Adds a live MPH/KPH speed readout to the ball's worldspace icon while the ball is in motion.

By Cray
Date uploaded 3 months ago
Version 0.1.0
Download link Cray-ShotSpeedometer-0.1.0.zip
Downloads 50
Dependency string Cray-ShotSpeedometer-0.1.0

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2305 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2305

README

ShotSpeedometer

A small BepInEx mod for Super Battle Golf that adds a live speed readout to the ball's existing worldspace icon. Whenever your ball is moving, the icon now shows both the vanilla distance-from-player number and a second line with the ball's current speed in MPH or KPH. The label hides itself once the ball comes to rest.

The unit follows your existing distance-unit setting:

Distance unit Speed unit
Yards MPH
Meters KPH

Speed is the full 3D rigidbody velocity magnitude, so it matches what real-world golf radars quote (ball speed, not just horizontal speed).

Installation

Install via r2modman / Thunderstore Mod Manager. The mod is purely visual and only renders for your own ball (or the ball of the player you're spectating), matching the vanilla worldspace-icon behavior.

Configuration

BepInEx/config/sbg.shotspeedometer.cfg is generated on first run. Available settings:

  • Display.HideAtRest (default true) — hide the speed line when the ball is stationary.
  • Display.MinSpeedToShow (default 0.3) — speed threshold (in m/s) below which the label hides when HideAtRest is true. Lower values keep it visible longer at low rolls.

Build / deploy / release

Standard SBG-mod workflow:

dotnet build -c Release              # auto-deploys to r2modman Default profile
pwsh tools/package.ps1               # artifacts/Cray-ShotSpeedometer-<ver>.zip
gh release create vX.Y.Z artifacts/Cray-ShotSpeedometer-<ver>.zip --notes-file CHANGELOG.md

CHANGELOG

Changelog

v0.2.0

  • Read the game's dedicated SpeedUnit setting (KilometersPerHour / MilesPerHour) and subscribe to SpeedUnitChanged instead of piggybacking on the distance-unit toggle. Fixes a bug where some players' label stayed in MPH after switching the in-game speed unit, because the distance unit hadn't changed in the same session.

v0.1.0

  • Initial release.
  • Adds a live speed line (MPH/KPH) to the ball's worldspace icon, sharing the vanilla distance label's positioning, fade, and on/off-screen behavior.
  • Speed unit follows the game's distance setting (Yards → MPH, Meters → KPH).
  • Hides automatically when the ball comes to rest.