Merge pull request #345 from hackgrid/fix-readme-2
fix Makefile and update docs
This commit is contained in:
commit
5584f4c89c
4
Makefile
4
Makefile
|
@ -331,7 +331,7 @@ build/src/menu/new_game_menu.o: build/src/audio/clips.h build/assets/materials/u
|
||||||
build/src/menu/options_menu.o: build/assets/materials/ui.h
|
build/src/menu/options_menu.o: build/assets/materials/ui.h
|
||||||
build/src/menu/save_game_menu.o: build/src/audio/clips.h
|
build/src/menu/save_game_menu.o: build/src/audio/clips.h
|
||||||
build/src/scene/scene_animator.o: build/src/audio/clips.h
|
build/src/scene/scene_animator.o: build/src/audio/clips.h
|
||||||
build/src/levels/intro.o: build/src/audio/clips.h
|
build/src/levels/intro.o: build/src/audio/clips.h build/assets/materials/images.h
|
||||||
build/src/menu/savefile_list.o: build/assets/materials/ui.h build/src/audio/clips.h
|
build/src/menu/savefile_list.o: build/assets/materials/ui.h build/src/audio/clips.h
|
||||||
build/src/player/player.o: build/assets/models/player/chell.h build/assets/materials/static.h build/src/audio/subtitles.h
|
build/src/player/player.o: build/assets/models/player/chell.h build/assets/materials/static.h build/src/audio/subtitles.h
|
||||||
build/src/scene/ball_catcher.o: build/assets/models/props/combine_ball_catcher.h build/assets/materials/static.h build/assets/models/dynamic_animated_model_list.h
|
build/src/scene/ball_catcher.o: build/assets/models/props/combine_ball_catcher.h build/assets/materials/static.h build/assets/models/dynamic_animated_model_list.h
|
||||||
|
@ -576,4 +576,4 @@ clean-assets:
|
||||||
fix:
|
fix:
|
||||||
wine tools/romfix64.exe build/portal.z64
|
wine tools/romfix64.exe build/portal.z64
|
||||||
|
|
||||||
.SECONDARY:
|
.SECONDARY:
|
51
README.md
51
README.md
|
@ -50,14 +50,16 @@ export BLENDER_3_0="/usr/bin/blender"
|
||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
You will need to install Python `vpk`.
|
You will need to install Python `vpk`
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
pip install vpk
|
pip install vpk
|
||||||
```
|
```
|
||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
Install `vtf2png`, `sfz2n64`, and setup `skeletool64`.
|
Setup and install dependencies for `skeletool64`
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
echo "deb [trusted=yes] https://lambertjamesd.github.io/apt/ ./" \
|
echo "deb [trusted=yes] https://lambertjamesd.github.io/apt/ ./" \
|
||||||
| sudo tee /etc/apt/sources.list.d/lambertjamesd.list
|
| sudo tee /etc/apt/sources.list.d/lambertjamesd.list
|
||||||
|
@ -94,35 +96,40 @@ sudo apt install nodejs
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
You will need to add at least one of the following files from where Portal is installed to the folder `resource/`. You can add multiple languages if desired.
|
You will need to add at least one of the following files from where Portal is installed to the folder `resource/`. You can add multiple languages if desired.
|
||||||
|
|
||||||
```
|
```
|
||||||
portal/resource/closecaption_english.txt
|
portal/resource/closecaption_english.txt
|
||||||
portal/resource/closecaption_<your desired language 1>.txt
|
portal/resource/closecaption_<your desired language 1>.txt
|
||||||
portal/resource/closecaption_<your desired language 2>.txt
|
portal/resource/closecaption_<your desired language 2>.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
You then need to add the following files from where Portal is installed to the folder `vpk`. (see vpk/add_vpk_here.md for more details!)
|
You then need to add the following files from where Portal is installed to the folder `vpk/` OR create a symbolic link to the `Portal` folder there. (see [vpk/add_vpk_here.md](./vpk/add_vpk_here.md) for more details!)
|
||||||
|
|
||||||
```
|
```
|
||||||
portal/portal_pak_000.vpk
|
Portal/portal/portal_pak_000.vpk
|
||||||
portal/portal_pak_001.vpk
|
Portal/portal/portal_pak_001.vpk
|
||||||
portal/portal_pak_002.vpk
|
Portal/portal/portal_pak_002.vpk
|
||||||
portal/portal_pak_003.vpk
|
Portal/portal/portal_pak_003.vpk
|
||||||
portal/portal_pak_004.vpk
|
Portal/portal/portal_pak_004.vpk
|
||||||
portal/portal_pak_005.vpk
|
Portal/portal/portal_pak_005.vpk
|
||||||
portal/portal_pak_dir.vpk
|
Portal/portal/portal_pak_dir.vpk
|
||||||
|
|
||||||
hl2/hl2_sound_misc_000.vpk
|
Portal/hl2/hl2_sound_misc_000.vpk
|
||||||
hl2/hl2_sound_misc_001.vpk
|
Portal/hl2/hl2_sound_misc_001.vpk
|
||||||
hl2/hl2_sound_misc_002.vpk
|
Portal/hl2/hl2_sound_misc_002.vpk
|
||||||
hl2/hl2_sound_misc_dir.vpk
|
Portal/hl2/hl2_sound_misc_dir.vpk
|
||||||
|
|
||||||
hl/hl2_misc_000.vpk
|
Portal/hl2/hl2_misc_000.vpk
|
||||||
hl/hl2_misc_001.vpk
|
Portal/hl2/hl2_misc_001.vpk
|
||||||
hl/hl2_misc_002.vpk
|
Portal/hl2/hl2_misc_002.vpk
|
||||||
hl/hl2_misc_003.vpk
|
Portal/hl2/hl2_misc_003.vpk
|
||||||
hl/hl2_misc_dir.vpk
|
Portal/hl2/hl2_misc_dir.vpk
|
||||||
|
|
||||||
|
Portal/hl2/media/valve.bik
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, run `make` to build the project.
|
Finally, run `make` to build the project.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Clean out any previous build files
|
# Clean out any previous build files
|
||||||
make clean
|
make clean
|
||||||
|
@ -137,6 +144,7 @@ make fix
|
||||||
```
|
```
|
||||||
|
|
||||||
Alternatively, you can also prepare to build with additional audio languages, like this (multiple commands per build possible):
|
Alternatively, you can also prepare to build with additional audio languages, like this (multiple commands per build possible):
|
||||||
|
|
||||||
```
|
```
|
||||||
make french_audio
|
make french_audio
|
||||||
make german_audio
|
make german_audio
|
||||||
|
@ -146,11 +154,12 @@ make spanish_audio
|
||||||
You still have run `make` after this.
|
You still have run `make` after this.
|
||||||
|
|
||||||
Also you can build with all audio languages integrated with this shortcut:
|
Also you can build with all audio languages integrated with this shortcut:
|
||||||
|
|
||||||
```
|
```
|
||||||
make all_languages
|
make all_languages
|
||||||
```
|
```
|
||||||
|
|
||||||
This requires additional *.vpk files:
|
This requires additional *.vpk files copied to the folder `vpk/`:
|
||||||
|
|
||||||
- German:
|
- German:
|
||||||
```
|
```
|
||||||
|
@ -183,6 +192,7 @@ portal/portal_sound_vo_spanish_dir.vpk
|
||||||
Using the docker image the only setup step you need is to populating the vpk folder. After that you can build the docker image using
|
Using the docker image the only setup step you need is to populating the vpk folder. After that you can build the docker image using
|
||||||
|
|
||||||
Build the Docker image.
|
Build the Docker image.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make -f Makefile.docker image
|
make -f Makefile.docker image
|
||||||
```
|
```
|
||||||
|
@ -190,6 +200,7 @@ make -f Makefile.docker image
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
Then build the rom using
|
Then build the rom using
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make -f Makefile.docker
|
make -f Makefile.docker
|
||||||
```
|
```
|
||||||
|
|
|
@ -2,9 +2,13 @@
|
||||||
|
|
||||||
Copy the entire Portal folder, or create a symbolic link, in this folder
|
Copy the entire Portal folder, or create a symbolic link, in this folder
|
||||||
|
|
||||||
`ln -s SteamLibrary\steamapps\common\Portal\ Portal`
|
```
|
||||||
|
ln -s SteamLibrary\steamapps\common\Portal\ Portal
|
||||||
|
```
|
||||||
|
|
||||||
|
- If you want multi-language support, copy `portal_sound_vo_*.vpk` files commonly found in `SteamLibrary\steamapps\common\Portal\` to this directory.
|
||||||
|
(these files need to be copied, because the original Portal keeps only the files of ONE language at a time)
|
||||||
|
|
||||||
- If you want multi-language support, copy `portal_sound_vo_*.vpk` files commonly found in `SteamLibrary\steamapps\common\Portal\` to this directory
|
|
||||||
- German:
|
- German:
|
||||||
```
|
```
|
||||||
portal/portal_sound_vo_german_000.vpk
|
portal/portal_sound_vo_german_000.vpk
|
||||||
|
@ -38,8 +42,8 @@ vpk/
|
||||||
portal_sound_vo_german_dir.vpk
|
portal_sound_vo_german_dir.vpk
|
||||||
portal_sound_vo_french_000.vpk
|
portal_sound_vo_french_000.vpk
|
||||||
portal_sound_vo_french_dir.vpk
|
portal_sound_vo_french_dir.vpk
|
||||||
portal/portal_sound_vo_russian_000.vpk
|
portal_sound_vo_russian_000.vpk
|
||||||
portal/portal_sound_vo_russian_dir.vpk
|
portal_sound_vo_russian_dir.vpk
|
||||||
portal/portal_sound_vo_spanish_000.vpk
|
portal_sound_vo_spanish_000.vpk
|
||||||
portal/portal_sound_vo_spanish_dir.vpk
|
portal_sound_vo_spanish_dir.vpk
|
||||||
```
|
```
|
Loading…
Reference in a new issue