Skip to content

Latest commit

 

History

History
134 lines (87 loc) · 7.83 KB

ShakeIt.adoc

File metadata and controls

134 lines (87 loc) · 7.83 KB

ShakeIt Features

Table of Contents
💡
 Always read the correct version of the documentation, which matches the version of the plugin that you have installed. To do so, use the dropdown in the top left, which usually contains the value "main". Select the "tag" that matches your installed version.

1. Button "SIB"

This button allows easy access to ShakeIt Bass properties from SimHub. It requires that SimHub is running on the same PC, because ShakeIt profiles are read online from SimHub.

After clicking on this button, a new window opens, that displays all ShakeIt Bass profiles, their effect groups and effects: The ShakeIt browser. Each effect group and each effect have a "plus" icon on the far right: When clicked, a menu opens where you can select the "Gain" property or the "IsMuted" property of this element.

After selecting one of these two properties, the ShakeIt browser closes and inserts the correct technical property name into the input field. In the same time, a new label appears below the input field: It displays the name of the effect group or effect as it is defined in SimHub.

This label is only updated after selecting a property from the ShakeIt browser. If you either rename the element in SimHub or copy&paste the property name from one input field to another one, the label is not updated. In this case, simply open the ShakeIt browser again by pressing the "SIB" button, the current element is already preselected, and select its "Gain" or "IsMuted" property again. This causes the label to be updated.

After selecting a property in the ShakeIt browser, only the property name will be replaced in the input field. If you have a condition in the input field (like sib.abcd-efgh.IsMuted==false), only the property name will replaced, the condition will stay intact.

2. Button "SIM"

Same as "SIB", but for ShakeIt Motors. See above for details.

3. Unique GUIDs are IMPORTANT!

ShakeIt properties are accessed through an unique id (called "GUID"), which is managed by SimHub. Unfortunately, SimHub does not enforce that these Guids are really unique. So it can happen, that you are affected by problems caused by duplicate Guids: You address one effect, but actually get the value of another effect.

You have to repair these duplicated Guids. If you are responsible for a profile, you should repair the profile before distributing it. If you import a profile from another maintainer, you can test the profile. If it has duplicate Guids, you should inform the maintainer and ask him to repair the profile.

As this repair functionality it part of the SimHub Property Server, please head over to the documentation of that plugin: https://github.com/pre-martin/SimHubPropertyServer#how-to-repair-shakeit-profiles

4. Example

In this example, we have two effect groups ("Audi" and "AMG"). We want to control the muted state and the gain value of these two groups, as well as display the current values:

Overview

4.1. Center button for mute/unmute

We start with the "Audi" button in the center, which shows the current gain value and the "muted" state: green is unmuted, red is muted. We drag a "Hotkey" action to an empty slot and replace the icons with a solid red and a solid green icon (or whatever you like). We make the following adjustments:

In order to be able to toggle the muted state with this button:

  1. "SimHub Control": Enter AUDI-toggle-mute

To display the muted state with the red or green icon:

  1. "SimHub Property (state)":

    1. Open the ShakeIt browser by clicking on the button "SIB"

    2. Navigate to the effect group ("Audi" in my case)

    3. Click on the "+" icon and select "IsMuted"

  2. The label just between the button and the input field should now contain the hint "Audi.IsMuted" (or whatever name your group has)

  3. The state is now inverted: red for unmuted and green for muted. To fix that:

    1. Go into the field "SimHub Property (state)". It contains the value sib.a-long-guid.IsMuted

    2. Scroll all the way to the right (e.g. press "End" on your keyboard)

    3. After IsMuted append the string ==false

    4. Your input field should now contain sib.a-long-guid.IsMuted==false and your button should immediately toggle its state

To display the current gain on the button:

  1. "SimHub Property (title)":

    1. Open again the ShakeIt browser, select again the effect group, but this time select "Gain" instead of "IsMuted"

  2. Again, the label just between the button and the input field should contain the hint "Audi.Gain"

  3. Also, the button should already display the gain value. Maybe with way too much decimal places

  4. Enter Audi {:F0}% into the field "Display Format". Press enter or return on your keyboard right after the word Audi

  5. The text on the button is now very small

    1. Scroll up to the Stream Deck field "Title" (the topmost field - in my screenshot it is labeled "Titel" because it is on a German PC). In the dropdown on the right, adjust the size and the alignment.

    2. Toggle the button state on the left to the other state with the radiobutton below the button.

    3. Adjust the size and alignment of the title again for this state.

Your button should now look like this:

Mute button

4.2. Buttons for "+" and "-"

These buttons are much easier.

Again we drag a "Hotkey" action to the slot just above the "mute/unmute" button. We replace both icons with a transparent icon (or whatever color you like). The adjustments are as follows:

  1. Enter Audi + in the Stream Deck field "Title". You can press enter or return right after the word Audi

  2. In the dropdown on the right, adjust the size and the alignment

  3. Toggle the button state on the left to the other state

  4. Adjust the title, size and alignment again for this state

  5. "SimHub Control": Enter "AUDI-plus"

Repeat these steps for the "-" button. For "SimHub Control" enter "AUDI-minus".

The "+" buttons likes like this:

Plus button

4.3. Assign controls in SimHub

  1. Open the effect group "Audi" in SimHub.

  2. Open the dialog to assign controls:

    Assign controls

  3. Click to configure "Mute toggle control"

  4. Press the center button on your Stream Deck

  5. Your result should look as follows:

    Assign mute control

  6. Repeat the assignment for "Increment gain" and "Decrement gain"

The plugin supports long button press events. Just hold the Stream Deck button and the gain will increment or decrement gradually. If you set the step size in SimHub down to 1%, you will notice that SimHub stops after 80 steps. This is something that is built into SimHub and happens with other input plugins as well.

4.4. Bonus: Toggle whole Stream Deck column

In the very first screenshot, you can see that my three "Audi" buttons are greyed out, because the effect group is muted. This can be achieved as follows:

  1. Bind the "Audi" property "IsMuted" to the "+" and "-" button ("SimHub Property (state)"). Append ==false as for the mute button in the center

  2. Activate the "muted" state of each of the three buttons

  3. From the dropdown menu of the Stream Deck field "Title", select a gray color.

4.5. Stream Deck Plus Dial

Volume up, Volume down and Mute/Unmute can be controlled with a rotary knob. The following example uses the same configuration as the previous examples:

Dial

The value in the field "SimHub Property (State)" has to end with ==false. If the channel is muted, the value will we displayed in light gray instead of white:

Dial Muted

At the moment, it is not possible to also dim the title ("Audi" in this example). Elgato has to implement https://github.com/orgs/elgatosf/discussions/17 first.

Because the reaction to the knobs is very fast, the parameter "Gain change step" can be reduced to "1" in SimHub.