@gamecrate/cli 1.4.0 → 2.0.0

package/dist/types/types.d.ts

@@ -78,6 +78,14 @@ export interface ImageSpec {
     acquire: 'pull' | 'build';
     /** Required when acquire is "build". */
     context?: string;
+    updates?: UpdateCheckSpec;
+}
+/** Whether a launch looks for a newer game build, and how often it bothers. */
+export interface UpdateCheckSpec {
+    /** Default true. */
+    check?: boolean;
+    /** Hours between checks for one image. Default 6. 0 checks every launch. */
+    everyHours?: number;
 }
 /** How the engine is told where its data directory is. Verified per game. */
 export type DataDirSpec = {
@@ -155,11 +163,37 @@ export interface ProfileConfig {
     aliases?: string[];
     /** A one-line note for `gamecrate list`. Never read by the launcher. */
     description?: string;
+    /** A tag on the game's own image repository, e.g. "2.0". `image` and --image beat it. */
+    gameVersion?: string;
+    /** A whole image ref, used verbatim. Beaten only by --image. */
+    image?: string;
     /** Launch defaults for this profile. The matching --no-* flag overrides each one. */
     detach?: boolean;
     replace?: boolean;
     build?: BuildPolicy;
 }
+/** One image built from a steam depot. The first entry of `variants` is the default. */
+export interface SteamVariant {
+    name: string;
+    depot?: 'linux' | 'windows' | 'macos';
+    base: 'xvfb' | 'proton' | 'none';
+    include: string[];
+    executable?: string;
+}
+/** A steam branch to download from. The first entry of `branches` is the default. */
+export interface SteamBranch {
+    name: string;
+    password?: boolean;
+    /** Extra moving tags for this branch, beside the version and `latest` forms. */
+    tags?: string[];
+    /** Executable per variant name, when this branch ships a different one. */
+    executable?: Record<string, string>;
+}
+/** How a plugin's game image gets built from steam. */
+export interface SteamBuildSpec {
+    branches: SteamBranch[];
+    variants: SteamVariant[];
+}
 export interface GameConfig {
     gameFiles: GameFilesSpec;
     dataDir: DataDirSpec;
@@ -179,6 +213,11 @@ export interface GameConfig {
     prefs: {
         file: string;
     };
+    /** Where the engine writes its version string. */
+    version: {
+        file: string;
+    };
+    steamBuild: SteamBuildSpec;
     /** Filename suffixes that mean "a save". `clean --all` counts them before it deletes. */
     saveExtensions: string[];
     core: string;
@@ -420,8 +459,20 @@ export interface ParsedArgs {
     supervised: boolean;
     /** `-f`: keep printing as the run writes, instead of dumping what is there. */
     follow: boolean;
-    /** The write verb under `mods`. Unset means the read verb. */
-    subverb?: 'add' | 'rm' | 'sync';
+    /** The write verb under `mods`, or the verb under `steam`. Unset means the read verb. */
+    subverb?: 'add' | 'rm' | 'sync' | 'build' | 'login';
+    /** `steam build`: repeatable filters on the two axes. */
+    variant?: string[];
+    branches?: string[];
+    /** Repeatable plugin package specifiers. */
+    plugin?: string[];
+    image?: string;
+    load?: boolean;
+    push?: boolean;
+    base?: string;
+    platform?: string;
+    print?: boolean;
+    username?: string;
     /** Where `mods add` pulls the mod from. */
     source?: {
         kind: 'path';
@@ -444,7 +495,7 @@ export interface ParsedArgs {
     force?: boolean;
     rest: string[];
 }
-export type ProjectDefaults = Partial<Omit<ParsedArgs, 'subcommand' | 'cleanTier' | 'yes' | 'help' | 'rest' | 'profile' | 'supervised' | 'noDetach' | 'noReplace' | 'follow' | 'subverb' | 'source' | 'target' | 'force'>> & {
+export type ProjectDefaults = Partial<Omit<ParsedArgs, 'subcommand' | 'cleanTier' | 'yes' | 'help' | 'rest' | 'profile' | 'supervised' | 'noDetach' | 'noReplace' | 'follow' | 'subverb' | 'source' | 'target' | 'force' | 'variant' | 'branches' | 'plugin' | 'image' | 'load' | 'push' | 'base' | 'platform' | 'print' | 'username'>> & {
     /** Replaces the old `profile:` key. Falls back to the first entry in `profiles`. */
     defaultProfile?: string;
     /** Validated by validateConfig after the splice, not here. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gamecrate/cli",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "Run a modded game in a container, with mods resolved from your local checkouts.",
   "license": "MIT",
   "type": "module",