Skip to content

Commit c504e69

Browse files
authored
Update README.md
1 parent 52ed80e commit c504e69

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

Diff for: README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,31 @@ The end goal for this project is something like what Chocolate Doom is for Doom:
3333
Compiling / Running
3434
============
3535

36-
# Prerequisites
36+
## Prerequisites
3737
- SDL2, 32 bit
3838
- SDL2_mixer, 32 bit
3939
- Original assets in a `res/data` folder next to the executable
4040

41-
# Building SDL
41+
## Building SDL
4242
You can use the included `build_deps.sh` shell script to build the required versions of SDL2 / SDL2_mixer. VOC support was broken until recently in SDL_mixer, so for sound effects to work you'll probably need to build it from the latest sources like that script does.
4343

44-
# Build and run
44+
## Build and run
4545
```
4646
cmake .
4747
make systemshock
4848
./systemshock
4949
```
50+
51+
Modding Support
52+
============
53+
Shockolate supports loading mods and full on fan missions. Just point the executable at a mod file or folder and the game will load it in. So far mod loading supports additional `.res` and `.dat` files for resources and missions respectively.
54+
55+
Run a fan mission from a folder:
56+
```
57+
./systemshock /Path/To/My/Mission
58+
```
59+
60+
Run a fan mission from specific files:
61+
```
62+
./systemshock my-archive.dat my-strings.res
63+
```

0 commit comments

Comments
 (0)