Bundled SoundFont

Spivohrai automatically installs the bundled GeneralUser GS SoundFont when needed:

ModConfig/Spivohrai/SoundFonts/GeneralUser-GS.sf2

Players do not need to manually download or configure a SoundFont.

You may still override the default SoundFont through:

ModConfig/Spivohrai/Config.json

using:

"soundFontPath"

If the configured path points to the SoundFonts folder:

• GeneralUser-GS.sf2 will be preferred automatically

• or a single .sf2 file will be used if exactly one exists

Currently only .sf2 SoundFonts are supported.

Basic Usage

1. Place MIDI files into:

ModConfig/Spivohrai/Songs/

2. Hold a supported instrument.

3. Press F.

4. Select a song.

5. Choose a MIDI part with < / >.

6. Press Play.

Right-clicking with a supported instrument will:

• start playback

• pause the current song

• or resume playback

depending on the current state.

Instrument System

Normal instruments can only play a single MIDI channel/part at a time.

The creative-only item named Spivohrai acts as the orchestra controller and is the only instrument capable of playing:

All

which enables full multi-instrument MIDI playback.

This helps multiplayer performances feel more grounded and prevents every handheld instrument from behaving like a full orchestra.

Creative Instruments

Current creative-only instruments include:

• Spivohrai

• Lyre, Bandura, Kobza, Tsymbaly

• Sopilka, Floyara, Recorder, Gemshorn

• Bayan, Hurdy-Gurdy, Portative Organ

• Drymba, Duda, Surma, Trembita, Horn, Natural Horn

• Saxophone, Clarinet

• Lute, Gusli, Psaltery, Citole

• Rebec, Vielle, Viol

• Shawm, Crumhorn, Rauschpfeife, Zurna

Many voice and wind instruments currently reuse temporary vanilla-style models.

The Spivohrai controller currently uses the vanilla large music box model.

Custom instrument models and animations are planned for future versions.

How the Audio Works

MIDI files do not contain recorded sound.

Instead, they contain musical instructions such as:

• note on/off events

• instrument changes

• sustain

• pitch bend

• tempo

• controller automation

• drum mapping

Spivohrai feeds this MIDI data into MeltySynth using the active SoundFont, generating real audio playback instead of simple note triggers.

This allows:

• proper drums

• layered instruments

• pitch bends

• sustain pedals

• expressive playback

• accurate General MIDI instrumentation

Different SoundFonts can dramatically change how songs sound.

If a MIDI sounds incorrect, test it with the same SoundFont in another MIDI player before assuming the issue comes from Spivohrai itself.

Audio Cache

Rendered audio is cached here:

ModConfig/Spivohrai/Cache/

Delete cache files to force MIDI re-rendering.

By default Spivohrai renders audio as:

mono OGG

using:

"midiOutputChannels": 1

This avoids OpenAL stereo source limitations present on some Vintage Story clients.

Volume Control

Spivohrai has its own dedicated client-side volume slider:

Settings -> Sound -> Spivohrai

Spivohrai playback intentionally ignores vanilla:

• Sound volume

• Music volume

• Entity volume

This allows every player to control their own listening volume independently without affecting other listeners.

Multiplayer

When a player starts a MIDI track:

1. Their client synthesizes the MIDI into OGG audio locally.

2. The generated audio is uploaded to the server in small chunks.

3. The server validates playback ownership and relays the audio to nearby players.

4. Nearby clients reconstruct and play the streamed OGG track.

Other players:

• need the Spivohrai mod installed

• do NOT need the MIDI file

• do NOT need the SoundFont

A SoundFont is only required for players who want to render and start their own MIDI playback locally.

Current Limitations

• Large OGG transfers may cause listeners to join songs slightly late.

• .sf3 support is not implemented yet.

• Single-part playback currently filters by MIDI channel, which may not perfectly split unusual MIDI files.

• Many instrument models are still temporary placeholders.

• Instrument-specific sound behavior is still future work.

Future Plans

Planned improvements include:

• real custom instrument models

• instrument animations

• spatial ensemble playback

• improved MIDI part separation

• streaming optimization

• .sf3 support

• optional positional acoustics

• instrument-specific sound coloration

• cooperative music playback