config

Documentation

Overview

Package config is the model for the player's personal settings — today the audio volume and mute plus speedrun best times — kept separate from assets, levels and saves. It is a pure leaf: the struct, its defaults, and the one policy constant. Reading and writing the file (a denshi-style Filo script) lives in filoio, like every other Linefire document, so this package imports nothing and no cycle forms.

Index

• Constants
• Variables
• func BuildString() string
• type Config
  • func Default() Config

Constants

const MinBestTicks = 60

MinBestTicks is the smallest clear time accepted as a record. A real clear cannot be near-instant, so this rejects glitch/edge-case ~0 times (e.g. re-entering an already-cleared map) from ever being stored — a last-line guard for whatever the store is (local Filo config today, an online leaderboard later). ~1s at 60 TPS.

Variables

var Version = "dev"

Version is the build's release tag, set once at startup from main.Version (which the shared release script stamps with -ldflags). It lives here so any package can read it without importing main, and defaults to "dev" for a plain `go build`.

Functions

func BuildString

func BuildString() string

BuildString describes the running build for a HUD corner, a bug report or -version. The tag alone is not enough to identify a build made outside the release script, so a dev build is followed by the commit it came from — and a "+" when the worktree was dirty. That commit costs nothing to obtain: the Go toolchain records it in the build info, and it survives -trimpath.

Types

type Config

type Config struct {
	Volume    float64        // master audio volume, 0..1
	Muted     bool           //
	BestTimes map[string]int // map name -> best clear time in ticks (speedrun records)
	HighScore int            // best score across all runs (the arcade HI score)
}

Config is the persisted settings document.

func Default

func Default() Config

Default is the configuration of a fresh install.