Playable Piano - Instrument Frame

Makes Dark Piano and Upright Piano playable and allows content packs to add instruments to the game.

Playable Piano - Instrument Frame

🎹 **Make the piano in Stardew Valley come alive! ** This mod allows you to play dark pianos and upright pianos with a keyboard, as well as play MIDI files. What's more, it provides a framework for content packs to add custom instruments!

---

🎵 Installation Guide

• **Install the latest version of SMAPI** - Go to SMAPI official website
• **Download this mod** and extract it to the `Stardew Valley/Mods` folder
• **Run the game using SMAPI**

🎹 How to use

**Sit at the piano** and press any key on the keyboard; when using a portable instrument, **hold an object and left-click**. This will open a menu where you can choose between **Free Play Mode** and **MIDI Play Mode**.

🎼 Free Play Mode

In free play mode, just press keys on the keyboard to play sounds. The keyboard layout simulates a real piano keyboard:

By pressing the **Ctrl**, **Shift** and **Tab** keys you can switch between bass, midrange and treble, providing a complete range from C3 to C9.

🎶 MIDI playback mode

In play mode, you can automatically play MIDI files located in the module's songs folder (`Playable_Piano/assets/songs`). Just select a file from the list and playback will begin.

💡 **NOTE**: If you have used an older version of this mod, the song folders were moved in version 1.3.0 and your songs may not be displayed.

⚙️ Custom settings

You can customize the mod by changing the sounds of the mod itself or any instruments added by other content packs.

🎵 Change sound

To change the sound of a piano or other instrument, simply edit the `config.json` file in the mod folder. The syntax is as follows:

```

"": ""

```

If you have a custom sound file, add it to the `assets/sounds` folder (only `.wav` files are supported) and write the filename without extension in the configuration. If you don't have custom sounds, you can use any sounds from the base game, which can be found on the wiki page.

For example, if you want to turn a dark piano into a cat piano, just add the following line to the configuration:

```

"Dark Piano": "cat"

```

🎵 Custom sound file

There are a few things to consider when adding a custom sound file: In order to align the keyboard with the piano keyboard, the selected `.wav` file should be in the key of C, preferably C6, so that the notes played back by MIDI are correct.

Additionally, adding just one sound file will provide a limited range from C5 to C7. To get full range support, you need to add two additional sound files: one for bass and one for treble.

🛠️ Guidelines for Mod Authors

If you want to add instruments to your mod, you can use the Content Patcher or the mod's API. For more details, check out the documentation on the mod's GitHub repository.

🎯 Content Patcher method

To add custom instruments using Content Patcher, simply add a trigger action to your `content.json`. This method works for objects and sit-on furniture.

💻 C# API method

If you want to make an instrument that cannot be added with the Content Patcher (such as an instrument that is part of a map), you can use the provided API to directly open the mod's UI.

🔊 Sound file

The module comes with the piano sound `Mushroomy.PlayablePiano_Piano`, as well as extended range files for the `toyPiano` and `flute` sounds in the base game. You can use these if you don't have or don't want to add your own voice.

🔧 Troubleshooting

If your custom instrument doesn't seem to be working properly, check the `config.json` in the Playable Piano folder. There should be a row of corresponding sounds for each instrument recognized by the module. If the instrument does not appear in the list, enter `reset_instrument_sounds` in the SMAPI console and check the configuration again.

✅ Compatibility

• ✅ Supports Stardew Valley version 1.6.15 (Linux/macOS/Windows)
• ✅ Supports single player and …