aboutsummaryrefslogtreecommitdiff
path: root/games/jfsw/README_music.txt
blob: f6c44ca5ab8b61e7e6e170959199aaf7938fd73c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
The most important things to understand about the music in Shadow Warrior:

The demo/shareware version of the game uses MIDI. There are actually
.MID files stored within sw.grp.

The full/registered version and/or expansion pack uses CD audio
tracks. They *can't* use MIDI: there's no MIDI data inside its .grp
files at all.

So there are 2 completely separate procedures for getting the music
to work, depending on whether you're playing the full/expansion or
demo version.

Full (Registered) Version, Wanton Destruction expansion
-------------------------------------------------------

For these versions, jfsw doesn't actually support CD audio from a
physical CD [*]. It does, however, support .ogg files made from the CD.

As of April 2020, the jfsw_registered_data build includes the .ogg files,
so there's no need to rip them from CD or download them separately. If
you're playing Wanton Destruction, install both jfsw_registered_data
and jfsw_wanton_destruction.

Run the game, and the music should play. If not, use the in-game menus
(Options, Sound Menu) to enable the music and turn up the volume.

If you followed the steps below to get the demo music to play, you'll
have to re-edit ~/.jfsw/sw.cfg and change the MusicDevice back to 0.

If you're never going to play the demo version, there's no need to build
jfsw with fluidsynth support (although, it won't hurt anything if you do).

Note: When using the .ogg soundtrack, under some conditions, it seems
the background music stops playing after loading a saved game. If this
happens to you, toggle the music off & back on (under Options, Sound
Menu), which should start it playing again.

[*] There is some code in jfaudiolib that's supposed to play CD audio
    but it's (a) SDL-1.2 only, and (b) broken.

Demo (Shareware) Version
------------------------

For the shareware version, the MIDI data is already present inside the
sw.grp file. To actually hear it, you'll have to:

1. Build and install fluidsynth. Doesn't matter whether or not
   optional jack and/or lash are included (jfsw doesn't use them though).

2. Build and install fluid-soundfont.

3. Build and install jfsw. When installing, the description should say
   the package was built with fluidsynth.

4. Run the game once, and exit it normally, to get it to create a config
   file. You should now have a ~/.jfsw/sw.cfg file.

5. Edit ~/.jfsw/sw.cfg, find the line that says "MusicDevice = 0", and
   change the 0 to a 6. This enables fluidsynth.

6. Run the game again. Make sure the music is enabled and the music
   volume is turned up (under Options, Sound Menu).

Unfortunately, the edited config file won't work with the full version.
You'll have to change MusicDevice back to 0 (meaning 'autodetect') to get
the .ogg tracks to play. Other possible values are 1 (SDL) and 7 (ALSA).

There's no direct way to change which soundfont jfsw uses. What it does is
look in /usr/share/sounds/sf2/ and pick the first soundfont it finds, in
sorted order. Basically it does the C++ equivalent of:

$ ls /usr/share/sounds/sf2/*.sf2 | head -1

If the only sound fonts in that directory are the ones installed by
the fluid-soundfont package, it will choose "FluidR3_GM.sf2", which is
reasonable and sounds good.

If you want to use a different soundfont, try something like this:

# cd /usr/share/sounds/sf2/
# ln -s MySoundFont.sf2 000-jfsw.sf2

Check with the ls command above, to make sure 000-jfsw.sf2 sorts first.