Setup and Usage - TheCodeNugget/Arma3-PiShock GitHub Wiki

Requirements

You will need the following.

  1. A PiShock and a PiShock Account available here from which you'll need:

    • Your PiShock Username.
    • Sharecode for the shocker you want to use.
    • API Key generated from your account.
  2. Latest release of CBA_A3 for Arma 3. You can get this from:

  3. Latest release of A3PiShock. You can get this from:

  4. Disable Battleye: Extension is not yet whitelisted by BattlEye.

Settings

Known Issues

  • CBA Keybindings and Settings require a mission to be initialized to function properly. You can achieve this by opening up the editor.
  • Binding Multiple PiShock Commands to the same eventhandler will cause only one to execute.
  • The mod is not whitelisted by battleeye at this time, launch the game with BattlEye turned off.

Editing Settings

While editing settings do so on the Server Tab, these will be your client settings when joining servers.

1. PiShock Settings

20230823171022_1

Setting Description
Enabled on Start Enables PiShock on mission start (Killswitch)
Allow remote commands Allows other players or the server to send shock commands
PiShock Username Your PiShock.com Username.
PiShock Sharecode Sharecode generated on PiShock.com.
API KEY API Key generated on PiShock.com Can be found in the Account section of the website.
Global Cooldown Cooldown between all actions.

2. Shock Settings

20230823172000_1

Setting Description
Enabled on Start Enables Shock on mission start.
Event Handler Event Handler for shocking.
Shock Intensity Intensity of the shock.
Shock Duration Duration of the shock.
Shock Cooldown Cooldown between shocks.

3. Vibration Settings

20230823172002_1

Setting Description
Enabled on Start Enables Vibration on mission start.
Event Handler Event Handler for Vibration.
Shock Intensity Intensity of the Vibration.
Shock Duration Duration of the Vibration.
Shock Cooldown Cooldown between Vibrations.

4. Beep Settings

20230823172005_1

Setting Description
Enabled on Start Enables Shock on mission start.
Event Handler Event Handler for shocking.
Shock Intensity Intensity of the shock.
Shock Duration Duration of the shock.
Shock Cooldown Cooldown between shocks.
Display Responses Displays responses from PiShock API.

Available Event Handlers

Event Handler Activation
Hit Getting Hit.
Killed Dying.
Suppressed Getting Suppressed.
Fired Firing your weapon.

Keybinds

Keybinds can be accessed over CBA Options > Controls > Configure Addons > Addon: Arma 3 PiShock

API Responses

Enabling the "Display Responses" setting will display the API responses to you as chat messages.

The API Responses are displayed to you in the following format

(Shock/Vibrate/Beep) Command: {Message}

Response Message Meaning
Operation Succeeded. The command was sent successfully.
This code doesn’t exist. The specified share code could not be found. Make sure you create and copy an active share code from the PiShock website.
Not Authorized. The specified username or apikey is not correct (or your account has not been activated).
Shocker is Paused, unable to send command. The shocker is paused (from the PiShock.com web panel).
Device currently not connected. The PiShock is offline.
This share code has already been used by somebody else. Someone (or something) else is using the specified share code. Generate a new one.
Unknown Op, use 0 for shock, 1 for vibrate and 2 for beep. Invalid Op code specified. Must be 0, 1, or 2. (You should not be getting this, included here for documentation purposes)
Intensity must be between 0 and {maxint} The specified intensity was outside the range set for the sharecode.
Duration must be between 1 and {maxdur} The specified duration was outside the range set for the sharecode.