SoundBoard HUD - adrianomesl/script_shack_support GitHub Wiki

SS{sng}'s SoundBoard is a minimalist HUD offering up to 32 programmable buttons distributed in 4 pages of 8 buttons each.

Configure the Applause HUD

Configuration file

SoudnBoard HUD is configured via a notecard. The settings are grouped in the following sections:

  • [General]
  • [Page1]
  • [Page2]
  • [Page3]
  • [Page4]

[General]

BackgroundTexture - Default: The area behind the buttons can display a texture. Here we can use the name of a texture that is inside the HUD's content or the UUID of any texture.

BackgroundColor - Default: #000000 An hexadecimal representation of a color. If we use a texture via BackgroundTexture we should use light background colors to make it visible.

BackgroundAlpha - Default: 0.5 Transparency of the area behind the buttons.

[Page1], [Page2], [Page3], [Page4]

The HUD has four pages from 1 to 4. Each page has up to 8 buttons. In the notecard we assign sounds to each button of each page as follows:

Slot-Number = Emote # sound-name/uuid

For example: 1 = Emote**#**some-sound

  • 1 = This means that the sound is going to be assigned to slot #1 in the corresponding page.

  • Emote. The emote is said in nearby chat along the sound. Please, read more about this below under How to setup emotes.

  • some-sound. This is the name of a sound inside the HUD's contents or the UUID of any sound.

How to setup emotes

There are two ways to setup emotes: Emote form and Sentence form; as explained below:

Emote form

The emote form says the text as if we had typed "/me text". This is the default form so all we need to do is type the emote sentence like this:

3 = gives a rapturous ovation#79544230-6954-be97-085d-34d1e692bb78

It is a good idea to type these sentences in third person. Suppose the avatar's name is Adrian; The setting above will output the following when the sound is played:

Adrian gives a rapturous ovation

Sentence form

The sentence form says the text as if we had typed normally in a conversation. To use this form we need to prefix the sentence with a :, like this:

1 = : ♬♬ Badum Tss ♬♬#7b9a0928-b70a-a0c8-208e-f9c2b7754f04

Note the : between = and the first .

The setting above will ouput the following:

Adrian : ♬♬ Badum Tss ♬♬

Note the colons (:) in this case.

Personalizing the HUD

The HUD object itself comes with 'copy' and 'modify' permissions so you can edit it to customize it's look

The package you receive when you buy the product includes two textures. These two textures come with full permissions. You can download them to your computer and use them as reference to build your own. The only limitation you'll have here is the layout.

  1. sound_board_uv_layout. The UV layout of the buttons area.

Buttons page UV layout

This is the layout of one single page of buttons. This file is not to be applied to the HUD for it won't work on it's own. The object expects a 1024x1024 texture having all four pages, as shown in the next texture.

  1. sound_board_texture. The default texture.

HUD texture ready to be applied

As you see here, the HUD uses a single texture for all the four pages. The pages in the texture are arranges as follows:

1   2
3   4

The good thing about this approach is that we can have different color combinations for each page to make it easier to identify. If we are not going to be changing the sounds assigned to each button we can even put a short text in the buttons to make it even easier to know what's where. Also, although the areas are square, we can draw round buttons... anyway go crazy and enjoy!

What's next?

We are here to help. Use the Contact page to learn how to get support.

Was this page helpful?

If this page was not helpful enough or it's out of date; please let us know; we want to make it better!.

⚠️ **GitHub.com Fallback** ⚠️