Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/DryIcedTea/Buttplug-Valley

Adds buttplug.io integration to stardew valley
https://github.com/DryIcedTea/Buttplug-Valley

Last synced: about 15 hours ago
JSON representation

Adds buttplug.io integration to stardew valley

Lists

README

        

# Buttplug Valley
## A [Buttplug.io](https://buttplug.io/) mod for Stardew Valley

This mod allows you to connect your Buttplug.io compatible toys to Stardew Valley!
## [DOWNLOADS](https://github.com/DryIcedTea/Buttplug-Valley/releases)

## Installation and Setup
1. Install [Intiface Central](https://intiface.com/central/)
- This is what the mod uses to communicate with your toys.
2. Install [SMAPI](https://smapi.io/).
3. Install the [Buttplug Valley Mod](https://github.com/DryIcedTea/Buttplug-Valley/releases) and place it in your Stardew Valley Mods folder.
4. (Optional) Install the [Generic Mod Config Menu Mod](https://www.moddrop.com/stardew-valley/mods/771692-generic-mod-config-menu) to customize your experience. Can also be found on [Nexus Mods](https://www.nexusmods.com/stardewvalley/mods/5098)

## Default Keybinds
* `P` - Stop Vibration
* `I` - Disconnect Toy and stop all vibrations
* `K` - Reconnect Toy
## Features
Features in bold are new in the latest release!
* Vibrations on taking damage (Scales with health)
* Vibrations on **hitting trees, felling trees** and breaking the tree stump
* Vibrations on picking up fish, crops and milk. (Scales with quality)
* Vibrations on day end and start.
* Vibrations on fully breaking rocks.
* Vibrations in the Fishing Minigame! **Now with extra vibrations for the fishing rod!**
* Vibrations on killing enemies. Scales with the amount of enemies killed at once.
* Scaling vibrations with the amount of stones broken at once.
* Vibrations in the arcade machine games.
* Vibrations on collecting foraging items!
* Vibrations on Horse Riding! **Now synced to horse movement!**
* Vibrations on opening dialogue boxes! (Mailbox, TV, talking to people etc.)
* Anti Timeout feature, to keep your toys from disconnecting!
* **Xtardew Valley, Dark Club and RainsInteractionMod integration! (Thanks to Darkstar for making this happen!)**
* **Vibrations on using the hoe and watering can! (Scales with tool power)**
* **Vibrations on cutting grass!**
* **Vibrations on kissing your partner (Thx to Darkstar for this!)**
* Customizable vibration strength and toggles for each feature
* Requires the [Generic Mod Config Menu Mod](https://www.moddrop.com/stardew-valley/mods/771692-generic-mod-config-menu)
* Can also be found on [Nexus Mods](https://www.nexusmods.com/stardewvalley/mods/5098)

### [Pre-Release](https://github.com/DryIcedTea/Buttplug-Valley/releases) features
* All pre release features are now in the main release!

## Planned Features
* Vibrations on breaking large rocks and stumps
* Suggestions are more than welcome!
## FAQ
### What toys does this work with?
Check Out [https://iostindex.com/](https://iostindex.com/).
### Can I use this in multiplayer?
Yes! Your fellow players might be able to trigger certain events though.
### Does it support multiple toys at once?
Yes!
### Will you add or change X feature?
Maybe. Please let me know what you want to see added/changed!

## Feedback
If you have any feedback, feel free to open an issue, [tweet](https://twitter.com/DryIcedMatcha) at me or message me on discord. You'll find me in the [buttplug.io discord](https://discord.buttplug.io/)!
I don't know what I'm doing, so feedback is **very** much appreciated.

## Special thanks
* qdot for adding multiple device support and helping me with some of the code!
* Bo-Shamo for adding foraging support!
* nocturnalmusings for adding the anti timeout function