mirror of
https://github.com/open-goal/jak-project
synced 2026-06-06 11:47:44 -04:00
game: cleanup gk's CLI documentation (#2189)
An attempt to cleanup the last CLI interface we have left to cleanup. - `gk` args now follow the typical convention ie. `--proj-path` instead of `-proj-path`. - args that are passed through to the rest of the application / the game's runtime use the typical convention of following a `--` - I'm thinking some args shouldn't be handled at this level ie (`-nodisplay`, `-vm`, `-novm` or `-jak2`) These could be better documented as legitimate flags and passed in via a nice struct. They don't seem to be used in `InitParams` but I'll triple check. There's a temporary shim here so there is no coupled release with the launcher (right now it executes `gk` with a few args). So I just change the old args into the new format. After one release cycle, I can change it in the launcher and delete it here. I am unsure if this will break the bash shellscript usages -- not sure which args were usually passed into `$@` 
This commit is contained in:
+3
-6
@@ -45,21 +45,21 @@ tasks:
|
||||
- sh: test -f {{.GK_BIN_RELEASE_DIR}}/gk{{.EXE_FILE_EXTENSION}}
|
||||
msg: "Couldn't locate runtime executable in '{{.GK_BIN_RELEASE_DIR}}/gk'"
|
||||
cmds:
|
||||
- "{{.GK_BIN_RELEASE_DIR}}/gk -boot -fakeiso -debug -v"
|
||||
- "{{.GK_BIN_RELEASE_DIR}}/gk -v --game {{.GAME}} -- -boot -fakeiso -debug"
|
||||
boot-game-retail:
|
||||
desc: "Boots the game without debug mode, it will fail if it's not already compiled!"
|
||||
preconditions:
|
||||
- sh: test -f {{.GK_BIN_RELEASE_DIR}}/gk{{.EXE_FILE_EXTENSION}}
|
||||
msg: "Couldn't locate runtime executable in '{{.GK_BIN_RELEASE_DIR}}/gk'"
|
||||
cmds:
|
||||
- "{{.GK_BIN_RELEASE_DIR}}/gk -boot -fakeiso -v"
|
||||
- "{{.GK_BIN_RELEASE_DIR}}/gk -v --game {{.GAME}} -- -boot -fakeiso"
|
||||
run-game:
|
||||
desc: "Start the game's runtime, to start the game itself the REPL is required"
|
||||
preconditions:
|
||||
- sh: test -f {{.GK_BIN_RELEASE_DIR}}/gk{{.EXE_FILE_EXTENSION}}
|
||||
msg: "Couldn't locate runtime executable in '{{.GK_BIN_RELEASE_DIR}}/gk'"
|
||||
cmds:
|
||||
- "{{.GK_BIN_RELEASE_DIR}}/gk -fakeiso -debug -{{.GAME}} -v"
|
||||
- "{{.GK_BIN_RELEASE_DIR}}/gk -v --game {{.GAME}} -- -fakeiso -debug"
|
||||
# DEVELOPMENT
|
||||
repl:
|
||||
desc: "Start the REPL"
|
||||
@@ -77,9 +77,6 @@ tasks:
|
||||
ignore_error: true
|
||||
- cmd: npx prettier --write ./decompiler/config/jak2/**/*.jsonc
|
||||
ignore_error: true
|
||||
run-game-headless:
|
||||
cmds:
|
||||
- "{{.GK_BIN_RELEASE_DIR}}/gk -fakeiso -debug -nodisplay"
|
||||
# DECOMPILING
|
||||
decomp:
|
||||
cmds:
|
||||
|
||||
Reference in New Issue
Block a user