Buttplug.Client.Connectors.WebsocketConnector 3.0.0-alpha1

Suggested Alternatives

Buttplug

Additional Details

As of Buttplug v3.1.0, ButtplugWebsocketConnector uses System.Net.Websocket and is now part of the Buttplug.Client module in the Buttplug package. With the external dependency removed, the separate package is no longer needed and has been deprecated.

This is a prerelease version of Buttplug.Client.Connectors.WebsocketConnector.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Buttplug.Client.Connectors.WebsocketConnector --version 3.0.0-alpha1                
NuGet\Install-Package Buttplug.Client.Connectors.WebsocketConnector -Version 3.0.0-alpha1                
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.Client.Connectors.WebsocketConnector" Version="3.0.0-alpha1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Buttplug.Client.Connectors.WebsocketConnector --version 3.0.0-alpha1                
#r "nuget: Buttplug.Client.Connectors.WebsocketConnector, 3.0.0-alpha1"                
#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.Client.Connectors.WebsocketConnector as a Cake Addin
#addin nuget:?package=Buttplug.Client.Connectors.WebsocketConnector&version=3.0.0-alpha1&prerelease

// Install Buttplug.Client.Connectors.WebsocketConnector as a Cake Tool
#tool nuget:?package=Buttplug.Client.Connectors.WebsocketConnector&version=3.0.0-alpha1&prerelease                

Buttplug C# - Client Only Implementation

Patreon donate button Github donate button 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.

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 - 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.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Buttplug.Client.Connectors.WebsocketConnector:

Package Downloads
CStreamer.Plugins.Buttplug

Package Description

BasicButtManager

The lower-level, framework-dependent (.NET 4) driver library for ButtServer.

Edi.Core

Edi.Core is a library that provides an effective way to control and manage devices through a simple Gallery sistem. It is ideal for applications like Games that require detailed and flexible control over the devices.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Buttplug.Client.Connectors.WebsocketConnector:

Repository Stars
RonSijm/ButtFish
Effortlessly transmitting Morse Code of chess moves to your butthole 💝
Version Downloads Last updated
3.0.1 2,432 7/22/2023 3.0.1 is deprecated because it is no longer maintained.
3.0.0 1,765 12/31/2022 3.0.0 is deprecated because it is no longer maintained.
3.0.0-alpha1 681 12/29/2022 3.0.0-alpha1 is deprecated because it is no longer maintained.
3.0.0-alpha0 680 12/29/2022 3.0.0-alpha0 is deprecated because it is no longer maintained.
0.5.9 1,864 6/18/2020 0.5.9 is deprecated because it is no longer maintained.
0.5.8 990 6/17/2020 0.5.8 is deprecated because it is no longer maintained.
0.5.7.1027-dev-38e2e28 880 5/14/2020 0.5.7.1027-dev-38e2e28 is deprecated because it is no longer maintained.
0.5.7 999 5/14/2020 0.5.7 is deprecated because it is no longer maintained.
0.5.6 1,314 12/11/2019 0.5.6 is deprecated because it is no longer maintained.
0.5.5 1,029 12/7/2019 0.5.5 is deprecated because it is no longer maintained.
0.5.4.769-dev-4bb0dd3 903 12/7/2019 0.5.4.769-dev-4bb0dd3 is deprecated because it is no longer maintained.
0.5.4.766-dev-fa90db1 912 12/7/2019 0.5.4.766-dev-fa90db1 is deprecated because it is no longer maintained.
0.5.4 1,019 11/27/2019 0.5.4 is deprecated because it is no longer maintained.
0.5.3.781-dev-7b367ea 946 12/11/2019 0.5.3.781-dev-7b367ea is deprecated because it is no longer maintained.
0.5.3.778-dev-fb73beb 921 12/10/2019 0.5.3.778-dev-fb73beb is deprecated because it is no longer maintained.
0.5.3.760-dev-f2c0e4b 942 11/27/2019 0.5.3.760-dev-f2c0e4b is deprecated because it is no longer maintained.
0.5.3.759-dev-7e395cb 870 11/27/2019 0.5.3.759-dev-7e395cb is deprecated because it is no longer maintained.
0.5.3 1,723 10/3/2019 0.5.3 is deprecated because it is no longer maintained.
0.5.2 1,072 10/3/2019 0.5.2 is deprecated because it is no longer maintained.
0.5.1.725-dev-bc25b80 913 11/11/2019 0.5.1.725-dev-bc25b80 is deprecated because it is no longer maintained.
0.5.1.724-dev-7adc8a6 923 11/11/2019 0.5.1.724-dev-7adc8a6 is deprecated because it is no longer maintained.
0.5.1 1,026 9/27/2019 0.5.1 is deprecated because it is no longer maintained.
0.5.0.667-dev-fccf1d6 921 9/27/2019 0.5.0.667-dev-fccf1d6 is deprecated because it is no longer maintained.
0.5.0.666-dev-9220493 907 9/26/2019 0.5.0.666-dev-9220493 is deprecated because it is no longer maintained.
0.5.0.665-dev-f7db350 940 9/26/2019 0.5.0.665-dev-f7db350 is deprecated because it is no longer maintained.
0.5.0 1,113 7/29/2019 0.5.0 is deprecated because it is no longer maintained.
0.4.7.647-dev-a6c4653 928 7/29/2019 0.4.7.647-dev-a6c4653 is deprecated because it is no longer maintained.
0.4.7.646-dev-74df418 921 7/29/2019 0.4.7.646-dev-74df418 is deprecated because it is no longer maintained.
0.4.7.643-dev-29bdc22 906 7/28/2019 0.4.7.643-dev-29bdc22 is deprecated because it is no longer maintained.
0.4.7.639-dev-1b5ec5a 913 7/28/2019 0.4.7.639-dev-1b5ec5a is deprecated because it is no longer maintained.
0.4.7.638-dev-9372114 933 7/28/2019 0.4.7.638-dev-9372114 is deprecated because it is no longer maintained.
0.4.7.637-dev-056d55a 927 7/28/2019 0.4.7.637-dev-056d55a is deprecated because it is no longer maintained.
0.4.7.636-dev-bf90a31 926 7/28/2019 0.4.7.636-dev-bf90a31 is deprecated because it is no longer maintained.
0.4.7 1,242 7/1/2019 0.4.7 is deprecated because it is no longer maintained.
0.4.6 1,172 5/28/2019 0.4.6 is deprecated because it is no longer maintained.
0.4.5.574-dev-6ea2a60 926 5/28/2019 0.4.5.574-dev-6ea2a60 is deprecated because it is no longer maintained.
0.4.5 1,065 5/26/2019 0.4.5 is deprecated because it is no longer maintained.
0.4.4.561-dev-272e417 951 5/26/2019 0.4.4.561-dev-272e417 is deprecated because it is no longer maintained.
0.4.4 1,144 5/21/2019 0.4.4 is deprecated because it is no longer maintained.
0.4.3.548-dev-52e1063 978 5/21/2019 0.4.3.548-dev-52e1063 is deprecated because it is no longer maintained.
0.4.3.545-dev-13b27d1 970 5/16/2019 0.4.3.545-dev-13b27d1 is deprecated because it is no longer maintained.
0.4.3.453-dev-d7cd385 1,297 4/2/2019 0.4.3.453-dev-d7cd385 is deprecated because it is no longer maintained.
0.4.3.448-dev-b49645e 1,063 3/31/2019 0.4.3.448-dev-b49645e is deprecated because it is no longer maintained.
0.4.3 1,205 3/31/2019 0.4.3 is deprecated because it is no longer maintained.
0.4.2.444-dev-a8557c5 1,037 3/31/2019 0.4.2.444-dev-a8557c5 is deprecated because it is no longer maintained.
0.4.2.412-dev-225d192 1,058 3/30/2019 0.4.2.412-dev-225d192 is deprecated because it is no longer maintained.
0.4.2.398-dev-2f71705 1,100 3/29/2019 0.4.2.398-dev-2f71705 is deprecated because it is no longer maintained.
0.4.2.396-dev-cfe4956 1,026 3/29/2019 0.4.2.396-dev-cfe4956 is deprecated because it is no longer maintained.
0.4.2.378-dev-449c2f0 1,042 3/28/2019 0.4.2.378-dev-449c2f0 is deprecated because it is no longer maintained.
0.4.2 1,289 3/16/2019 0.4.2 is deprecated because it is no longer maintained.
0.4.1.327-dev-16da3c0 986 3/16/2019 0.4.1.327-dev-16da3c0 is deprecated because it is no longer maintained.
0.4.1 1,227 3/9/2019 0.4.1 is deprecated because it is no longer maintained.
0.4.0.313-dev-8f27d52 1,008 3/9/2019 0.4.0.313-dev-8f27d52 is deprecated because it is no longer maintained.
0.4.0.295-dev-d91d568 1,007 3/9/2019 0.4.0.295-dev-d91d568 is deprecated because it is no longer maintained.
0.4.0.271-dev-7bbe7ce 1,069 3/9/2019 0.4.0.271-dev-7bbe7ce is deprecated because it is no longer maintained.
0.4.0.269-dev-3c8ddcd 1,031 3/8/2019 0.4.0.269-dev-3c8ddcd is deprecated because it is no longer maintained.
0.4.0.230-dev-4bd083f 1,067 3/5/2019 0.4.0.230-dev-4bd083f is deprecated because it is no longer maintained.
0.4.0.229-dev-ec7ddfd 1,027 3/5/2019 0.4.0.229-dev-ec7ddfd is deprecated because it is no longer maintained.
0.4.0.207-dev-b275ae2 1,053 3/4/2019 0.4.0.207-dev-b275ae2 is deprecated because it is no longer maintained.
0.4.0.205-dev-d8d9dd8 1,019 3/4/2019 0.4.0.205-dev-d8d9dd8 is deprecated because it is no longer maintained.
0.4.0.201-dev-ca5478d 1,048 2/27/2019 0.4.0.201-dev-ca5478d is deprecated because it is no longer maintained.
0.4.0.173-dev-b926e79 1,001 2/23/2019 0.4.0.173-dev-b926e79 is deprecated because it is no longer maintained.
0.4.0 1,230 2/15/2019 0.4.0 is deprecated because it is no longer maintained.
0.3.3.903-master 1,095 1/30/2019 0.3.3.903-master is deprecated because it is no longer maintained.
0.3.3.890-master 1,156 1/14/2019 0.3.3.890-master is deprecated because it is no longer maintained.
0.3.3.134-master-8df5e8e 1,129 2/15/2019 0.3.3.134-master-8df5e8e is deprecated because it is no longer maintained.
0.3.3.133-master-1f76aee 1,123 2/15/2019 0.3.3.133-master-1f76aee is deprecated because it is no longer maintained.
0.3.3.132-dev-8df5e8e 1,063 2/15/2019 0.3.3.132-dev-8df5e8e is deprecated because it is no longer maintained.
0.3.3.130-dev-1f76aee 1,113 2/15/2019 0.3.3.130-dev-1f76aee is deprecated because it is no longer maintained.
0.3.3.128-dev-d238a76 1,129 2/14/2019 0.3.3.128-dev-d238a76 is deprecated because it is no longer maintained.
0.3.3 1,262 1/14/2019 0.3.3 is deprecated because it is no longer maintained.
0.3.3-dev-ea11cd7 1,086 2/14/2019 0.3.3-dev-ea11cd7 is deprecated because it is no longer maintained.
0.3.3-dev-a1e94ac 1,124 2/14/2019 0.3.3-dev-a1e94ac is deprecated because it is no longer maintained.
0.3.3-dev-9350e38 1,066 2/14/2019 0.3.3-dev-9350e38 is deprecated because it is no longer maintained.
0.3.3-dev-54ee365 1,045 2/14/2019 0.3.3-dev-54ee365 is deprecated because it is no longer maintained.
0.3.3-dev-2da6a05 1,085 2/14/2019 0.3.3-dev-2da6a05 is deprecated because it is no longer maintained.
0.3.2.874-master 1,133 11/24/2018 0.3.2.874-master is deprecated because it is no longer maintained.
0.3.2 1,310 11/24/2018 0.3.2 is deprecated because it is no longer maintained.
0.3.1.869-master 1,225 11/9/2018 0.3.1.869-master is deprecated because it is no longer maintained.
0.3.1 1,304 11/9/2018 0.3.1 is deprecated because it is no longer maintained.
0.3.0.864-master 1,177 11/4/2018 0.3.0.864-master is deprecated because it is no longer maintained.
0.3.0.861-master 1,158 11/4/2018 0.3.0.861-master is deprecated because it is no longer maintained.
0.3.0 1,408 11/4/2018 0.3.0 is deprecated because it is no longer maintained.
0.2.3.858-master 1,222 11/4/2018 0.2.3.858-master is deprecated because it is no longer maintained.
0.2.3.853-master 1,151 11/3/2018 0.2.3.853-master is deprecated because it is no longer maintained.
0.2.3.849-master 1,158 11/2/2018 0.2.3.849-master is deprecated because it is no longer maintained.
0.2.3.848-master 1,162 11/2/2018 0.2.3.848-master is deprecated because it is no longer maintained.
0.2.3.844-master 1,168 11/2/2018 0.2.3.844-master is deprecated because it is no longer maintained.
0.2.3.842-master 1,180 10/29/2018 0.2.3.842-master is deprecated because it is no longer maintained.
0.2.3.840-master 1,130 10/25/2018 0.2.3.840-master is deprecated because it is no longer maintained.
0.2.3.833-master 1,158 10/21/2018 0.2.3.833-master is deprecated because it is no longer maintained.
0.2.3.823-master 1,178 10/19/2018 0.2.3.823-master is deprecated because it is no longer maintained.
0.2.3.812-master 1,175 10/13/2018 0.2.3.812-master is deprecated because it is no longer maintained.
0.2.3.803-master 1,177 9/30/2018 0.2.3.803-master is deprecated because it is no longer maintained.
0.2.3.801-master 1,137 9/24/2018 0.2.3.801-master is deprecated because it is no longer maintained.
0.2.3.799-master 1,213 9/23/2018 0.2.3.799-master is deprecated because it is no longer maintained.