Restrictors And Rotators - meduzapat/LEDSpicer GitHub Wiki

Restrictors And Rotators Hardware Section

To add restrictors or rotators add a <restrictors> node in the configuration file:

<restrictors>
	<restrictor name="xxxxxx">
		<map player="1" joystick="1" id="1"/>
		<map player="2" joystick="1" id="2"/>
		....
	</restrictor>
</restrictors>

UltraStik 360

UltraStik 360 is a versatile USB joystick device with dynamic joystick and restrictor mode settings.

Specifications

  • Dynamic 2, 4, 8, or more ways.

  • Analog

  • Mouse

  • Can change the profiles.

Options

  • Name: UltraStik360

  • boardId: Not required if you have only one with the ID 1, but required if you have multiples of the same hardware connected or the ID is not 1. The board id is provided by the manufacturer.

  • Specific options:

    • hasRestrictor: True|False If you have the restrictor set this to True, other case is optional (default to False).

    • handleMouse: True|False If a game uses a mouse and this is True, the joystick will be set as a mouse (default to False).

Settings Examples

<!-- One single device with ID 1, connected to the player 1's joystick -->
<restrictor name="UltraStik360">
    <map player="1" joystick="1" />
</restrictor>
<!-- Two device with ID 1 and 2, connected to the player 1 and 2 joysticks, and some extra options-->
<restrictor name="UltraStik360" boardId="1">
    <map player="1" joystick="1" />
</restrictor>
<restrictor name="UltraStik360" boardId="2" hasRestrictor="true" handleMouse="true">
    <map player="2" joystick="1" />
</restrictor>

ServoStik

ServoStik is a USB joystick attachment designed for 4 8 ways. It supports two restrictors, but both will move to the same ways configuration, most games are ok with this.

Specifications

  • 4 Ways

  • 8 Ways

Options

  • Name: ServoStik

  • boardId: Not required if you have only one with the ID 1, but required if you have multiples of the same hardware connected or the ID is not 1. The board id is provided by the manufacturer.

  • Specific options: None

Settings Examples

<!-- One single device with ID 1, connected to the player 1's joystick -->
<restrictor name="ServoStik">
    <map player="1" joystick="1" />
</restrictor>
<!-- One single device with ID 1, connected to two restrictors for player 1 and player 2 joysticks -->
<restrictor name="ServoStik">
    <map player="1" joystick="1" id="1"/>
    <map player="2" joystick="1" id="2"/>
</restrictor>
<!-- Two device with ID 1 and 2, connected to the player 1, 2, 3 and 4 joysticks -->
<restrictor name="ServoStik" boardId="1">
    <map player="1" joystick="1" id="1"/>
    <map player="2" joystick="1" id="2"/>
</restrictor>
<restrictor name="ServoStik" boardId="2">
    <map player="3" joystick="1" id="1"/>
    <map player="4" joystick="1" id="2"/>
</restrictor>

GroovyGameGear GP-Wiz49

GroovyGameGear GP-Wiz49 is a USB joystick device with 49-way support.

Specifications

  • 49-way support

Options

  • Name: GPWiz49

  • boardId: Not required if you have only one with the ID 1, but required if you have multiples of the same hardware connected or the ID is not 1. The board id is provided by the manufacturer.

  • williams handles: True|False handle the Williams Sinistar hardware.

Settings Examples

<!-- One single device with ID 1, connected to the player 1's joystick -->
<restrictor name="GPWiz49">
    <map player="1" joystick="1" />
</restrictor>
<!-- One single device with ID 1, connected to the player 2's joystick and enabling Williams mode -->
<restrictor name="GPWiz49" boardId="1" williams="true">
    <map player="2" joystick="1" />
</restrictor>

GroovyGameGear GP-Wiz40RotoX

GroovyGameGear GP-Wiz40RotoX is a USB joystick device with rotary support.

Specifications

  • Rotary support (8 or 12)

  • This controller can handle two players

Options

  • Name: GPWiz40RotoX

  • boardId: Not required if you have only one with the ID 1, but required if you have multiples of the same hardware connected or the ID is not 1. The board id is provided by the manufacturer.

  • speedOn a number from 1 to 255 for the length of time the button is depressed and released before sending a signal again.

  • speedOff a number from 1 to 255 for the length of time the button is depressed and released before sending a signal again.

Settings Examples

<!-- One single device with ID 1, connected to the player 1's joystick -->
<restrictor name="GPWiz40RotoX" boardId="1">
    <map player="1" joystick="1" id="1"/>
    <map player="2" joystick="1" id="2"/>
</restrictor>

GRS TOS Restrictor

GRS TOS Restrictor is a SERIAL joystick device supporting 4 and 8 ways per encoder.

Specifications

  • 4 and 8 ways per encoder

  • This controller can handle four players (additional hardware is needed for each)

Options

  • Name: TOS428

  • Port: Not necessary if there is only one GRS TOS Restrictor. The PORT will be detected automatically. If you have more than one, check the system to find the correct port number.

Settings Examples

<!-- One single device without specifying port (auto detect mode) with 4 devices -->
<restrictor name="TOS428">
    <map player="1" joystick="1" id="1"/>
    <map player="2" joystick="1" id="2"/>
    <map player="3" joystick="1" id="3"/>
    <map player="4" joystick="1" id="4"/>
</restrictor>

UltraStik 360, ServoStik, GP-Wiz49, GP-Wiz40RotoX, and GRS TOS Restrictor are the supported hardware with specific configurations. If there’s anything else or any further adjustments needed, feel free to let me know.

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