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: 3 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 (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-14T22:50:24.000Z (3 months ago)
• Last Synced: 2024-11-14T23:29:56.621Z (3 months ago)
• Topics: buttplug, godot, godot-engine, mod, modding, webfishing, webfishing-mod
• Language: GDScript
• Homepage:
• Size: 14.6 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• 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.

I don't expect anyone to actually _use_ this, but I hope it's helpful to you regardless!

## Features

- Vibrates at a base level while in the fishing minigame

- Vibration intensity increases while mashing

## Installing

1. Install [Intiface Central](https://docs.intiface.com/docs/intiface-central/quickstart/).

1. Install [GDWeave](https://github.com/NotNite/GDWeave/tree/main).

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/

      ButtPlugIO/    // The capitalization DOES matter!!

        ButtPlugIO.dll

        // ... and other files

```

## Dependencies

The mod is loaded using [GDWeave](https://github.com/NotNite/GDWeave/tree/main).

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.

## 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.