Buttplug sex toy control library
1# Buttplug 2 3[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot) 4[![Github donate button](https://img.shields.io/badge/github-donate-ff69b4.svg)](https://www.github.com/sponsors/qdot) 5[![Discourse Forums](https://img.shields.io/discourse/status?label=buttplug.io%20forums&server=https%3A%2F%2Fdiscuss.buttplug.io)](https://discuss.buttplug.io) 6[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io) 7[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio) 8[![bluesky](https://img.shields.io/bluesky/followers/buttplug.io)](https://bsky.app/profile/buttplug.io) 9 10[![Crates.io Version](https://img.shields.io/crates/v/buttplug)](https://crates.io/crates/buttplug) 11[![Crates.io Downloads](https://img.shields.io/crates/d/buttplug)](https://crates.io/crates/buttplug) 12[![Crates.io License](https://img.shields.io/crates/l/buttplug)](https://crates.io/crates/buttplug) 13 14# Buttplug In-Process Client Library 15 16**YOU PROBABLY SHOULDN'T USE THIS,** but we're including it anyways. 17 18If you want to build stand-alone Rust-based applications using Buttplug, you're in the right place. 19 20This library contains everything you need to scan for devices, and control their inputs and outputs. 21 22## Why shouldn't I use this? 23 24Building a standalone application with this library means you'll have to update when we do. We're constantly adding device and protocol support to the library, which means changes to the core rust system. Since we may not keep APIs the same, you'll be on the hook to upgrade when we do, or else your software will fall behind in support. 25 26## Then why does this exist? 27 28'cause it can make testing ideas, or just bringing up quick shitposts for sake of making a video or one-off project easier. 29 30## License 31 32Buttplug is BSD 3-Clause licensed. 33 34```text 35 36Copyright (c) 2016-2025, Nonpolynomial, LLC 37All rights reserved. 38 39Redistribution and use in source and binary forms, with or without 40modification, are permitted provided that the following conditions are met: 41 42* Redistributions of source code must retain the above copyright notice, this 43 list of conditions and the following disclaimer. 44 45* Redistributions in binary form must reproduce the above copyright notice, 46 this list of conditions and the following disclaimer in the documentation 47 and/or other materials provided with the distribution. 48 49* Neither the name of buttplug nor the names of its 50 contributors may be used to endorse or promote products derived from 51 this software without specific prior written permission. 52 53THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 54AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 55IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 56DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 57FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 58DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 59SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 60CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 61OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 62OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 63```