                                  SOUNDSENSE
                    A sound-engine tool for Dwarf Fortress

Author: Petr Prokop

You can find me on the official Dwarf Fortress forums as 'zwei'
Contact via PM: http://www.bay12forums.com/smf/index.php?action=profile;u=16734
You can also reach me on email: zwei2stein@gmail.com

Version: Release 2016-1 Build 196
Last Updated: 13.03.2016
For DF version:	0.31.18
Requirements: Java 1.6 runtime (Works on any OS with java support... in theory)

Homepage: http://df.zweistein.cz/soundsense/
Forum thread: http://www.bay12forums.com/smf/index.php?topic=60287.0
Wiki page: http://df.magmawiki.com/index.php/Utility:SoundSense

Notable contributors in aplhabetical order:

> Rainseeker
> Tokkius
> Thundercraft
> Tyrspawn

Description
===========

SoundSense is an unofficial (3rd party) sound-engine tool for the Dwarf Fortress roguelike.
It plays various sound effects, voices and music based on what entries appear in the 
gamelog.txt.

Basically, game events are detected and this triggers certain sounds and soundtracks. For 
example, specific combat events will trigger certain sound effects like the clanging of 
swords and the impact of arrows. Likewise, a change from Winter to Spring will change the 
background music.

Although it has only been tested on Windows and Linux, SoundSense should (in theory) run 
on any OS with java support. Startup scripts are included for Windows and Linux.

See this post for help on getting it to run on Mac OS X: 
http://www.bay12forums.com/smf/index.php?topic=60287.msg1552676#msg1552676

(Note: Feedback on using SoundSense with Mac OS X is appreciated. It has not be tested 
enough yet to warrant official support.)


Downloads
=========
Requires java 1.6 runtime:
http://java.sun.com/javase/downloads/index.jsp

Remember to add the official sound pack (separate download) after installation!
The latest Soundpack.zip, as well as a few unofficial sound packs, can be found here: 
http://df.zweistein.cz/soundsense/


Installation
============

Described at wiki:
http://df.magmawiki.com/index.php/Utility:SoundSense


Known Issues
============

See then at wiki and contribute:
http://df.magmawiki.com/index.php/Utility:SoundSense


Customization
=============

Described at wiki:
http://df.magmawiki.com/index.php/Utility:SoundSense


Disclaimer
==========
SoundSense has been tested and I can not imagine a situation where it could cause harm. 
However, to be on the safe side: SoundSense is provided 'as is,' without warranty of any 
kind, either express or implied. You assume total responsibility for the use of the 
Software as it is entirely at your own risk.


Acknowledgment
==============
The SoundSense program itself was written (and is maintained) by Petr Prokop. But a lot of 
talented people produced, recorded and edited the music and sound that went into this 
project. They deserve our acknowledgment and appreciation, too. If you enjoy SoundSense 
and are curious to see who these people are or how many different sources we used, then 
check out ATTRIBUTION.TXT in the Soundpack.zip package for a full credits list. 

