@gamecrate/cli 1.4.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -2
- package/dist/gamecrate.js +2752 -1002
- package/dist/lib.js +101 -2
- package/dist/types/cli/args.d.ts +6 -3
- package/dist/types/cli/output.d.ts +1 -1
- package/dist/types/cli/profile.d.ts +6 -1
- package/dist/types/cli/steam.d.ts +27 -0
- package/dist/types/config/load.d.ts +5 -0
- package/dist/types/config/validate.d.ts +23 -0
- package/dist/types/docker/preflight.d.ts +1 -1
- package/dist/types/docker/run.d.ts +8 -0
- package/dist/types/docker/spec.d.ts +12 -2
- package/dist/types/image/base.d.ts +11 -0
- package/dist/types/image/build.d.ts +26 -0
- package/dist/types/image/crane.d.ts +27 -0
- package/dist/types/image/gate.d.ts +18 -0
- package/dist/types/image/input.d.ts +40 -0
- package/dist/types/image/tags.d.ts +23 -0
- package/dist/types/launch/image.d.ts +45 -0
- package/dist/types/launch/prepare.d.ts +4 -10
- package/dist/types/launch/updates.d.ts +35 -0
- package/dist/types/mods/steamcmd.d.ts +34 -0
- package/dist/types/plugin.d.ts +1 -1
- package/dist/types/types.d.ts +54 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,7 +12,11 @@ set, and launches the game. Without at least one plugin, it has no games to run.
|
|
|
12
12
|
|
|
13
13
|
## Install
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
```sh
|
|
16
|
+
npm install -g @gamecrate/cli @gamecrate/rimworld
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
To run an unreleased change, build it from a clone of the monorepo instead:
|
|
16
20
|
|
|
17
21
|
```sh
|
|
18
22
|
git clone https://github.com/RimWorks/gamecrate.git
|
|
@@ -22,7 +26,7 @@ npm run build
|
|
|
22
26
|
npm install -g ./packages/cli
|
|
23
27
|
```
|
|
24
28
|
|
|
25
|
-
|
|
29
|
+
That build needs [bun](https://bun.sh) and Node 22 or newer.
|
|
26
30
|
|
|
27
31
|
## First launch
|
|
28
32
|
|
|
@@ -76,6 +80,7 @@ two mods, and starts the game.
|
|
|
76
80
|
| [Mod sources](docs/mod-sources.md) | Pin a mod to a directory, a git repository, or a workshop item gamecrate downloads, and learn which copy wins |
|
|
77
81
|
| [The `mods` commands](docs/mods-commands.md) | Add, remove, and sync library pins from the command line |
|
|
78
82
|
| [Running](docs/running.md) | Launch, run in the background, read the result, close a window, and clean up |
|
|
83
|
+
| [Game images](docs/images.md) | Build a launchable image from a game you own on Steam |
|
|
79
84
|
| [Reference](docs/reference.md) | Every subcommand, flag, environment variable, and exit code |
|
|
80
85
|
| [Writing a plugin](docs/plugins.md) | Teach gamecrate a new game |
|
|
81
86
|
|