diff --git a/README.md b/README.md index 1110f46ed1..fcb5c55882 100644 --- a/README.md +++ b/README.md @@ -244,13 +244,20 @@ Getting a running game involves 4 steps: #### Extract Assets -First, setup your settings so the following scripts know which game you are using, and which version. In a terminal, run the following: +First, setup your settings so the following scripts know which game you are using, and which version. For the black label version of the game, run the following in a terminal: ```sh task set-game-jak1 task set-decomp-ntscv1 ``` +For other versions of the game, you will need to use a different `-set-decomp-` command. An example for the PAL version: + +```sh +task set-game-jak1 +task set-decomp-pal +``` + > Run `task --list` to see the other available options > At the time of writing, only Jak 1 is expected to work end-to-end! @@ -292,6 +299,12 @@ Run the following to build the game: g > (mi) ``` +> IMPORTANT NOTE! If you're not using the black label version, you may hit issues trying to run `(mi)` in this step. An example error might include something like: +> +> `Input file iso_data/jak1/MUS/TWEAKVAL.MUS does not exist.` +> +> This is because other version paths are not currently accounted for in the build. A quick workaround is to rename both your `decompiler_out` and `iso_data` folders to use the black label naming, for example changing `decompiler_out/jak1_pal` to `decompiler_out/jak1` and `iso_data/jak1_pal` to `iso_data/jak1`, then running `(mi)` again. + #### Run the Game Finally the game can be ran. Open a second terminal from the `jak-project` directory and run the following: diff --git a/Taskfile.yml b/Taskfile.yml index 4e21371c15..d1cdd495a8 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -24,9 +24,13 @@ tasks: cmds: - 'python ./scripts/tasks/update-env.py --decomp_config ntscv2' set-decomp-pal: - - 'python ./scripts/tasks/update-env.py --decomp_config pal' + desc: "PAL region version" + cmds: + - 'python ./scripts/tasks/update-env.py --decomp_config pal' set-decomp-ntscjp: - - 'python ./scripts/tasks/update-env.py --decomp_config ntscjp' + desc: "NTSC-J region version" + cmds: + - 'python ./scripts/tasks/update-env.py --decomp_config ntscjp' # GENERAL extract: desc: "Extracts the game's assets from './iso_data' with the set decompiler config"