Download

Feel free to message me on Discord for any help or to report any bugs.

Installation UnityPackage

PiShock Unity Package Installation Guide

Prerequisites:

• Make sure you have Unity installed on your machine.

• Ensure VRCFury is installed in your Unity project.

• The addon utilizes the Poiyomi Shader, so make sure it is also installed.

Step 1: Download and Import the UnityPackage:

1. Download the PiShock UnityPackage.

2. Open your Unity project.

3. In the Unity Editor, go to "Assets" > "Import Package" > "Custom Package."

4. Select the downloaded PiShock UnityPackage and click "Open."

5. Follow the prompts to import the package into your project.

Step 2: Locate and Drag the PiShock Prefab:

1. In the Unity Editor, navigate to the "Custom" folder.

2. Look for the "PiShock-Prefab" file.

3. Drag the "PiShock-Prefab" onto your avatar in the scene hierarchy.

Step 3: Position the Shocker on Your Avatar:

1. In the hierarchy, find the "Shocker" object.

2. Move the "Shocker" to your desired location on your avatar, typically in the right hand.

Step 4: Configure the Contactor Values:

1. Under "Contactor," locate the "Receiver" object.

2. Adjust and edit the values to your preferences.

Step 5: Place the Icon:

1. Move the "Icon" to a desired location. This icon will indicate if the contactor is enabled and help locate other users with the plugin.

Step 6: Prepare for VRCFury Upload:

1. Ensure you have at least 4 parameter slots available for the installation.

2. Save your Unity project.

Step 7: Usage In-Game:

1. During gameplay, use the point gesture for low voltage mode.

2. Utilize the fist gesture for high voltage mode.

3. The gesture controls are editable under "VRCF -> Gesture control" to set custom gestures for both low voltage (LV) and high voltage (HV) modes.

Additional Step: Removing OSC File for Input Issues

1. In the event that you encounter difficulties receiving inputs from OSC, consider deleting your Avatar OSC File. Navigate to the following directory:

Note: The remaining setup is handled by VRCFury. Upload your avatar to the VRChat platform, and enjoy the PiShock addon in action.

Conclusion: By following these steps, you should have successfully installed and configured the PiShock addon for your Unity project. Now, you're ready to upload your avatar to VRChat and experience the shock effects in-game. Have fun, and remember to be mindful of your users' experiences!

Usage Tool

PiShock Tool Usage Guide

Step 1: Launching the PiShock Tool:

1. Open the PiShock Tool on your computer.

2. Once launched, you'll find the tool interface divided into left and right sections.

Left Side Configuration:

1. Friendly App Name:

   • On the left side, add a friendly name for the app. This name will be displayed in the PiShock Logs.

2. PiShock Account Information:

   • Enter your username and API key from the PiShock site (https://pishock.com/#/account).

3. OSC Router Configuration (Optional):

   • If you're using an OSC router, you can change the receive port on this side.

Right Side Configuration:

1. Add Parameters for PiShock Prefab:

   • Press the lightning symbol on the right side to add the necessary parameters for the PiShock prefab.

2. Configure Share Code and Shock Parameters:

   • Change to your share code.

   • Adjust the values of strength, duration, and timeout to your preferences.

     • Strength can be a full number (e.g., 10) for a fixed value or a range (e.g., 10-50) for a variable value that will be random. The same applies to duration and timeout.

     • Timeout is the time in seconds the program will wait before sending the next API call, preventing continuous shocks.

     • Shock chance determines the likelihood of getting shocked. 100 guarantees a shock, while 50 means a 50% chance at random. For the PiShock prefab, leaving it at 100 is recommended.

3. Save Configuration:

   • Don't forget to hit "Save" after making changes to ensure your configurations are stored.

Note:

• Due to the nature of ping and network operations, there might be slight delays or desynchronization in requests, especially when using multiple shockers. Be mindful of this behavior during usage.

Conclusion: By following these steps, you should have successfully configured the PiShock Tool for controlling the parameters of the PiShock prefab. Now, you can use the tool to customize shock experiences and manage settings according to your preferences.

Changelogs

1.2

• Updated VRCFury version

• Added easier gesture customizability
  Rebind the gesture used under VRCF -> Gesture control for LV and HV Mode

• Cleaned up hierarchy

• Moved more elements to VRCFury

• Fixed HV mode being sent unintentionally

1.1

• Cleaned up Prefab

• Reseized icons

1.0

• Initial Release