VS Instruments Redux

ANNOUNCEMENTS

These are the changes in v1.2.7:

• Band mode added - MAJOR UPDATE!
• GUI reworked.
• Added Crumhorn, Guzheng, Shamisen, and Flute instruments.
• Quieted some noises of the Jaw Harp.

VS Instruments Redux

 

"If music be the food of love, play on..."

   - William Shakespeare, Twelfth Night 

 

Introduction

Description

This mod brings musical instruments into the game, which can play songs through the use of ABC files, or even freestyle using your keyboard! I hope you all find it enjoyable, fun, and working well~

(NOTE: This mod was created in support of the World of New Horizon's Vintage Story server, though all are welcome to use it. Check out WoNH here: https://vsnh.online/.)

Instruments Currently Included

• Acoustic Guitar
• Bass Guitar
• Violin
• Banjo
• Shamisen (NEW)
• Koto
• Guzheng (NEW)
• Trumpet
• Saxophone
• Flute (NEW)
• Ocarina
• Pan Flute
• Crumhorn (NEW)
• Jaw Harp (UPDATED)
• Piano
• Upright Piano
• Pipe Organ
• Piano Bench - Not an instrument, just a nice seat for the Upright Piano and Pipe Organ.
• Accordion
• Hurdy Gurdy
• Kalimba
• Steel Drum
• Handpan
• Theremin
• Choir Book

Why This Mod Exists

Like many, I was a fan of the Instruments mod (https://mods.vintagestory.at/show/mod/463), but it appears to have sadly been abandoned, and lingering bugs still remain. After a brief attempt to patch it, I decided I would just rebuild a new mod from the ground up - hence why VS Instruments Redux now exists.

What This Mod is NOT

This mod is not a re-upload of, a patch of, or in any way affiliated with the original Instruments mod. It was made completely fresh, with the code structure and models being made by me. The sounds were taken from GeneralUser GS (https://www.schristiancollins.com/generaluser) via LMMS. the original Instruments mod was, of course, a major inspiration. I value it greatly.

For Mod Users

How do I add ABC files?

Go to 'VintageStoryData' -> 'ModData' -> 'vsinstrumentsredux' -> 'songs' (a button exists in the GUI to open the file for you), and place any ABC files there. You can even organize your songs by adding them to folders in the 'songs' folder.

A demo file of "Daisy Bell" is built into the code - a gift to you in honor of the first computer-synthesized vocal performance by an IBM 7094 mainframe at Bell Labs in 1961 (https://www.youtube.com/watch?v=41U78QP8nBk). 

How do I use the instruments?

When holding your instrument, use 'Sneak' + 'Right-Click' to bring up the GUI from which you can choose to play an ABC file from a selected folder, shuffle songs in the folder, or play the instrument yourself with your keyboard in Freestyle mode. You can also 'Right-Click' to stop playing the song. 

 

If you are interacting with an instrument block (like the Upright Piano), you can just 'Right-Click' while looking at it and open the same GUI menu. However, to play in Freestyle mode, you must be close to the actual instrument!

How do I use Freestyle mode?

When using your instrument, click the 'Freestyle' button. From there, you can toggle between two keyboard layouts: Virtual Midi Keyboard (using your 'Z'-'/' and 'Q'-'P' keys like a piano) and Diatonic Number Row (using your '1'-'8' keys and Shift/Alt/Ctrl for octave shifts and sharps).

How do I use Band mode?

When using your instrument, enter in a 'Band Name' in the provided space, select a song from a folder, and click the 'Ready' toggle. Any other players/instruments with that same band name who have also clicked the 'Ready' toggle will begin playing in sync when one of them clicks the 'Start Band' button. Any player can stop playing at any time without stopping the entire band.

For Mod Developers

Is it possible to have ABC files in my mod get automatically read by VS Instruments Redux?

Yes! If you do the following, my mod will automatically add ABC files from your mod to the list of selectable songs the players can choose from in the GUI, where your songs will be in their own folder associated with your mod. As long as the player has both our mods downloaded, they will have access to your library. All you must do is:

1. Add the following file path to your mod: \assets\vsinstrumentsredux\config\songs
   
   
2. Save your ABC files to that file path, but you must rename the ABC files so they end with '.txt'! For example, "DaisyBell.abc" should be renamed to "DaisyBell.abc.txt".

Community Contribution Credits

I want to thank the following folks for their contributions to the mod:

• DeanBro: For creating the Ukrainian translation file.
• Garlicc: For the idea of making it so ABC files can be loaded in from other mods.
• ./Ghosty_: For the idea of making instrument blocks (like the Upright Piano) for better immersion.
• MoldyTofu: For the ideas for various instruments, as well as the sounds of the Handpan.