Clef - Musical Instruments for Minecraft

Main Features

Clef is a unique mod that adds various musical instruments to Minecraft capable of playing files in ABC format. By default, the mod includes several ready-made musical compositions and 32 instruments from the game Starbound (used with developers' permission).

Installation and Usage

The mod automatically reads all ABC files from the /mods/clef/abc folder and instruments from the /mods/clef/instruments folder. You can easily add your own tracks or entire instrument sets. Additionally, Clef supports Starbound mods in .zip format.

Obtaining Instruments

In creative mode, all instruments are available in the "Instruments" tab of the inventory. In survival mode, there are three ways to obtain instruments:

• Finding in structure chests
• Dropping from mobs
• Using a special device - the Instrument Player

Instruments can be one-handed or two-handed. By default, all two-handed instruments are adapted for one-handed use, allowing you to hold them in your off-hand while traveling.

Playing Instruments

Take an instrument in your hand and press the use button - an interface with song selection will open. You can play solo or in a group, synchronize with other players, reload ABC files and instruments. Double-clicking a song immediately starts its playback.

When playing two-handed instruments, both hands must be free. To stop music, simply use the instrument again or attack with it. Right-clicking the group name allows switching between available musical ensembles.

Instrument Player

To create an Instrument Player you'll need: planks, a chest, a note block, and a redstone torch.

After placing the block, you can place up to 9 instruments in it with a right-click. When a redstone signal is applied, all instruments start playing simultaneously. The Instrument Player interface is similar to the instrument interface but includes additional features, including playlist management with shuffle and repeat settings.

Creating New Instruments

To create a new instrument, fill the Instrument Player with 9 instruments and use a name tag with the desired instrument's name on it. The instrument name can be found by hovering over the instrument in the inventory while holding the Shift key.

Expanding the Library

Since tracks and instruments are stored in separate files, you can easily add new ABC files to the abc folder or new instruments through Starbound mods in zip format. Extensive ABC file libraries are available online, especially for Lord of The Rings Online and Starbound.

Known Issues

Inaccurate ABC file playback:

• Minor pitch discrepancies may be related to Minecraft's sound system limitations
• Slight tempo deviations are due to the 20 ticks per second limitation
• Parsing issues - the used parser was written from scratch and may incorrectly process some files

The mod currently doesn't support multiple melodies in one ABC file and voices/verses.

Game pause doesn't stop music: This feature is related to Minecraft - try pausing the game several times.

Report other issues on GitHub.