Warrior of Lightning

A FFXIV Plugin that integrates Pishock, OpenShock and Intiface Central devices.

If any Problems, Questions or Suggestions come up, you can send those in the Discord Server!
Or if you want to be fancy, open a Issue. That also works.

Ingame UI Preview:

Current Features

• Social Triggers:
  Doing a specified Emote
  Doing a specified Emote to someone
  Getting emoted at by someone
  Saying a Banned Word from a List
  Forgetting to say a Enforced Word from a List
  Hearing someone say a Trigger Word from a List
  Losing a Deathroll

• Combat Triggers:
  Dying
  Failing a Mechanic
  Any Partymember dies
  Party Wipes
  Forgetting a Partner Buff (Kardia or Dance Partner)
  Taking any kind of Damage
  Forgetting to Level Synch for a Fate

• Misc Triggers:
  Sitting on Furniture
  Using a Mount or Riding Pillion
  Fail a Craft
  Fail a HQ Craft
  Fail to meld Materia
  Fail to catch a Fish
  Use Teleportation
  Forgetting to eat Food before Combat or Crafting

• Presets for quick swapping of Settings

• Control Settings
  Allow another player to control specific parts of the Plugin including:
  Preset Swapping
  Preset Locking
  Applying a Leash to you

• A safeword with /red
  This disables all Pishock & OpenShock functionality from the plugin until used again.

Installation:

You have to use the XIVQuicklauncher with Dalamud enabled for this to work.

Ingame, open the Dalamud Settings, navigate to the "Experimental" Tab and scroll down.
There you find "Custom Plugin Repositories" - Important do not mix this up with "Dev Plugins" at the top!
You will then have to enter this link into the list:
https://raw.githubusercontent.com/TheHeadPatCat/DalamudPlugins/main/repo.json
Save it via the plus sign on the right and then the floppy disk on the bottom right.
Then, open the Plugin Installer and search for "Warrior of Lightning"

Setup:

Once installed, click on "Open" to open the Main Window.
Here you can enable or disable the entire Plugin at any point - this is so it only actually shocks you when you are ready for it.
Alternatively, there is a fast way to disable it using the command /red, this will instantly stop all operations and ignores all Settings - until used again.
Lastly, the "Activate whenever the game starts" is there to automatically activate the plugin right away, when you login.

Firstly, on the very bottom under "Account & Devices" you can swap between your different Connection Methods. All of them can be used at the same time though!

For Pishock, you will need:

• Your Username. It's what you use to login to the Pishock Website and what shows up on it.
• Your API Key. If you have used a different application before, you should already have it saved somewhere on your machine - but if this is your first time: on the Website at the top left, click on "Account" and then "Generate API Key". Save it somewhere on your Machine, as clicking this button a second time, invalidates your previous key.

For OpenShock, you will need:

• The URL of the API you want to access. This is only if you selfhost a server, so if you use the default OpenShock API, just leave it as is.
• A API Token. You can get this on the Website under "API Tokens". Generate one and enter it here.

For Intiface Central, you will need:

• Intiface Central installed and running in the background
• The URL/IP to connect to (you can usually leave this to the default)

To finish it off, press the "Save & Connect" button and give it a moment to figure everything out.
If you did everything correctly, all of your available Devices (even Shared ones) should show up!
If they don't... Check what is shown under the API Connection at the top of the Window.
Maybe you accidentally put something wrong, or the Plugin is having a weird issue. If that happens, please report it on the Discord!

You can click on "Test" on any of the Devices to send out a 1 second Vibration on 35%.
If it doesn't arrive for some reason, make sure that the Shocker is properly connected, and the Hub is turned on!

Configuration

After you have gotten all of this behind you, you can start customizing your experience!
Click on "Open Configuration" to open a big Window, hosting all of the available options.
You can enable as many Rules as you want, and assign any mix and amount of Shockers to them.