WebfishingButtplug

This is a mod for WEBFISHING that adds basic Buttplug.io integration.

Features

• Vibrates constantly at a configurable base intensity
• Vibrates at a different base level while in the fishing minigame
• Vibration intensity increases while mashing
• Vibrates while completing scratch-off tickets

Installing

1. Install Intiface Central.
2. Install GDWeave.
3. Install TackleBox.
4. Download the latest release and unzip it into your GWWeave/mods folder.
5. Ensure Intiface Central is running.
6. Start the game
7. You're good to go!

Your game files should look something like this, if things are installed correctly:

WEBFISHING /
  webfishing.exe     // game files
  steam_api64.dll    // game files
  winmm.dll          // GDWEAVE dependency
  GDWEAVE/
    GDWeave.log      // Log output of modloader
    configs/
    core/
    mods/
      TackleBox/     // This must be installed
      ButtPlugIO/    // The capitalization DOES matter!!
        ButtPlugIO.dll
        // ... and other files

Dependencies

The mod is loaded using GDWeave.

It depends also on TackleBox, which is used to configure the mod in-game.

The mod will connect to a Buttplug server, which will most likely be Intiface Central. See those docs for setup - they have extensive documentation. After the server is running, the game will connect to it via websockets on boot.

Configuration

ButtPlugIO uses TackleBox to manage its configuration at runtime.

After installing TackleBox, you will see a new Mods option in your main menu. This option is also available while you are in-game!

Note that these screenshots can only be viewed on GitHub, not thunderstore.

After opening it, find ButtPlugIO in the mods list. If you haven't installed other mods, it will be the only one.

There are a several options available. The mod can be disabled/enabled entirely, you can point it at a specific address for the server, and you can adjust the vibration settings.

You can also toggle individual vibration triggers on or off via this menu - all features default to off.

The valeus for vibration intensity and step are expressed in decimal percentages. This is standard for ButtPlugIO, but might be unintuitive. This means that a value of 0.05 (the default) means that the vibration intensity will be 5% of the total available. Devices general support differing levels of granularity here, so you may have to play with the numbers to get things working!

Debugging

This thing is a little buggy at this time. If it drops connection to the device (or to IC central), open the mod menu and try turning it off-and-on again. If no luck, please feel free to file a GitHub Issue!

Donations

If you want to compensate me for this work (please do not feel like you need to do this), please consider donating to The Trevor Project or The ACLU.

Licenses

The following license is for Godot.Buttplug, which I used for most of the interesting bits and bundled in here:

MIT License

Copyright (c) 2021 Nicholas Hydock

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.