C# (.Net Framework 4.7/Standard 2.0) Implementation of Buttplug Client/Server
Clone or download
Permalink
Failed to load latest commit information.
Buttplug.Client.Connectors.WebsocketConnector.Test build: Update NJsonSchema dependency Nov 9, 2018
Buttplug.Client.Connectors.WebsocketConnector build: Fix project dependencies Nov 2, 2018
Buttplug.Examples.01.EmbeddedClientSetup doc: Clean up some tutorial project comments Nov 3, 2018
Buttplug.Examples.02.WebsocketClientSetup build: Fix project dependencies Nov 2, 2018
Buttplug.Examples.03.ConnectionLifetimesAndPingTimers build: Fix project dependencies Nov 2, 2018
Buttplug.Examples.04.DeviceEnumeration doc: Clean up some tutorial project comments Nov 3, 2018
Buttplug.Examples.05.DeviceControl build: Fix project dependencies Nov 2, 2018
Buttplug.Examples.06.LoggingAndErrorHandling doc: Add Logging and Error Handling Tutorial Nov 3, 2018
Buttplug.Examples.07.FullProgram doc: Add more commands to full program example Nov 4, 2018
Buttplug.ProjectFiles chore: Update dictionary and naming rules Oct 13, 2018
Buttplug.Server.Connectors.WebsocketServer.Test build: Update NJsonSchema dependency Nov 9, 2018
Buttplug.Server.Connectors.WebsocketServer build: Fix project dependencies Nov 2, 2018
Buttplug.Server.Managers.HidManager build: Update nuspec requirement to 0.3.0 Nov 4, 2018
Buttplug.Server.Managers.SerialPortManager build: Remove .Net Standard from serial port nuget package desc Nov 9, 2018
Buttplug.Server.Managers.UWPBluetoothManager build: Update nuspec requirement to 0.3.0 Nov 4, 2018
Buttplug.Server.Managers.WinUSBManager build: Update nuspec requirement to 0.3.0 Nov 4, 2018
Buttplug.Server.Managers.XInputGamepadManager build: Update nuspec requirement to 0.3.0 Nov 4, 2018
Buttplug.Test fix: Fix scanningfinished triggering and status updates Nov 9, 2018
Buttplug feat: Adding support for more MagicMotion devices Nov 9, 2018
dependencies/buttplug-schema Merge commit '882ac8f28c4085d2005f552d4ee27119958f7ef7' into 0.3.1-dev Nov 9, 2018
docs build: Add appveyor doc messages and new key Mar 31, 2018
icons doc: Add Buttplug logo Sep 23, 2018
test fix: Fix and add tests for installer registry settings May 22, 2017
.gitignore Correcting a dependency clash in the Buttplug.Client package Feb 2, 2018
.gitmodules build: Remove websocket-sharp module in prep for subtree Jun 17, 2017
Buttplug.sln doc: Add full program example Nov 4, 2018
Buttplug.sln.DotSettings doc: Add more commands to full program example Nov 4, 2018
CHANGELOG.md doc: Update Changelog for 0.3.1 Nov 9, 2018
CODE_OF_CONDUCT.md Syncing CoC and Conrib from buttplug Jun 19, 2017
CONTRIBUTING.md Syncing CoC and Conrib from buttplug Jun 19, 2017
LICENSE doc: Update README links and copyright years Jun 19, 2018
README.md doc: Update README Nov 9, 2018
README_ET312.md Added readme for users detailing usage and state of E-Stim implementa… Nov 16, 2017
app.reg feat: Created Buttplug.Apps.XInputInjector.GUI Aug 14, 2017
appveyor.yml build: Fix CI commands Nov 2, 2018
codecov.yml Migrating to NUnit Jan 17, 2018
stylecop.json test: Add StyleCop and ruleset to all Buttplug projects Jul 6, 2017

README.md

Buttplug Protocol Implementation - C# .Net Standard/Framework

Build status codecov NuGet

Patreon donate button Discourse Forum Discord Twitter

Buttplug is a framework for hooking up hardware to interfaces, where hardware usually means sex toys, but could honestly be just about anything. Think of it as a userland HID manager for things that may not specifically be HID, but may go in your butt.

Or other places too! We're not completely butt-centric, despite the project name. And logo.

If you're looking for the installer for the Buttplug Server or Game Vibration Router software, visit the buttplug-windows-suite releases page.

Table Of Contents

Support The Project

If you find this project helpful, you can support us via Patreon! Every donation helps us afford more hardware to reverse, document, and write code for!

Usage Examples

Want to know what using the library looks like in code? The project includes some heavily commented examples!

API Documentation

API documentation for the current release is available at https://buttplug-csharp.docs.buttplug.io.

Buttplug Spec and Documentation

Buttplug implementations are available in multiple languages (rust, javascript, etc)/frameworks/platforms. For a full list of documentation, libraries, and applications, see the buttplug.io website.

Hardware Support

Buttplug C# Supports the following platforms:

  • Windows 10 - Creators Update (15063, April 2017) or later

    • BLE Devices
      • Fleshlight Launch
      • Kiiroo Toys (Onyx, Pearl, Onyx 2, Pearl 2)
      • LiBo Whale
      • Lovense Toys
      • Magic Motion Toys
      • Mysteryvibe Crescendo
      • OhMiBod Fuse
      • Vibratissimo Toys
      • Vorze Interactive A10 Cyclone SA
      • Vorze UFO SA
      • WeVibe Toys
      • Youcups Warrior II
    • USB Devices
      • Rez Trancevibrator
      • Vorze Cyclone X10
    • Serial Devices
      • ErosTek ET312B
    • Other Devices
      • Xbox Compatible Gamepads (XInput, Vibration Control Only)
  • Windows 7/8 and 10 pre 15063

    • Serial Devices
      • ErosTek ET312B
    • USB Devices
      • Rez Trancevibrator
      • Vorze Cyclone X10
    • Other Devices
      • Xbox Compatible Gamepads (XInput, Vibration Control Only)
  • Linux/Mac (Mono)

    • No hardware support currently

Check https://buttplug.io for a list a fully up-to-date list of supported hardware, as well as planned hardware support.

Installation

Packages and libraries from the buttplug-csharp repo are available via nuget. Simply run a search for "buttplug", or follow this link to the nuget "buttplug" search.

Compiling

The project should compile with Visual Studio 2017, Visual Studio on Mac (.Net Standard projects only), or Mono on linux (.Net Standard projects only).

Note that for building using Visual Studio on Windows 7/8/10, the project requires the Windows 10 SDK to be installed.

Client Software

Buttplug programs including

  • Buttplug Server
  • Game Vibration Router

have moved to the Buttplug Windows Suite Repo. To download the installer for these applications, visit the releases page for that repo.

Third Party Applications Using Buttplug C#

License

Buttplug is BSD 3-Clause licensed. More information is available in the LICENSE file.