Skip to content

Commit

Permalink
Fixed formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jhhoward committed Jan 19, 2023
1 parent df2d311 commit 578bd0c
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
@@ -1,33 +1,41 @@
# Wolfenstein 3D CGA
![Wolfenstein 3D in 4 colour CGA](readme_imgs/demo.gif)

This project is a modification to the original Wolfenstein 3D source release which renders the game in CGA video modes. The engine has also been modified so that it can be run on 8088 based CPUs, allowing it to be run on a wide variety of old PC hardware.

## Supported video modes

### 4 colour RGB mode with red palette
![Wolfenstein 3D with red CGA palette](readme_imgs/cgamode5.png)

This is the default mode that the game will start in and uses the alternative 'mode 5' black/red/cyan/white palette.

### 4 colour RGB mode with magenta palette
![Wolfenstein 3D with magenta CGA palette](readme_imgs/cgamode4.png)

Run the game with the command line `WOLF3DC.EXE classic` to run with the magenta palette 'mode 4' black/magenta/cyan/white palette. This mode avoids directly manipulating CGA registers so may be preferable for clone cards that are do not accurately implement the CGA specification.

### Composite CGA mode
![Wolfenstein 3D with magenta CGA palette](readme_imgs/cgacomposite.png)

Run the game with the command line `WOLF3DC.EXE composite` to enable the composite colour mode for CGA cards that support NTSC colour output.

### Tandy 160x200 mode
![Wolfenstein 3D in Tandy 160x200 mode](readme_imgs/tandy.png)

Run the game with the command line `WOLF3DC.EXE tandy` to enable the Tandy 160x200 16 colour mode. This mode has not yet been tested on real hardware and likely has issues with keyboard mapping. Please reach out if you are keen to help test!

### LCD inverse monochrome mode
![Wolfenstein 3D with inverse monochrome palette](readme_imgs/lcd.png)

For machines that feature inverse monochrome LCDs, run with the command line `WOLF3DC.EXE lcd` to run in 640x200 monochrome with the colours inverted. This mode is useful for laptops and palmtops which invert the screen colour.

![Wide LCD mode](readme_imgs/lcdwide.png)

For devices that feature a wide aspect ratio LCD panel, optionally run with the command line `WOLF3DC.EXE lcd wide` to correct the aspect ratio in the 3D renderer.

## Running Wolfenstein 3D CGA
Check the [releases page](releases) on Github for prebuilt binaries. A demo based on the shareware release is included in **wolf3dc_shareware.zip** if you don't own a full copy of Wolfenstein 3D.
Check the [releases page](https://github.com/jhhoward/WolfensteinCGA/releases) on Github for prebuilt binaries. A demo based on the shareware release is included in **wolf3dc_shareware.zip** if you don't own a full copy of Wolfenstein 3D.

To play the full, registered version you will need the 1.4 release. This is available to purchase on [Steam.](https://store.steampowered.com/app/2270/Wolfenstein_3D/)
Before you can play in CGA, you will need to convert the original VGA textures, sprites and images. To do this:
Expand Down

0 comments on commit 578bd0c

Please sign in to comment.