mirror/jak-project
1
0
Fork 0
mirror of https://github.com/open-goal/jak-project synced 2026-06-03 02:30:13 -04:00
Code Issues Packages Projects Releases Wiki Activity

game: cleanup gk's CLI documentation (#2189)

Browse Source 
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 `$@`


![image](https://user-images.githubusercontent.com/13153231/222035309-b6601719-cdc9-40ee-b36e-e4b135d3f128.png)
This commit is contained in:
Tyler Wilding
2023-03-09 20:02:25 -05:00
committed by GitHub
parent 0db9b288e4
commit 2f6bfd2e64
18 changed files with 203 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/goalc/framework/test_runner.cpp
+27 -16
View File
@@ -107,34 +107,45 @@ void CompilerTestRunner::run_always_pass(const std::string& test_category,
}
void runtime_no_kernel_jak1() {
constexpr int argc = 6;
const char* argv[argc] = {"", "-fakeiso", "-debug", "-nokernel", "-nodisplay", "-nosound"};
exec_runtime(argc, const_cast<char**>(argv));
constexpr int argc = 5;
const char* argv[argc] = {"", "-fakeiso", "-debug", "-nokernel", "-nosound"};
GameLaunchOptions game_options;
game_options.disable_display = true;
exec_runtime(game_options, argc, const_cast<char**>(argv));
}
void runtime_no_kernel_jak2() {
constexpr int argc = 7;
const char* argv[argc] = {"", "-fakeiso", "-debug", "-nokernel",
"-nodisplay", "-nosound", "-jak2"};
exec_runtime(argc, const_cast<char**>(argv));
constexpr int argc = 5;
const char* argv[argc] = {"", "-fakeiso", "-debug", "-nokernel", "-nosound"};
GameLaunchOptions game_options;
game_options.disable_display = true;
game_options.game_version = GameVersion::Jak2;
exec_runtime(game_options, argc, const_cast<char**>(argv));
}
void runtime_with_kernel_jak1() {
constexpr int argc = 5;
const char* argv[argc] = {"", "-fakeiso", "-debug", "-nodisplay", "-nosound"};
exec_runtime(argc, const_cast<char**>(argv));
constexpr int argc = 4;
const char* argv[argc] = {"", "-fakeiso", "-debug", "-nosound"};
GameLaunchOptions game_options;
game_options.disable_display = true;
exec_runtime(game_options, argc, const_cast<char**>(argv));
}
void runtime_with_kernel_jak2() {
constexpr int argc = 6;
const char* argv[argc] = {"", "-fakeiso", "-debug", "-nodisplay", "-nosound", "-jak2"};
exec_runtime(argc, const_cast<char**>(argv));
constexpr int argc = 4;
const char* argv[argc] = {"", "-fakeiso", "-debug", "-nosound"};
GameLaunchOptions game_options;
game_options.disable_display = true;
game_options.game_version = GameVersion::Jak2;
exec_runtime(game_options, argc, const_cast<char**>(argv));
}
void runtime_with_kernel_no_debug_segment() {
constexpr int argc = 5;
const char* argv[argc] = {"", "-fakeiso", "-debug-mem", "-nodisplay", "-nosound"};
exec_runtime(argc, const_cast<char**>(argv));
constexpr int argc = 4;
const char* argv[argc] = {"", "-fakeiso", "-debug-mem", "-nosound"};
GameLaunchOptions game_options;
game_options.disable_display = true;
exec_runtime(game_options, argc, const_cast<char**>(argv));
}
void createDirIfAbsent(const std::string& path) {