/buttplug-csharp

C# Implementation of Buttplug server, for Windows 7-10

Primary LanguageC#OtherNOASSERTION

Buttplug - Windows C# Server Implementation

Build status codecov

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. It's basically a userland HID manager for things that may not specifically be HID.

If you're looking for the installer for the Websocket Server, Game Vibration Router, or Kiiroo Emulator, visit our releases page.

Table Of Contents

Support The Project

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

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 README in the main buttplug repo.

Hardware Support

Buttplug C# Supports the following platforms:

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

    • BLE Devices
      • Fleshlight Launch
      • Lovense Toys
      • Vorze Interactive A10 Cyclone SA
      • Vibratissimo Toys
      • Magic Motion Toys
      • WeVibe Toys
      • Youcups Warrior II
    • Serial Devices
      • ErosTek ET312B
    • Other devices
      • Xbox Compatible Gamepads (XInput, Vibration Control Only)
  • Windows 7/8 and 10 pre 15063

    • Serial Devices
      • ErosTek ET312B
    • Other devices
      • Xbox Compatible Gamepads (XInput, Vibration Control Only)

Installation

The Buttplug C# Repo hosts the Buttplug C# Development Libraries, as well as the following applications:

  • Websocket Server
  • Game Vibration Router
  • Kiiroo Desktop Platform Emulator

To download the installer for these applications, visit our releases page.

Development

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.

Special Installation Steps When Building Buttplug Applications

Due to a bug in the Windows 15063 SDK, applications using the BLE APIs need to have an AppId in the registry with a special SDDL access string. For more info on this bug, see this msdn forums post.

For those using the installer, this step should be taken care of by InnoSetup. If you are building the project locally, start regedit, then choose File > Import, and select the app.reg file in this repo. This will set permissions for all executables named Buttplug.exe, ButtplugCLI.exe, and ButtplugGUI.exe

Third Party Applications Using Buttplug C#

License

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