ui

Documentation

Overview

Package ui provides interactive CLI menus, progress checklists, visual detection summaries, and actionable error guidance for gamux.

Index

• func CleanBBCode(input string) string
• func ClearProgress()
• func FormatBytes(b int64) string
• func NotifyIssue(ctx context.Context, title, message string) error
• func PromptSelectPlatform(gameTitle string, availablePlatforms []string) (string, error)
• func PromptString(promptText string, defaultValue string) string
• func PromptYesNoWithExplanation(question string, explanation string, defaultYes bool) bool
• func RenderAppHelp(app *cli.App, version string)
• func RenderCommandHelp(cmd *cli.Command, version string)
• func RenderConfigSummary(cfg *config.Config, configPath string)
• func RenderDetectionSummary(info DetectionInfoSummary)
• func RenderErrorHelp(err error, suggestedActions []string)
• func RenderHeader(version string)
• func RenderNewsItem(gameTitle string, index int, title, feedLabel, contents, url string, ...)
• func RenderProgress(current, total int, item string)
• func RenderStep(stepNum, totalSteps int, title string)
• func RenderSubStep(symbol, message string)
• func RenderSuccess(title, details string, nextSteps []string)
• func RenderTerseHeader(parentDir string, totalGames int)
• func RenderTerseStatus(info DetectionInfoSummary)
• func RenderTerseSummary(total, loaderCount, cleanCount, updatesAvail, lutrisCount int)
• func RunConfigWizard(cfg *config.Config, configPath string) error
• type CandidateItem
  • func PromptSelectCandidate(query string, candidates []CandidateItem) (CandidateItem, error)
• type DetectionInfoSummary
• type LaunchCandidateSummary
  • func PromptSelectLaunchOption(gameTitle string, candidates []LaunchCandidateSummary) (LaunchCandidateSummary, error)
• type NewsItemSummary

Functions

func CleanBBCode

func CleanBBCode(input string) string

CleanBBCode strips Steam community BBCode tags for clean terminal rendering.

func ClearProgress

func ClearProgress()

ClearProgress clears the current progress bar line in the terminal.

func FormatBytes

func FormatBytes(b int64) string

FormatBytes formats byte counts into human-readable strings (e.g. 1.29 GiB).

func NotifyIssue

func NotifyIssue(ctx context.Context, title, message string) error

NotifyIssue presents an alert on the console (stderr) and sends a non-intrusive desktop notification via notify-send if available.

func PromptSelectPlatform

func PromptSelectPlatform(gameTitle string, availablePlatforms []string) (string, error)

PromptSelectPlatform presents an interactive choice for target platform/depot selection.

func PromptString

func PromptString(promptText string, defaultValue string) string

PromptString asks for text input with a default value.

func PromptYesNoWithExplanation

func PromptYesNoWithExplanation(question string, explanation string, defaultYes bool) bool

PromptYesNoWithExplanation asks a yes/no question with an explanatory hint.

func RenderAppHelp

func RenderAppHelp(app *cli.App, version string)

RenderAppHelp displays a clean, concise, single-source workflow guide from cli.App.

func RenderCommandHelp

func RenderCommandHelp(cmd *cli.Command, version string)

RenderCommandHelp displays clean formatted help for a specific subcommand.

func RenderConfigSummary

func RenderConfigSummary(cfg *config.Config, configPath string)

RenderConfigSummary displays a formatted dashboard of all configuration fields.

func RenderDetectionSummary

func RenderDetectionSummary(info DetectionInfoSummary)

RenderDetectionSummary prints a visual preview of detected game metadata.

func RenderErrorHelp

func RenderErrorHelp(err error, suggestedActions []string)

RenderErrorHelp displays a formatted error diagnostic box with suggested actions.

func RenderHeader

func RenderHeader(version string)

RenderHeader displays the application banner and version.

func RenderNewsItem

func RenderNewsItem(gameTitle string, index int, title, feedLabel, contents, url string, date int64)

RenderNewsItem prints a full, clean formatted patch note item.

func RenderProgress

func RenderProgress(current, total int, item string)

RenderProgress renders a clean single-line progress bar with current/total count and item label.

func RenderStep

func RenderStep(stepNum, totalSteps int, title string)

RenderStep prints a progress step indicator.

func RenderSubStep

func RenderSubStep(symbol, message string)

RenderSubStep prints a detail item under the current step.

func RenderSuccess

func RenderSuccess(title, details string, nextSteps []string)

RenderSuccess prints a final success summary box.

func RenderTerseHeader

func RenderTerseHeader(parentDir string, totalGames int)

RenderTerseHeader outputs a clean section header for batch/terse inspection.

func RenderTerseStatus

func RenderTerseStatus(info DetectionInfoSummary)

RenderTerseStatus prints a crisp 2-line card for a game directory.

func RenderTerseSummary

func RenderTerseSummary(total, loaderCount, cleanCount, updatesAvail, lutrisCount int)

RenderTerseSummary prints summary stats after batch inspection.

func RunConfigWizard

func RunConfigWizard(cfg *config.Config, configPath string) error

RunConfigWizard guides the user interactively through updating their configuration.

Types

type CandidateItem

type CandidateItem struct {
	AppID uint32
	Name  string
}

CandidateItem holds metadata for presenting an AppID selection prompt.

func PromptSelectCandidate

func PromptSelectCandidate(query string, candidates []CandidateItem) (CandidateItem, error)

PromptSelectCandidate presents an interactive menu to disambiguate game title search matches.

type DetectionInfoSummary

type DetectionInfoSummary struct {
	Name     string
	AppID    string
	Store    string
	Platform string

	GameDir           string
	ExePath           string
	LaunchCandidates  []LaunchCandidateSummary
	State             string
	OriginalBackups   int
	ManifestID        string
	BuildID           string
	DiskSizeBytes     int64
	FileCount         int
	OfficialFileCount int
	ModifiedFiles     []string
	MissingFiles      []string
	UntrackedFiles    []string
	HasUpdate         bool
	RemoteManifestID  string
	DLCCount          int
	AchievementCount  int
	LutrisRegistered  bool
	RecentPatchNote   string
	NewsItems         []NewsItemSummary
}

DetectionInfoSummary holds metadata for displaying a rich game status dashboard.

type LaunchCandidateSummary

type LaunchCandidateSummary struct {
	Name        string
	Executable  string
	Arguments   string
	Description string
}

LaunchCandidateSummary holds information about an executable launch option.

func PromptSelectLaunchOption

func PromptSelectLaunchOption(gameTitle string, candidates []LaunchCandidateSummary) (LaunchCandidateSummary, error)

PromptSelectLaunchOption presents an interactive choice for executable / launch option selection.

type NewsItemSummary

type NewsItemSummary struct {
	Title     string
	FeedLabel string
	Date      int64
	URL       string
}

NewsItemSummary holds metadata for rendering patch notes.