Documentation
¶
Index ¶
- Constants
- func AddRemapRule(ctx context.Context, db *sql.DB, q *dbq.Queries, itemID int64, ruleType string, ...) (position int64, err error)
- func CheckTargetCanBeDisabled(t dbq.Target, u TargetUsage) error
- func ClearRemapConfig(ctx context.Context, db *sql.DB, q *dbq.Queries, itemID int64) (cleared bool, err error)
- func CopyDeployRules(ctx context.Context, db *sql.DB, q *dbq.Queries, srcItemID, dstItemID int64) (skipBackup, writeOnce int, err error)
- func CopyRemapConfig(ctx context.Context, db *sql.DB, q *dbq.Queries, srcItemID, dstItemID int64) (copied int, err error)
- func CopySkipBackupPatterns(ctx context.Context, db *sql.DB, q *dbq.Queries, srcItemID, dstItemID int64) (copied int, err error)
- func CopyWriteOncePatterns(ctx context.Context, db *sql.DB, q *dbq.Queries, srcItemID, dstItemID int64) (copied int, err error)
- func EnabledTargets(targets []dbq.Target) []dbq.Target
- func EnsureRemapConfig(ctx context.Context, qtx *dbq.Queries, itemID int64) (int64, error)
- func EnsureTargetEnabled(t dbq.Target) error
- func FormatNotesLines(notes string) string
- func FullSelector(storeID, storeGameID, instanceID string) string
- func IsBinaryContent(data []byte) bool
- func NormalizeStoreID(s string) string
- func NotesTextFromArg(arg string, stdin io.Reader) (string, error)
- func ParseInt64(s string) (int64, bool)
- func ParseSelector(s string) (storeID, storeGameID, instanceID string, err error)
- func ResolveTarget(targets []dbq.Target, requested string) (dbq.Target, error)
- func RewriteProfilePriorities(ctx context.Context, qtx *dbq.Queries, profileID int64, ...) error
- func SetProfileItemEnabled(ctx context.Context, profile *dbq.Profile, q *dbq.Queries, versionID int64, ...) (changed bool, err error)
- func ShortSelector(storeID, storeGameID, instanceID string) string
- func TargetEnabled(t dbq.Target) bool
- type RefreshChange
- type RefreshChangeKind
- type RefreshResult
- type TargetUsage
- type UserDirs
Constants ¶
const DefaultTargetName = "game_dir"
DefaultTargetName is the target used when a command isn't told which one to use.
Variables ¶
This section is empty.
Functions ¶
func AddRemapRule ¶
func AddRemapRule(ctx context.Context, db *sql.DB, q *dbq.Queries, itemID int64, ruleType string, intVal sql.NullInt64, textVal sql.NullString, overridePos int64) (position int64, err error)
AddRemapRule adds a single remap rule to the config for a profile item, creating the config if it does not exist yet. The position is auto-assigned as MAX(position)+1 unless overridePos is >= 0. It returns the position the rule was added at.
func CheckTargetCanBeDisabled ¶ added in v0.8.0
func CheckTargetCanBeDisabled(t dbq.Target, u TargetUsage) error
CheckTargetCanBeDisabled returns an error explaining why an enabled target can't be disabled: it still has installed files, profile items or overrides pointing at it, or it is the last enabled target.
func ClearRemapConfig ¶
func ClearRemapConfig(ctx context.Context, db *sql.DB, q *dbq.Queries, itemID int64) (cleared bool, err error)
ClearRemapConfig deletes all remap rules for a profile item's config and removes the config itself, leaving remap_config_id NULL on the profile item. No-op if the profile item has no remap config. It reports whether there was a config to clear.
func CopyDeployRules ¶ added in v0.6.0
func CopyDeployRules(ctx context.Context, db *sql.DB, q *dbq.Queries, srcItemID, dstItemID int64) (skipBackup, writeOnce int, err error)
CopyDeployRules copies skip-backup and write-once patterns from one profile item to another. If the destination already has patterns of either kind they are replaced. If the source has no patterns for a given kind that kind is a no-op. It returns the number of patterns copied for each kind.
func CopyRemapConfig ¶
func CopyRemapConfig(ctx context.Context, db *sql.DB, q *dbq.Queries, srcItemID, dstItemID int64) (copied int, err error)
CopyRemapConfig copies remap rules from one profile item to another within the same profile. If the destination already has a config its rules are replaced. If the source has no config this is a no-op. It returns the number of rules copied.
func CopySkipBackupPatterns ¶ added in v0.6.0
func CopySkipBackupPatterns(ctx context.Context, db *sql.DB, q *dbq.Queries, srcItemID, dstItemID int64) (copied int, err error)
CopySkipBackupPatterns copies skip-backup patterns from one profile item to another within the same profile. If the destination already has patterns they are replaced. If the source has no patterns this is a no-op. It returns the number of patterns copied.
func CopyWriteOncePatterns ¶ added in v0.6.0
func CopyWriteOncePatterns(ctx context.Context, db *sql.DB, q *dbq.Queries, srcItemID, dstItemID int64) (copied int, err error)
CopyWriteOncePatterns copies write-once patterns from one profile item to another within the same profile. If the destination already has patterns they are replaced. If the source has no patterns this is a no-op. It returns the number of patterns copied.
func EnabledTargets ¶ added in v0.8.0
EnabledTargets returns the enabled subset of targets, preserving order.
func EnsureRemapConfig ¶
EnsureRemapConfig returns the existing remap_config_id for a profile item, or creates a new one and links it to the profile item within the provided transaction if none exists yet.
func EnsureTargetEnabled ¶ added in v0.8.0
EnsureTargetEnabled returns an error if the target is disabled.
func FormatNotesLines ¶ added in v0.8.0
FormatNotesLines renders freeform notes for display under a "notes:" label. A single line stays on the label's line; multi-line notes start on the next line, indented, so they read as one block.
func FullSelector ¶
FullSelector always includes the instance (even if it's "default").
Example: steam:1091500#default
func IsBinaryContent ¶ added in v0.6.0
IsBinaryContent reports whether data appears to be binary by scanning for null bytes in the first 8KB, matching the heuristic used by Git and other tools.
func NormalizeStoreID ¶ added in v0.8.0
NormalizeStoreID normalizes a store id the way store ids are stored and compared: trimmed and lowercased. Store ids are meant to be stable identifiers like "steam", so we normalize them to avoid surprising mismatches.
func NotesTextFromArg ¶ added in v0.8.0
NotesTextFromArg returns the notes text given as a command argument. If the argument is "-" the text is read from stdin instead. Trailing newlines are trimmed so that piped input doesn't store them; everything else, including interior newlines and surrounding spaces, is kept exactly as given.
func ParseInt64 ¶
func ParseSelector ¶
ParseSelector parses either: - store:game - store:game#instance
If instance is omitted, it returns instanceID="default".
func ResolveTarget ¶ added in v0.8.0
ResolveTarget picks the install target for a command from the targets of a game install. A requested name must exist and be enabled. With no name the default target (game_dir) is used if it is enabled; if it isn't, the only enabled target is used, and it is an error to have to guess between several.
func RewriteProfilePriorities ¶
func RewriteProfilePriorities( ctx context.Context, qtx *dbq.Queries, profileID int64, items []dbq.ListProfileItemsForOrderRow, start, step int64, ) error
RewriteProfilePriorities rewrites priorities for the given ordered items.
It is safe under UNIQUE(profile_id, priority) because it first shifts all existing priorities out of the way by an offset, then assigns final values.
start is the first priority value to assign (for compact: 1). step is the increment between consecutive priorities (for compact: 1; for --multiple N: N).
func SetProfileItemEnabled ¶
func SetProfileItemEnabled(ctx context.Context, profile *dbq.Profile, q *dbq.Queries, versionID int64, enabled bool) (changed bool, err error)
SetProfileItemEnabled enables or disables the profile item for a mod file version. It reports whether anything changed: false means the item was already in the requested state.
func ShortSelector ¶
ShortSelector includes the instance only if it isn't "default".
Example: steam:1091500 Example: steam:1091500#library_2
func TargetEnabled ¶ added in v0.8.0
TargetEnabled reports whether the target takes part in planning.
Types ¶
type RefreshChange ¶ added in v0.8.0
type RefreshChange struct {
Name string
Kind RefreshChangeKind
}
RefreshChange is what a refresh found out about one install.
type RefreshChangeKind ¶ added in v0.8.0
type RefreshChangeKind int
RefreshChangeKind says what a refresh found out about an install.
const ( RefreshNew RefreshChangeKind = iota // seen for the first time RefreshReturned // was missing and has come back RefreshUpdated // seen again, as before RefreshMissing // was present and has gone )
type RefreshResult ¶ added in v0.2.0
type RefreshResult struct {
New []string // display names of newly discovered installs
Updated []string // display names of installs seen again (already present)
Returned []string // display names of installs that were missing and came back
Missing []string // display names of installs that disappeared
Skipped []string // display names of installs that were filtered out
// Warnings are the non-fatal problems found along the way, in the order
// they were found.
Warnings []string
// Changes is what happened to each install, in the order to show them:
// the installs that disappeared first, then the ones that were found.
Changes []RefreshChange
}
func ScanStores ¶
ScanStores rescans every enabled store, in the directories of the user dirs, and updates the game installs in the database. It prints nothing: what it found is in the result. If it fails part way, the result still holds the warnings found up to then.
type TargetUsage ¶ added in v0.8.0
type TargetUsage struct {
InstalledFiles int64 // files recorded as installed through the target
ProfileItems int64 // profile items deploying to the target
Overrides int64 // overrides defined for the target
EnabledTargets int64 // enabled targets for the game install, counting this one
}
TargetUsage describes what still depends on a target.
type UserDirs ¶ added in v0.9.0
type UserDirs struct {
// Home is the home directory of the user, which is what "~" is in the
// paths that the stores keep. It is empty for a user that has none, and
// then what is in it is not looked for.
Home string
// DataHome is the directory for the data of the programs of the user
// ($XDG_DATA_HOME). It is empty if it is not known.
DataHome string
}
UserDirs are the directories of the user that the stores are looked for in. They are what a store is told, and not something that it finds out: a scan looks nowhere that it is not told to, so a test can have a user of its own.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package argresolver turns what a command is given (a flag or an argument) into what it names, in the database of modctl, and says what is wrong when it can't.
|
Package argresolver turns what a command is given (a flag or an argument) into what it names, in the database of modctl, and says what is wrong when it can't. |
|
Package config is the configuration of modctl: what it is when nothing has been said, what a config file says, and how the file is changed.
|
Package config is the configuration of modctl: what it is when nothing has been said, what a config file says, and how the file is changed. |
|
Package extractor handles extraction of mod archives to a staging directory and deployment of files into the game target directory.
|
Package extractor handles extraction of mod archives to a staging directory and deployment of files into the game target directory. |
|
Package lock provides per-game-install exclusive locking for apply and unapply operations.
|
Package lock provides per-game-install exclusive locking for apply and unapply operations. |
|
Package patchapply applies structured patch entries to ini, yaml, and json files.
|
Package patchapply applies structured patch entries to ini, yaml, and json files. |
|
Package planner computes the desired file state for a profile apply or unapply.
|
Package planner computes the desired file state for a profile apply or unapply. |
|
Package remap implements the remap rule engine for modctl.
|
Package remap implements the remap rule engine for modctl. |
|
Package style holds how modctl looks in a terminal, so that no command formats its own output:
|
Package style holds how modctl looks in a terminal, so that no command formats its own output: |
|
Package updatechain works out where a file stands against the updates that Nexus Mods knows about for its mod: whether something newer has replaced it, and whether that newer file has already been imported.
|
Package updatechain works out where a file stands against the updates that Nexus Mods knows about for its mod: whether something newer has replaced it, and whether that newer file has already been imported. |