ui

Documentation

Overview

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

Index

• func PromptString(promptText string, defaultValue string) string
• func PromptYesNoWithExplanation(question string, explanation string, defaultYes bool) bool
• func RenderAppHelp(version string)
• func RenderDetectionSummary(info DetectionInfoSummary)
• func RenderErrorHelp(err error, suggestedActions []string)
• func RenderHeader(version string)
• func RenderStep(stepNum, totalSteps int, title string)
• func RenderSubStep(symbol, message string)
• func RenderSuccess(title, details string, nextSteps []string)
• type DetectionInfoSummary

Functions

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(version string)

RenderAppHelp displays a friendly, hand-holdy quickstart guide and command reference.

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 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.

Types

type DetectionInfoSummary

type DetectionInfoSummary struct {
	Name            string
	AppID           string
	Platform        string
	GameDir         string
	ExePath         string
	State           string
	OriginalBackups int
}

DetectionInfoSummary holds metadata for displaying a detection preview.