SoundSpigot Reference

Options

To see the command line options, run:
soundspigot -h
SoundSpigot reads in a file soundspigot.conf in the directory specified with -d, or in the current directory if none is specified. The file contains two kinds of entries: settings and tracks.

Values

There are several types of user-supplied values in the config file:
TypeExampleComments
NUM5Positive integer
REAL, SECONDS5.7Real numbers; must have a decimal point and fractional part.
FILEbang.swThe name of a file in the show directory

Settings

A setting is a keyword followed by a value.

Tracks

Each track consists of: track { [track-settings] } The following track-settings are available: Each track must have a triggering mode. This determines when the track is played:
Triggering Mode track-settings Result
TriggeredtriggerSound starts when the appropriate pin on the parallel port is connected to ground.
Looploop 1Sound starts when program starts. When sound ends, it immediately restarts at the beginning.
Randomrand-min, rand-maxSound starts at random intervals. The gap between the sound ending and starting again will be at least rand-min seconds and up to rand-max seconds.
Periodicperiod, period-offsetSound starts at regular intervals, every period seconds. However, the sound initially plays period-offset seconds after startup. This lets you stagger multiple sounds with the same period.
Spigtrigtrigger 200Can be triggered with spigtrig -h HOST -p PORT TRACKNO where TRACKNO is the number of the track in soundspigot.conf, starting at 0. The 200 is just a high number to remove the trigger from the parallel port range. It is not the TRACKNO.

Parallel Port

Warning: you may damage your computer.
The parallel port has a 25-pin connector. The pins are numbered 1-25; if you shine a light on the plastic of the connector, you can see the numbers.
Currently, soundspigot supports four triggers from the parallel port. You trigger the sound by briefly connecting the + pin to the - pin.
Trigger + Pin - Pin
41318
51219
61020
71121
Pins 18-25 are all connected to ground in the computer, so it doesn't matter which you use as ground. If you are connecting simple mechanical switches (microswitches or magnetic reed switches) the polarity (+/-) doesn't matter.
Soundspigot Home Page