|This article is about the current version of DF.|
Since v0.42.01, instruments are procedurally generated for each world, but if so desired, it is still possible to define custom instruments in the raws by using an [ITEM_INSTRUMENT] token. Most tool tokens can be used as before, but there are a few instrument-specific tokens, as listed in the table below.
The information on this page is sourced from the file
raw/objects/examples and notes/item_instrument_example.txt, which also includes useful example instrument definitions.
|PLACED_AS_BUILDING||Makes the instrument stationary.|
||Sets a piece as the central part of the instrument.|
||Defines an instrument piece. token is the identifier that can be used in other raw tags to refer to this instrument piece. tool token is the tool which is required (and consumed) during the construction process to create this instrument piece.
If an instrument does not have any pieces, SELF can be used for any argument which needs to be an instrument piece.
||The instrument's volume range, in millibels (100 mB = 1 dB).|
||Defines how a musician can produce sound when using this instrument. Can be used multiple times. Valid tokens and their required additional arguments are:
||Defines how the pitch can be varied by the musician. Can be used multiple times. Valid methods are:
||Can be used multiple times. Valid methods are: PEGS, ADJUSTABLE_BRIDGES, CROOKS, TIGHTENING, LEVERS.|
||From the example file:
|INDEFINITE_PITCH||May replace |
||Valid timbre words are: CLEAR, NOISY, FULL, THIN, ROUND, SHARP, SMOOTH, CHOPPY, STEADY, EVOLVING, STRONG, DELICATE, BRIGHT, GRACEFUL, SPARSE, BREATHY, STRAINED, BROAD, LIGHT, MELLOW, WOBBLING, FOCUSED, EVEN, FLUID, VIBRATING, QUAVERING, EERIE, FRAGILE, BRITTLE, PURE, PIERCING, STRIDENT, WAVERING, HARSH, REEDY, NASAL, BUZZY, ROUGH, WARM, RUGGED, HEAVY, FLAT, DARK, CRISP, SONOROUS, WATERY, GENTLE, SLICING, LIQUID, RAUCOUS, BREEZY, RASPY, WISPY, SHRILL, MUDDY, RICH, DULL, FLOATING, RINGING, RESONANT, SWEET, RIPPLING, SPARKLING.|
||See PITCH_RANGE and TIMBRE for possible values. The pitch range overrides the global pitch for a register, but the register timbres are added to the global ones.|
||The skill should be one of the music-related skill tokens.|
|Tokens||Ammo • Armor • Biome • Building • Body • Body detail plan • Bodygloss • Creature • Creature variation • Descriptor color • Descriptor pattern • Descriptor shape • Entity • Item • Item definition • Instrument • Interaction • Labor • Language • Material • Material definition • Inorganic material definition • Plant • Position • Skill • Syndrome • Tissue definition • Tool • Trap component • Unit type • Weapon • World|