mirror of
https://github.com/mwpenny/portal64-still-alive.git
synced 2024-10-20 10:37:37 -04:00
168 lines
4.7 KiB
Markdown
168 lines
4.7 KiB
Markdown
# Portal64
|
|
|
|
|
|
A demake of Portal for the Nintendo 64.
|
|
|
|
## How to build
|
|
|
|
First, you will need to setup [Modern SDK](https://crashoveride95.github.io/n64hbrew/modernsdk/startoff.html).
|
|
|
|
After installing modern sdk you will want to also install
|
|
|
|
```
|
|
sudo apt install libnustd
|
|
```
|
|
|
|
Next, you will need to download Blender 3.0 or higher. Then set the environment variable `BLENDER_3_0` to be the absolute path where the Blender executable is located on your system.
|
|
|
|
```
|
|
sudo apt install blender
|
|
```
|
|
|
|
e.g. add this to your ~/.bashrc
|
|
|
|
```
|
|
export BLENDER_3_0="/usr/bin/blender"
|
|
```
|
|
|
|
<br />
|
|
|
|
You will need to install Python `vpk`.
|
|
```
|
|
pip install vpk
|
|
```
|
|
|
|
<br />
|
|
|
|
Install `vtf2png`, `sfz2n64`, and setup `skeletool64`.
|
|
```sh
|
|
echo "deb [trusted=yes] https://lambertjamesd.github.io/apt/ ./" \
|
|
| sudo tee /etc/apt/sources.list.d/lambertjamesd.list
|
|
sudo apt update
|
|
sudo apt install vtf2png sfz2n64 mpg123 sox imagemagick
|
|
```
|
|
|
|
<br />
|
|
|
|
Install lua5.4 (remove other perhaps installed versions first, skelatool64 needs to be build with luac 5.4!)
|
|
|
|
```
|
|
sudo apt install lua5.4 liblua5.4-dev liblua5.4-0
|
|
```
|
|
|
|
<br />
|
|
|
|
Setup and build skelatool64 (the version included in this portal64 repo!)
|
|
|
|
```
|
|
cd skelatool64
|
|
./setup_dependencies.sh
|
|
make
|
|
```
|
|
|
|
<br />
|
|
|
|
You will need to install nodejs. You can use apt for this
|
|
|
|
```
|
|
sudo apt install nodejs
|
|
```
|
|
|
|
<br />
|
|
|
|
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!)
|
|
```
|
|
portal/portal_pak_000.vpk
|
|
portal/portal_pak_001.vpk
|
|
portal/portal_pak_002.vpk
|
|
portal/portal_pak_003.vpk
|
|
portal/portal_pak_004.vpk
|
|
portal/portal_pak_005.vpk
|
|
portal/portal_pak_dir.vpk
|
|
|
|
hl2/hl2_sound_misc_000.vpk
|
|
hl2/hl2_sound_misc_001.vpk
|
|
hl2/hl2_sound_misc_002.vpk
|
|
hl2/hl2_sound_misc_dir.vpk
|
|
```
|
|
|
|
Finally, run `make` to build the project.
|
|
|
|
<br />
|
|
|
|
|
|
## Build with Docker
|
|
|
|
|
|
Build the Docker image.
|
|
```
|
|
docker build . -t portal64
|
|
```
|
|
|
|
<br />
|
|
|
|
Then build.
|
|
```sh
|
|
# Set the environment variable
|
|
BLENDER_3_0=/blender/blender
|
|
|
|
# Build using docker
|
|
docker run \
|
|
-v /home/james/Blender/blender-2.93.1-linux-x64:/blender \
|
|
-e BLENDER_3_0 -v /home/james/portal/portal64/vpk:/usr/src/app/vpk \
|
|
-t -v /home/james/portal/portal64/docker-output:/usr/src/app/build portal64
|
|
```
|
|
|
|
<br />
|
|
|
|
Where `/home/james/Blender/blender-2.93.1-linux-x64` is the folder where Blender is located.
|
|
|
|
`/home/james/portal/portal64/vpk` is the folder where the portal `*.vpk` files are located.
|
|
|
|
`/home/james/portal/portal64/docker-output` is where you want the output of the build to locate `portal.z64` will be put into this folder.
|
|
|
|
<br />
|
|
|
|
## Current New Feature TODO List
|
|
- [ ] force placing auto portals when there is a conflict
|
|
- [ ] rotate auto uv
|
|
- [ ] disable portal surfaces manually on some surfaces
|
|
- [ ] Portal not rendering recursively sometimes
|
|
- [ ] Correct elevator timing
|
|
- [ ] Presort portal gun polygon order
|
|
- [ ] Adding a menu to game #47
|
|
- [ ] Adding y-axis/x-axis inverting options #55
|
|
- [ ] Adding loading notice between levels #45
|
|
- [ ] Vertex lighting #39
|
|
- [ ] Multi controller support #23
|
|
- [x] Camera shake
|
|
- [x] Portal gun movement with player movement/shooting #19
|
|
|
|
## Current New Sounds TODO List
|
|
- [ ] Box collision sounds
|
|
- [ ] Unstationary scaffolding moving sound
|
|
- [ ] Ambient background loop
|
|
- [x] Button release beep-beep sound
|
|
- [x] Elevator arrived chime sound
|
|
- [x] Ball catcher activated sound
|
|
- [x] Fast flying air whoosh sound
|
|
|
|
## Current Bug TODO List (Hardware Verified) (High->Low priority)
|
|
- [ ] investigate chell animation
|
|
----------------------- v8
|
|
- [ ] Player can clip through chamber 7 by walking back up the stairs (near the top).
|
|
- [ ] player can clip through back of elevator by jumping and strafeing at the back corners while inside.
|
|
- [ ] Player can trap themselves in chamber 5 by following instructions issue #75
|
|
- [ ] Two wall portals next to eachother can be used to clip any object out of any level by pushing it into corner, then dropping.
|
|
- [ ] Glass can be walked through from one side on multiple levels (0,1,4,...)
|
|
- [ ] Passing into a ceiling portal can sometimes mess with the player rotation
|
|
- [ ] Can shoot portals, and walk through signage
|
|
- [ ] Chell animation problem (fixed itself, investigate)
|
|
- [ ] Can place portals on ground after final fizzler on all levels
|
|
- [ ] Door at end of room 2, chamber 10 isnt rendered properly
|
|
- [ ] various visual glitches when running NTSC on PAL console #65
|
|
- [ ] various visual glitches when running PAL on NTSC console #65
|
|
- [x] Any grabbable object can be clipped through level by wall/floor portals method.
|
|
- [x] Player can clip through any level by placing one portal on wall and another portal right next to it on ground. #13
|
|
- [x] Can shoot portals while holding an object
|