Buttplug 3.0.0

.NET Standard 2.0
dotnet add package Buttplug --version 3.0.0
NuGet\Install-Package Buttplug -Version 3.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Buttplug" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Buttplug --version 3.0.0
#r "nuget: Buttplug, 3.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Buttplug as a Cake Addin
#addin nuget:?package=Buttplug&version=3.0.0

// Install Buttplug as a Cake Tool
#tool nuget:?package=Buttplug&version=3.0.0

Buttplug C# - Client Only Implementation

Patreon donate button Github donate button Discourse Forums Discord Twitter

This repo houses are pure .Net version of the Buttplug C# Client, runnings the Version 3 Buttplug Spec. It is expected to run against either Intiface Central (GUI) or Initface Engine (CLI). No Rust FFI bindings are required.

What happened? Why is buttplug-csharp back?

For those of you that have been around a while, you may remember that this used to be the main C# implementation. From 2017 to 2020, it was the reference version of the Buttplug Intimate Haptics Control Standard.

Then I rewrote everything in Rust because I like Rust more and it's far easier for me to port across platforms. This repo was archived ~2 years ago in preference to seating the C# client and server on top of the Rust implementation of Buttplug, as part of the Rust FFI Project.

That project ended up being a partial failure.

While the FFI system is handy for languages where it is very difficult to rebuild some parts of the library (C/C++/Java/etc...), for managed langauges like Javascript and C#, requiring both the client and server to use the FFI was overkill, and caused many extremely difficult-to-debug issues. With that in mind, the C# implementation is being turned into a Client only, .Net native implementation that should run on all platforms.

Documentation and Examples

Documentation is now available via the Buttplug Developer Guide.

C# Examples are in the Dev Guide, and are available in the Dev Guide Repo.

Didn't ManagedButtplugIo already do this?

ManagedButtplugIo is a community produced, .Net native version of the Buttplug C# API, modeled off the FFI (which itself was modeled off of the original C# API). It's been helping the community along while the C# FFI implementation went off a cliff.

They did a very good job and I'm very appreicative of it (and I've used it in some of my own projects)!

The main reason I'm still keeping up my own C# client is that this is a big part of a LOT of the systems I maintain, like the Unity plugin. As part of how I fund this project is consulting on those, I need an implementation I'm responsible for. That said, this doesn't have to be the only implementation, and I'll still be keeping all imeplementations listed both in this README and on our Awesome List

Nuget and Packages

In order to reduce the amount of required dependencies, Buttplug is currently split into 3 Nuget packages.

  • Buttplug - The Client Implemenation. Only dependency is NewtonsonJSON and Microsoft.CSharp 4.7
  • Buttplug.Client.Connectors.WebsocketConnector
    • A Websocket connector built in top of WebsocketListener. While a websocket implementation is very much needed to use the client libraries, This is kept as a seperate dependency in case developers want to use a connector built on top of another Websocket library that may work better with or is already integrated in their setup (Like WebsocketSharp).
  • Buttplug.Util.WebsocketDevice (Not yet available) - This is a test package that allows simulation of devices via the Buttplug Websocket Device Manager. More info about this can be found in The Buttplug Developer Guide.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (9)

Showing the top 5 NuGet packages that depend on Buttplug:

Package Downloads
Buttplug.Server.Managers.XInputGamepadManager

Adds XInput Device enumeration and vibration/rumble control to Buttplug. (.Net Framework 4.7+ Only)

Buttplug.Server.Managers.UWPBluetoothManager

UWP Bluetooth (Windows 10 15063 Creators Update or Later) device support for Buttplug Servers. (.Net Framework 4.7+ only)

Buttplug.Server.Connectors.WebsocketServer

Websocket Connection Capabilities for Buttplug Servers. (.Net Framework 4.7+/.Net Standard 2.0)

Buttplug.Client.Connectors.WebsocketConnector

Websocket Connection Capabilities for Buttplug Clients. (.Net Standard 2.0+)

Buttplug.Server.Managers.WinUSBManager

WinUSB device support (Rez Trancevibrator) for Buttplug Servers. (.Net Framework 4.7+ only)

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Buttplug:

Repository Stars
RonSijm/ButtFish
Effortlessly transmitting Morse Code of chess moves to your butthole 💝
FredTungsten/ScriptPlayer
ScriptPlayer is a video player that controls the Handy and lots of other toys in sync with videos.
Version Downloads Last updated
3.0.0 799 12/31/2022
3.0.0-alpha1 73 12/29/2022
3.0.0-alpha0 64 12/29/2022
2.0.6 2,262 12/10/2021
2.0.5 727 8/29/2021
2.0.4 342 8/21/2021
2.0.3 864 5/17/2021
2.0.2 424 5/15/2021
2.0.1 371 4/25/2021
2.0.0 298 4/23/2021
1.0.18 448 4/4/2021
1.0.17 317 3/22/2021
1.0.16 467 2/20/2021
1.0.15 327 2/16/2021
1.0.14 315 2/13/2021
1.0.13 342 2/8/2021
1.0.12 307 2/7/2021
1.0.11 480 1/25/2021
1.0.10 320 1/23/2021
1.0.9 327 1/20/2021
1.0.8 471 1/10/2021
1.0.7 439 1/9/2021
1.0.6 400 1/5/2021
1.0.5 337 1/2/2021
1.0.4 424 1/2/2021
1.0.3 405 1/1/2021
1.0.2 349 12/31/2020
1.0.1 335 12/28/2020
1.0.0-beta.8 227 12/23/2020
1.0.0-beta.7 349 12/14/2020
1.0.0-beta.6 206 12/12/2020
1.0.0-beta.5 237 11/30/2020
1.0.0-beta.4 183 11/26/2020
1.0.0-beta.3 199 11/23/2020
1.0.0-beta.2 306 11/22/2020
1.0.0-beta.1 230 11/21/2020
0.5.9 2,101 6/18/2020
0.5.8 1,218 6/17/2020
0.5.7.1027-dev-38e2e28 567 5/14/2020
0.5.7 1,235 5/14/2020
0.5.6 1,849 12/11/2019
0.5.5 1,291 12/7/2019
0.5.4.769-dev-4bb0dd3 580 12/7/2019
0.5.4.766-dev-fa90db1 568 12/7/2019
0.5.4 1,341 11/27/2019
0.5.3.781-dev-7b367ea 582 12/11/2019
0.5.3.778-dev-fb73beb 556 12/10/2019
0.5.3.760-dev-f2c0e4b 557 11/27/2019
0.5.3.759-dev-7e395cb 562 11/27/2019
0.5.3 2,017 10/4/2019
0.5.1.725-dev-bc25b80 597 11/11/2019
0.5.1.724-dev-7adc8a6 560 11/11/2019
0.5.1 1,301 9/27/2019
0.5.0.667-dev-fccf1d6 597 9/27/2019
0.5.0.666-dev-9220493 565 9/26/2019
0.5.0.665-dev-f7db350 559 9/26/2019
0.5.0 2,338 7/29/2019
0.4.7.647-dev-a6c4653 1,482 7/29/2019
0.4.7.646-dev-74df418 1,453 7/29/2019
0.4.7.643-dev-29bdc22 1,445 7/28/2019
0.4.7.639-dev-1b5ec5a 1,445 7/28/2019
0.4.7.638-dev-9372114 1,462 7/28/2019
0.4.7.637-dev-056d55a 1,431 7/28/2019
0.4.7.636-dev-bf90a31 1,433 7/28/2019
0.4.7 2,516 7/1/2019
0.4.6 2,052 5/28/2019
0.4.5.574-dev-6ea2a60 1,422 5/28/2019
0.4.5 1,966 5/26/2019
0.4.4.561-dev-272e417 1,418 5/26/2019
0.4.4 2,020 5/21/2019
0.4.3.548-dev-52e1063 1,446 5/21/2019
0.4.3.545-dev-13b27d1 1,424 5/16/2019
0.4.3.453-dev-d7cd385 1,759 4/2/2019
0.4.3.448-dev-b49645e 1,468 3/31/2019
0.4.3 2,200 3/31/2019
0.4.2.444-dev-a8557c5 1,519 3/31/2019
0.4.2.412-dev-225d192 1,491 3/30/2019
0.4.2.398-dev-2f71705 1,472 3/29/2019
0.4.2.396-dev-cfe4956 1,465 3/29/2019
0.4.2.378-dev-449c2f0 1,456 3/28/2019
0.4.2 2,131 3/16/2019
0.4.1.327-dev-16da3c0 1,510 3/16/2019
0.4.1 2,078 3/9/2019
0.4.0.313-dev-8f27d52 1,446 3/9/2019
0.4.0.295-dev-d91d568 1,459 3/9/2019
0.4.0.271-dev-7bbe7ce 1,493 3/9/2019
0.4.0.269-dev-3c8ddcd 1,503 3/8/2019
0.4.0.230-dev-4bd083f 1,495 3/5/2019
0.4.0.229-dev-ec7ddfd 1,495 3/5/2019
0.4.0.207-dev-b275ae2 1,467 3/4/2019
0.4.0.205-dev-d8d9dd8 1,505 3/4/2019
0.4.0.201-dev-ca5478d 1,469 2/27/2019
0.4.0.173-dev-b926e79 1,510 2/23/2019
0.4.0 2,155 2/15/2019
0.3.3.903-master 1,475 1/30/2019
0.3.3.890-master 1,540 1/14/2019
0.3.3.134-master-8df5e8e 1,520 2/15/2019
0.3.3.133-master-1f76aee 1,532 2/15/2019
0.3.3.132-dev-8df5e8e 1,498 2/15/2019
0.3.3.130-dev-1f76aee 1,543 2/15/2019
0.3.3.128-dev-d238a76 1,498 2/14/2019
0.3.3 2,167 1/14/2019
0.3.3-dev-54ee365 1,598 2/14/2019
0.3.2.874-master 1,572 11/24/2018
0.3.2 1,944 11/24/2018
0.3.1.869-master 1,559 11/9/2018
0.3.1 1,973 11/9/2018
0.3.0.864-master 1,587 11/4/2018
0.3.0.861-master 1,577 11/4/2018
0.3.0 6,274 11/4/2018
0.2.3.858-master 1,537 11/4/2018
0.2.3.853-master 1,564 11/3/2018
0.2.3.849-master 1,662 11/2/2018
0.2.3-dev 1,465 11/2/2018