Skip to content

Commit 0a51e0f

Browse files
committed
update docs
1 parent 081d2a2 commit 0a51e0f

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
This is a novelty port of the sm64-port to DOS. Do not expect it to be playable.
44

5-
![Goddard](https://raw.githubusercontent.com/mkst/sm64-port/dos/media/screenshot_00.png)
5+
![Goddard](https://raw.githubusercontent.com/fgsfdsfgs/sm64-port/dos/media/screenshot_00.png)
66

7-
![In-game](https://raw.githubusercontent.com/mkst/sm64-port/dos/media/screenshot_01.png)
7+
![In-game](https://raw.githubusercontent.com/fgsfdsfgs/sm64-port/dos/media/screenshot_01.png)
8+
9+
![3Dfx in-game](https://raw.githubusercontent.com/fgsfdsfgs/sm64-port/dos/media/screenshot_02.png)
810

911
## Building Instructions
1012

@@ -22,17 +24,17 @@ Consult the [Dockerfile](./Dockerfile) for required libraries and steps.
2224

2325
For *best* performance:
2426
- Use `ENABLE_OPENGL_LEGACY=1` to enable the legacy OpenGL renderer
25-
- Use `DISABLE_SKYBOX=1` to avoid drawing the skybox
27+
- Use `DISABLE_SKYBOX=1` to avoid drawing the skybox (saves a lot of cycles in software mode)
2628
- Use `DISABLE_AUDIO=1` to save your ears and some CPU cycles
2729
- Use `DOS_GL=dmesa` to enable 3Dfx-backed OpenGL instead of software-backed (this only works with legacy OpenGL!)
2830

2931
### 3Dfx mode:
3032

31-
When `DOS_GL` is set to `dmesa`, the game will render using FXMesa, which is a Mesa driver that uses 3Dfx for rendering.
33+
When `DOS_GL` is set to `dmesa`, the game will render using FXMesa, which uses 3Dfx Glide for rendering.
3234
That means you will need a 3Dfx card (Voodoo II and above recommended, but will run on a Voodoo I probably) and appropriate
3335
drivers to run it.
3436

35-
The drivers can be obtained from this repository (see [lib/glide3/README.md](lib/glide3/README.md)). Put the appropriate
37+
The drivers can be obtained from this repository (see [this file](lib/glide3/drivers/README.md)). Put the appropriate
3638
`glide3x.dxe` file next to the EXE.
3739

3840
When running Windows 9x, you will have to reboot into DOS mode before running the game for this to work.
@@ -47,7 +49,7 @@ dosbox-x and PCem can emulate Voodoo cards for testing purposes.
4749

4850
## Controls
4951

50-
Controls can be editted as per the PC port, tweak the `SM64CONF.TXT` which is created with defaults upon first run.
52+
Controls can be edited as per the PC port, tweak the `SM64CONF.TXT` which is created with defaults upon first run.
5153

5254
## Project Structure
5355

@@ -66,7 +68,7 @@ sm64
6668
├── enhancements: example source modifications
6769
├── include: header files
6870
├── levels: level scripts, geo layout, and display lists
69-
├── lib: SDK library code
71+
├── lib: SDK library code and third party libraries
7072
├── rsp: audio and Fast3D RSP assembly code
7173
├── sound: sequences, sound samples, and sound banks
7274
├── src: C source code for game

lib/glide3/drivers/README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@ When you're using the 3Dfx renderer, you will need the appropriate Glide library
44

55
Pick a folder from the table below and copy `glide3x.dxe` from it to the game folder (next to the EXE).
66

7-
| Card | Folder |
8-
------------------------
9-
| Voodoo | `v1` |
10-
| Voodoo II | `v2` |
11-
| Voodoo 3 | `v3` |
12-
| Banshee | `v3` |
13-
| Voodoo 4 | `v4` |
14-
| Voodoo 5 | `v4` |
15-
| Voodoo Rush | `vr` |
7+
| Card | Folder |
8+
| ----------------- | -------- |
9+
| Voodoo | `v1` |
10+
| Voodoo II | `v2` |
11+
| Voodoo 3, Banshee | `v3` |
12+
| Voodoo 4, 5 | `v4` |
13+
| Voodoo Rush | `vr` |
1614

1715
These have been copied from the [DOjs repository](https://github.com/SuperIlu/DOjS/tree/master/glide3x).

media/screenshot_02.png

440 KB
Loading

0 commit comments

Comments
 (0)