🎸Potato🥔Midi🎤

This mod takes MIDI input and allows you to configure it to output through not only guitar but in-game sounds, however you see fit... Like, singing, or playing drums with a boxing glove, and more...

It's for power users who want to experimenting and enjoy playing around with a configuration file to make more noises than just guitar notes!

[!WARNING] If you are not comfortable with editing --or learning how to edit-- a .json config file, you should use something like MidiStrummer instead.

Project

Changelog

Contributing - pull requests welcomed

Known Issues

Report an issue / Feedback

Roadmap and feature requests

Configuration

Any changes made to the configuration file will take effect immediately! Issues with the configuration file will be logged to the log file and the player warned, if in-game (and so the chat window is visible).

If you want to reset your configuration file to default, delete the file and it'll be recreated!.

%AppData%\Godot\app_userdata\webfishing_2_newver\PotatoMidi.json

Structure

The configuration file has the following structure:

• version: The PotatoMidi configuration-scheme version number
• channel_mappings: A dictionary mapping your chosen instrument names to MIDI channel numbers.
• instruments: A list of your instrument configurations

Version

• Type: int
• Description: The version of the configuration file.
• Current version: 1
• Example:

"version": 1

Channel mappings

These are named references, for you convenience, to map to channel numbers- you can name them whatever you want.

• Type: Dictionary
• Description: A dictionary mapping user-defined names to MIDI channel numbers.
• Example:

"channel_mappings": {
    "acoustic_grand_piano": 0,
    "bright_acoustic_piano": 1,
    "banana": 2,
    ...
}

Instruments

• Type: Array of Dictionaries

• Description: Each dictionary defines an instrument with unique properties and specific parameters.

• Keys:

  • instrument: The name of the instrument.

    • Type: String
    • Description: The name of the instrument.
    • Example:

    "instrument": "guitar_strummer"
    

  • channels

    • Type: Array of Strings
    • Description: A list of MIDI channel names for the instrument.
    • Example:

    "channels": [
        "acoustic_grand_piano",
        "bright_acoustic_piano",
        "electric_grand_piano",
        "honky_tonk_piano",
        "rhodes_piano",
        "chords",
        "synth_pad"
    ]
    

  • Pitch

    • One of the following:

      • pitch_range

        • Type: Dictionary

        • Description: A dictionary with the minimum and maximum pitches for the instrument.

        • Keys:

          • min: The minimum pitch for the instrument.
            • Type: int
            • Description: The minimum pitch for the instrument.
            • Example: 40
          • max: The maximum pitch for the instrument.
            • Type: int
            • Description: The maximum pitch for the instrument.
            • Example: 80
          • Example:

          "pitch_range": {
              "min": 40,
              "max": 80
          }
          

      • pitch

        • Type: int
        • Description: The pitch of the instrument.
        • Example:

        "pitch": 40
        

      • pitch_list

        • Type: Array of ints
        • Description: An array of pitches for the instrument.
        • Example:

        "pitch_list": [
            40,
            45,
            50,
            55,
            59,
            64
        ]
        

MIDI Percussion Conventions

For MIDI Channel 10, each MIDI KEY number ("NOTE#") corresponds to a different drum sound, as shown below. While many current instruments also have additional sounds above or below the range show here, and may even have additional "kits" with variations of these sounds, only these sounds are supported by General MIDI Level 1 devices.

Instrument-specific Settings

guitar_strummer

• apply_velocity

  • Type: bool
  • Description: Whether to apply velocity to the strum. You should not ever turn this off!
  • Default: true
  • Example:

  "apply_velocity": true
  

talk_effect

• apply_pitch

  • Type: bool
  • Description: Whether to use the note's pitch to determine the spoken letter's pitch. You should not ever turn this off!
  • Default: true
  • Example:

  "apply_pitch": true
  

• base_pitch

  • Type: int
  • Description: The base pitch for the talk effect. Note that the game limits the pitch (between "0.5 and 2.0").
  • Default: The lowest note in your instrument's pitch range
  • Example:

  "base_pitch": 53
  

• letter

  • Type: String
  • Description: The letter to use for the talk effect.
  • Default: Randomly chosen (each note) between a, o, or e
  • Example:

  "letter": "a"
  

sfx

• apply_pitch

  • Type: bool
  • Description: Whether to apply pitch to the SFX.
  • Default: true
  • Example:

  "apply_pitch": true
  

• base_pitch

  • Type: int
  • Description: The base pitch for the SFX.
  • Default: The lowest note in your instrument's pitch range
  • Example:

  "base_pitch": 80
  

• face_emote

  • Type: String
  • Description: The face emote to use for the SFX. Any of one: angry, bark, cat, flat, happy, kiss, strum, surprised, whine
  • Default: null
  • Example:

  // "angry", "bark", "cat", "flat", "happy", "kiss", "strum", "surprised", "whine"
  "face_emote": "bark"
  

• sfx_sound

  • Type: String
  • Description: The name of the SFX sound to play. See Valid SFX Sounds for a list of valid SFX sounds.
  • Default: bark_cat
  • Example:

  // "equip", "splash", "splashb", "drown", "land", "jump", "jump_big", "dive_woosh", "dive_scrape", "reel_slow", "reel_fast", "woosh", "drink", "drink_nocap", "md_beep_veryslow", "md_beep_veryslowb", "md_beep_slow", "md_beep_slowb", "md_beep_fast", "md_beep_veryfast", "growl_cat", "growl_dog", "whine_dog", "whine_cat", "punch", "phone_call", "kiss", "rip", "cash1", "cash2", "cash3", "strum", "menu_a", "menu_b" "notification"
  
  "sfx_sound": "bark_cat"
  

Valid SFX Instrument Kinds

Some sounds, unfortunately, have a random pitch modifier.

Example configuration

[
  {
    "instrument": "guitar_strummer",
    "channels": [
      "acoustic_grand_piano",
      "bright_acoustic_piano",
      "electric_grand_piano",
      "honky_tonk_piano",
      "rhodes_piano",
      "chords",
      "synth_pad"
    ],
    "pitch_range": {
      "min": 40,
      "max": 80
    },
    "parameters": {
      "apply_pitch": true,
      "apply_velocity": true
      // "base_pitch": 40
    }
  },
  {
    "instrument": "talk_effect",
    "channels": ["acoustic_grand_piano"],
    "pitch_range": {
      "min": 50,
      "max": 95
    },
    "parameters": {
      "apply_pitch": true,
      "apply_velocity": true,
      // "base_pitch": 50,
      "letter": "random"
    }
  },
  {
    // Bass drum
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [35, 36],
    "parameters": {
      "base_pitch": 10,
      "apply_pitch": false,
      "apply_velocity": false,
      "sfx_sound": "punch"
    }
  },
  {
    // Bass drum 2
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [35, 36],
    "parameters": {
      "base_pitch": 7,
      "apply_pitch": true,
      "apply_velocity": true,
      "sfx_sound": "menu_b"
    }
  },
  {
    // Snares
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [38, 40],
    "parameters": {
      "apply_pitch": true,
      "base_pitch": 40,
      "apply_velocity": true,
      "sfx_sound": "tambourine"
    }
  },
  {
    // Hi-hats closed
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [44],
    "parameters": {
      "apply_pitch": true,
      "apply_velocity": true,
      "base_pitch": 60,
      // Maybe better base pitch
      "sfx_sound": "notification"
    }
  },
  {
    // Hi-hats open
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [46],
    "parameters": {
      "apply_pitch": true,
      "apply_velocity": false,
      "base_pitch": 40,
      // Maybe better base pitch
      "sfx_sound": "cash3"
    }
  },
  {
    // Toms
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [41, 43, 45, 47, 48, 50],
    "parameters": {
      "apply_pitch": false,
      "apply_velocity": true,
      "sfx_sound": "woosh"
    }
  },
  {
    // Toms 2
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [41, 43, 45, 47, 48, 50],
    "parameters": {
      "apply_pitch": false,
      "apply_velocity": true,
      "sfx_sound": "jump"
    }
  },
  {
    // Cymbals
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [49, 51, 52, 55, 57, 59],
    "parameters": {
      "apply_pitch": false,
      "apply_velocity": true,
      "sfx_sound": "dive_woosh"
    }
  },
  {
    // Etc.
    "instrument": "sfx",
    "channels": ["DRUMS", "PERCUSSION"],
    "pitch_list": [
      54, // Tambourine
      53, // Bell
      56, // Cowbell
      70 // Maracas
    ],
    "parameters": {
      "apply_pitch": false,
      "apply_velocity": false,
      "sfx_sound": "tambourine"
    }
  }
]