[Help Needed] Karryn's Prison - Karryn's buttplug.io mod

Software Game mod
,
25

Since i am not really working on this mod i thought I’d share the code i currently have and how to continue it.

currently my setup is:

  • Visual studio Code
  • Vortex Mod Loader
  • NW.js To allow debugging of the code. (i dont know where i got it from originally but i added it to the Mega Folder. once the game is started up press F12 to see a console where you can call functions and see outputs from console.log())
  • Mod Settings
  • All Mod Files and Images can be found here: Mega

To edit and build the code for use you want to:
how to build image

  • Open Karryns_Buttplug folder in Visual Studio

  • To build the project click on package.json and a small arrow with the word debug should appear on line5.

  • if you click it you get 2 options at the top. Click Build and wait for it to finish.

  • in the Karryns_Buttplug folder open the folder dist, these two files are the mod files.

  • Place the mod files in your vortex folder as follows: \mods\karryns buttplug\www\mods (You can navigate here easily by using the Open... button in the yellow bar and click: Open Mod Staging Folder. Image

Things i know about the code:

  • src/index.ts is the main start of all files if i remember correctly, which loads src/main.ts.

  • src/main.ts is where the main functions get loaded such as intiface connection.

  • ReplaceGlobalRaidFunctions function to load all types of battle interactions.

  • decorate (startBattle) function which triggers on initiating combat which currently stops all devices.

  • decorate (endBattle) function triggers after battle and currently starts the fluffing (Alternating based on arousal). The file that controlls this is in: src/actions/startFluffing.ts on line 29.

  • decorate (startTurn) i don’t remember when excactly this triggers but currently only outputs a message to the debug console.

As for Creating custom actions:

  • for a certain scenario have a look at the file: src/actions/replaceGlobalRaindFunctions.ts here is a list of the actions that can be performed, you can also add ones here. once they are triggered they will look for the file with the same name in: src/actions/raid/raidArousal.ts (for the action raidArousal). you can create more files there, but if its not found it will revert to src/actions/raid/raidDefault.ts.

  • There are a few ways to send commands to the toy as for: pattern which uses a duration in milliseconds for the whole pattern. The pattern that should be applied in order between 1 and 0. (i dont remember which is fully in and out) and i believe you can make this pattern as long as you want.

  • All current available actions are in: src/entities/device.ts

Creating Device Settings
all settings for each connected device are in: src/settings/deviceSettings.ts.
i haven’t worked with this a lot so i can’t tell you a lot about it.

I think i got everything, if not let me know!
i hope someone has the time to make this into a proper mod.

6 Likes