achievements

type Achievement struct {
	Def
	Unlocked   bool     `json:"unlocked"`
	UnlockedAt int64    `json:"unlockedAt,omitempty"` // unix seconds; 0 when unlocked at an unknown time
	Progress   float64  `json:"progress,omitempty"`
	Max        float64  `json:"max,omitempty"`
	Percent    *float64 `json:"percent,omitempty"` // share of all players who have it (Steam's global stats)
}

type Cache struct {
	Dir string
}

type Def struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	Desc     string `json:"desc,omitempty"`
	Icon     string `json:"icon,omitempty"`     // https URL or a local file; the interface gets /ach/ URLs
	IconGray string `json:"iconGray,omitempty"` // the locked icon
	Hidden   bool   `json:"hidden,omitempty"`
}

type Deps struct {
	Env           Env
	Lang          string // Steam's language name: "english", "german", …
	SteamRoot     string
	SteamAccounts []string // userdata account ids, the one in use first
	SteamKey      string   // the user's Steam Web API key ("" = none)
	SteamID       string   // steamID64 of the account in use
	Net           Net      // nil: nothing is asked online
	// EpicLocale is Epic's name for Lang ("de", "en-US", …).
	EpicLocale string
	// Epic returns a signed-in Epic account's access token; nil when
	// nobody is signed in.
	Epic func(ctx context.Context) (access, account string, err error)
	// GalaxyDB is GOG Galaxy's database ("" when there's none) and
	// GOGUnlocks reads a game's unlocks from it.
	GalaxyDB   string
	GOGUnlocks func(gogID string) (map[string]Unlock, error)
	// GOG returns a signed-in GOG account's access token and user id; nil
	// when nobody is signed in.
	GOG     func(ctx context.Context) (access, userID string, err error)
	Offline bool // don't go online now (a game is running)
	// UplayGames counts the library's games on a Uplay emulator: with only
	// one, the lone achievements folder there must be its.
	UplayGames int
	Cache      *Cache
	Icons      *Icons
}

type EmuGame struct {
	Dir      string // install folder
	EmuDir   string // relative to Dir: where the emulator sits
	Emulator string // as the scan named it ("Goldberg", "RUNE", …)
	AppID    int    // Steam app id the emulator runs as
	EpicID   string // for Nemirtinga's Epic emulator
}

type EmuResult struct {
	Source  string            // emuSource name
	File    string            // the file read
	Unlocks map[string]Unlock // by ID, or by SSEHash(ID) when Hashed
	Hashed  bool
}

type Entry struct {
	Stamp string `json:"stamp"` // what the result was made from; see Stamp
	Net   bool   `json:"net"`   // part of it came from a store's servers
	List  List   `json:"list"`
}

type Env struct {
	Roaming, Local, Public, ProgramData, Documents string
}

type Icons struct {
	Dir   string
	Fetch func(ctx context.Context, src, dir string) (string, error) // download, check, store; returns the file name
	Store func(dir string, data []byte) (string, error)              // check and store local data
	// contains filtered or unexported fields
}

type List struct {
	GameID    int64         `json:"gameId"`
	Source    string        `json:"source"` // "steam", "epic", "gog", "Goldberg", "CODEX", …; "" when none was found
	Total     int           `json:"total"`
	Unlocked  int           `json:"unlocked"`
	Items     []Achievement `json:"items"`
	UpdatedAt int64         `json:"updatedAt"`
	Hint      string        `json:"hint,omitempty"` // what's missing, and how to get it
	// Fix is something Seaglass can do about the hint: FixUplayINI.
	Fix string `json:"fix,omitempty"`
	// Partial: time ran out before every icon was stored; read it again later.
	Partial bool `json:"-"`
}

type Net interface {
	SteamAchievementSchema(ctx context.Context, key string, appID int, lang string) ([]Def, error)
	SteamPlayerAchievements(ctx context.Context, key, steamID string, appID int) (map[string]Unlock, error)
	SteamRarity(ctx context.Context, appID int) (map[string]float64, error)
	EpicAchievements(ctx context.Context, sandbox, locale string) ([]Def, map[string]float64, error)
	EpicPlayerAchievements(ctx context.Context, access, account, sandbox string) (map[string]Unlock, error)
	GOGAchievements(ctx context.Context, access, game, userID string) ([]Def, map[string]Unlock, map[string]float64, error)
}

type Unlock struct {
	Achieved bool
	At       int64 // unix seconds; 0 when unknown
	Progress float64
	Max      float64
}