$OpenBSD: README.template,v 1.7 2019/05/09 17:45:05 ajacoutot Exp $

+-------------------------------------------------------------------------------
| Running ${PKGSTEM} on OpenBSD
+-------------------------------------------------------------------------------

Installing Game Assets
======================

Shockolate requires the assets from the classic CD-ROM version of the game from
1994. The Enhanced Edition content is not supported at this point.

After locating the files, copy the game's DATA and SOUND directories into
~/.local/share/shockolate/res. Here is an example based on the System Shock:
Classic Edition from GOG.com (use innoextract from packages):

$ innoextract setup_system_shock_classic_2.0.0.3.exe
$ mkdir -p ~/.local/share/shockolate/res
$ cp -R app/SSHOCK/{DATA,SOUND} ~/.local/share/shockolate/res/
$ systemshock

Note that the wrapper script will automatically lowercase all files and
directories in ~/.local/share/shockolate/res.

Soundfont
=========

There are alternatives to the basic MIDI soundtrack that can be loaded in the
in-game menu (Esc -> Audio -> Audio Options) by selecting FluidSynth. You can
search systemshock.org forums for 'soundfont'. Any .sf2 file needs to be
copied into ~/.local/share/shockolate/res/ to be used.
