{"id":20531178,"url":"https://github.com/elliotcubit/webfishingbuttplug","last_synced_at":"2025-04-14T05:40:43.021Z","repository":{"id":262903737,"uuid":"888192968","full_name":"elliotcubit/WebfishingButtplug","owner":"elliotcubit","description":"A mod for WEBFISHING that adds basic Buttplug.io integration","archived":false,"fork":false,"pushed_at":"2024-11-16T19:47:55.000Z","size":102,"stargazers_count":17,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T19:23:14.284Z","etag":null,"topics":["buttplug","godot","godot-engine","mod","modding","webfishing","webfishing-mod"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elliotcubit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-14T01:12:03.000Z","updated_at":"2025-01-28T21:14:37.000Z","dependencies_parsed_at":"2024-11-14T23:29:59.429Z","dependency_job_id":"8091996a-ebab-462c-8e33-985801958da8","html_url":"https://github.com/elliotcubit/WebfishingButtplug","commit_stats":null,"previous_names":["elliotcubit/webfishingbuttplug"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elliotcubit%2FWebfishingButtplug","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elliotcubit%2FWebfishingButtplug/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elliotcubit%2FWebfishingButtplug/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elliotcubit%2FWebfishingButtplug/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elliotcubit","download_url":"https://codeload.github.com/elliotcubit/WebfishingButtplug/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248830416,"owners_count":21168271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["buttplug","godot","godot-engine","mod","modding","webfishing","webfishing-mod"],"created_at":"2024-11-15T23:43:08.214Z","updated_at":"2025-04-14T05:40:43.013Z","avatar_url":"https://github.com/elliotcubit.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebfishingButtplug\n\nThis is a mod for [WEBFISHING](https://store.steampowered.com/app/3146520/WEBFISHING/) that adds basic [Buttplug.io](https://buttplug.io/) integration.\n\n## Features\n\n- Vibrates constantly at a configurable base intensity\n- Vibrates at a different base level while in the fishing minigame\n- Vibration intensity increases while mashing\n- Vibrates while completing scratch-off tickets\n\n## Installing\n\n1. Install [Intiface Central](https://docs.intiface.com/docs/intiface-central/quickstart/).\n1. Install [GDWeave](https://github.com/NotNite/GDWeave/tree/main).\n1. Install [TackleBox](https://github.com/puppy-girl/TackleBox/).\n1. Download the latest release and unzip it into your `GWWeave/mods` folder.\n1. Ensure Intiface Central is running.\n1. Start the game\n1. You're good to go!\n\nYour game files should look something like this, if things are installed correctly:\n\n```\nWEBFISHING /\n  webfishing.exe     // game files\n  steam_api64.dll    // game files\n  winmm.dll          // GDWEAVE dependency\n  GDWEAVE/\n    GDWeave.log      // Log output of modloader\n    configs/\n    core/\n    mods/\n      TackleBox/     // This must be installed\n      ButtPlugIO/    // The capitalization DOES matter!!\n        ButtPlugIO.dll\n        // ... and other files\n```\n\n## Dependencies\n\nThe mod is loaded using [GDWeave](https://github.com/NotNite/GDWeave/tree/main).\n\nIt depends also on [TackleBox](https://thunderstore.io/c/webfishing/p/PuppyGirl/TackleBox/), which is used to configure the mod in-game.\n\nThe mod will connect to a Buttplug server, which will _most likely_ be [Intiface Central](https://docs.intiface.com/docs/intiface-central/quickstart/).\nSee those docs for setup - they have extensive documentation. After the server is running, the game will connect to it via websockets on boot.\n\n## Configuration\n\nButtPlugIO uses [TackleBox](https://thunderstore.io/c/webfishing/p/PuppyGirl/TackleBox/) to manage its configuration at runtime.\n\nAfter installing TackleBox, you will see a new `Mods` option in your main menu. This option is also available while you are in-game!\n\nNote that these screenshots can only be viewed on [GitHub](https://github.com/elliotcubit/WebfishingButtplug), not thunderstore.\n\n![Screenshot of mod menu item](./assets/menu.png)\n\nAfter opening it, find ButtPlugIO in the mods list. If you haven't installed other mods, it will be the only one.\n\n![Screenshot of ButtPlugIO in the mods list](./assets/configure.png)\n\nThere 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.\n\nYou can also toggle individual vibration triggers on or off via this menu - all features default to _off_.\n\n![Screenshot of the options that are available in game](./assets/configuration_options.png)\n\nThe 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\nthe numbers to get things working!\n\n## Debugging\n\nThis 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.\nIf no luck, please feel free to file a GitHub Issue!\n\n## Donations\n\nIf 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).\n\n## Licenses\n\nThe 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:\n\nMIT License\n\nCopyright (c) 2021 Nicholas Hydock\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felliotcubit%2Fwebfishingbuttplug","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felliotcubit%2Fwebfishingbuttplug","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felliotcubit%2Fwebfishingbuttplug/lists"}