Skip to content

Commit

Permalink
Add LICENSE and READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
BytewaveMLP committed Dec 12, 2018
1 parent 813edd3 commit bd0fbf6
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018 Eliot Partridge

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.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# DGBP

> A Duck Game client for the Buttplug protocol... seriously.
DGBP is a mod for Duck Game which allows for the control of vibrating sex toys by use of the [Buttplug](https://buttplug.io) protocol. It uses the [buttplug-csharp](https://github.com/buttplugio/buttplug-csharp) library as well as the [Buttplug Windows Suite](https://github.com/buttplugio/buttplug-windows-suite).

## Why?

Because a friend and I own Lovense Hushes and decided it would be fun.

## How does this work?

Every time you win, your vibrator power drops by 20%. Every time someone else wins, your vibrator power goes up by 20%. If you tie, nothing happens.

## How do I use it?

1. Install the mod. This can be done by downloading a copy from the [Releases](https://github.com/BytewaveMLP/DGBP/releases) page and extracting the contents to a folder called `DGBP` in `%USERPROFILE/Documents/DuckGame/Mods`. Workshop publishing may come later, but for now, I'll hold off from this for fear of violating the Steam Subscriber Agreement or something.
2. Install the [Buttplug Windows Suite](https://github.com/buttplugio/buttplug-windows-suite) and run "Buttplug Server." Hit "Stop" in the UI, change the port to `6969`, disable "SSL/TLS," and press "Start."
3. Turn on or otherwise power your toy.
4. Launch Duck Game. In the log panel of Buttplug Server, you should see your toy detected as the game starts. If you don't see this, check to make sure your toy is supported by Buttplug.
5. Start an online multiplayer match of Duck Game, and play! You should feel the results if all goes well.

## Issues?

Please let me know if anything doesn't work using the issues page above.

## License

Copyright (c) Eliot Partridge, 2018. Licensed under [the MIT license](/LICENSE).

"[Duck Game](https://store.steampowered.com/app/312530/Duck_Game/)" is property of Landon Podbielski.

0 comments on commit bd0fbf6

Please sign in to comment.