https://github.com/elliotcubit/webfishingbuttplug
A mod for WEBFISHING that adds basic Buttplug.io integration
https://github.com/elliotcubit/webfishingbuttplug
buttplug godot godot-engine mod modding webfishing webfishing-mod
Last synced: 12 months ago
JSON representation
A mod for WEBFISHING that adds basic Buttplug.io integration
- Host: GitHub
- URL: https://github.com/elliotcubit/webfishingbuttplug
- Owner: elliotcubit
- License: mit
- Created: 2024-11-14T01:12:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-16T19:47:55.000Z (over 1 year ago)
- Last Synced: 2025-03-27T19:23:14.284Z (about 1 year ago)
- Topics: buttplug, godot, godot-engine, mod, modding, webfishing, webfishing-mod
- Language: C#
- Homepage:
- Size: 99.6 KB
- Stars: 17
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WebfishingButtplug
This is a mod for [WEBFISHING](https://store.steampowered.com/app/3146520/WEBFISHING/) that adds basic [Buttplug.io](https://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](https://docs.intiface.com/docs/intiface-central/quickstart/).
1. Install [GDWeave](https://github.com/NotNite/GDWeave/tree/main).
1. Install [TackleBox](https://github.com/puppy-girl/TackleBox/).
1. Download the latest release and unzip it into your `GWWeave/mods` folder.
1. Ensure Intiface Central is running.
1. Start the game
1. 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](https://github.com/NotNite/GDWeave/tree/main).
It depends also on [TackleBox](https://thunderstore.io/c/webfishing/p/PuppyGirl/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](https://docs.intiface.com/docs/intiface-central/quickstart/).
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](https://thunderstore.io/c/webfishing/p/PuppyGirl/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](https://github.com/elliotcubit/WebfishingButtplug), 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](https://give.thetrevorproject.org/give/63307/#!/donation/checkout) or [The ACLU](https://action.aclu.org/give/now).
## Licenses
The following license is for [Godot.Buttplug](https://github.com/erodozer/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.