Menu Modpacks Guide (v0.4):

Menu modpacks allow you to customize the appearance and sounds of the game's menu and UI. You can change background elements, the look of the buttons, and the sound effects while navigating the menu.

Structure

Menu modpacks are stored in the "packs_menu" folder within the game directory. To create a new pack, you can either create a new folder within "packs_menu", or you can get started with the "Add New Pack" button in the in-game Customization Menu. When you create a new menu modpack in-game, it creates a new pack that has all the default values (except for the music).

Please be aware that the menu modpacks file structure is expected to change significantly in v0.5

Customization Options

Music

You can choose what music is played in the menu by including an audio file named "music_menu". Supported formats are WAV, MP3, and OGG, in that order. If your menu modpack does not contain a music file, the game default will be used.

Advanced option: You can choose the looping point on a music track within the "config_menu.json" file, under "audio > music_menu_loop_start". If the track is WAV, this value must be the sample number. If the track is MP3 or OGG, then this must be the track's time, in seconds.

Background Layers

Several built-in elements exist for the main menu:

• Top Gradient
• Bottom Gradient
• Animated circles
• Waves
• Letterbox

Each of these elements can be toggled on or off, and have the option to change their color

Background Images

Up to two images can be used for the background:

1. Background Image: In your menu modpack, the game looks for an image named "background". Supported image formats are PNG, JPG, and WEBP, in that order. If no image with this name is found, the default background is used.
   • Scrolling: The background image can scroll across the screen. You can choose the scrolling speed on Page 2 of the Menu Customization in-game.
   • Fit: Alternatively, the background image can be stretched to fit the game window.
   
   
2. Overlay Image: This is an optional second image. The game looks for an image named "overlay" in your menu modpack, and if it exists, will add it over the background image. The overlay is automatically stretched to fit the game window. You can add a custom border or image by using the overlay. If the overlay image lacks transparency, it will block the background image.

Clip Disc

The clip disc is a spinning array of images sampled from your previously-played audio clips. On a fresh profile, the disc will be blank, only having colored circles. You can customize the clip disc on Page 2 of the Menu Customization in-game:

• You can hide the clip disc entirely.
• You can change the color of the blank circles.
• You can choose whether the disc loads clip images, or only uses the circles.

Button Customization

The buttons have multiple customizable aspects. The UI aspects of menu modpacks extends to gameplay, since the buttons are also used during game performances. The following button aspects can be customized:

• Color: You can change the button color in-game. The actual color displayed does not accurately reflect the color chosen in v0.4. This will change in v0.5.
• Inversion: You can choose to have the button show inverted (a stylistic choice).
• Audio: You can change the audio the plays when interacting with the buttons. To do so, the game looks for the following four audio files within your menu modpack:
  • "button_sfx_select"
  • "button_sfx_back"
  • "button_sfx_decrease"
  • "button_sfx_hover"

Supported audio formats for the button sounds are WAV, MP3, and OGG, in that order. If these files are not in the modpack, the defaults sounds will be used. Button audio variety will be increased in v0.5.

Clip Images

The following two images can be included in your menu modpack:

• "unseen_image": this image is used on the voice pack selection screen. For clip that the player has not encountered yet, the image preview will use unseen_image.
• "no_image": when a clip has no image assigned to it, it will default to the menu modpack's no_image image. This image is also used during gameplay, and will show on the clip screen when a selected clip has no image assigned to it.