Skip to content

Commit e155add

Browse files
committed
doc: Update CHANGELOG and README for v0.2 release
1 parent 660216b commit e155add

File tree

2 files changed

+73
-24
lines changed

2 files changed

+73
-24
lines changed

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
# 0.2.0 (2018-01-22)
2+
3+
## Features
4+
5+
- Added Hardware Support
6+
- Youcups Warrior II Masturbator
7+
- Erostek ET312B
8+
- Wevibe 4
9+
- OhMiBod/Kiiroo Fuse
10+
- Lovense Edge/Hush/Domi (new firmware versions)
11+
- Individual Vibrator support for Lovense Edge
12+
- Now uses v1 of the Buttplug Protocol spec, adds new generic messages, as well as feature counts for device messages
13+
- Supports message downgrading, meaning older clients can connect to newer servers
14+
- Newer clients cannot connect to older servers, though
15+
- Moved code to .Net Standard 2.0 compatibility
16+
- Moved testing to NUnit
17+
18+
## Bugfixes
19+
20+
- Game Router process select button disabled until process selected
21+
- Fix SynchronizationContext crash in client
22+
23+
# 0.1.3 (2017-12-07)
24+
25+
## Features
26+
27+
- Add ignore cert errors for client library
28+
- Handle message ID iteration in client library
29+
130
# 0.1.2 (2017-09-15)
231

332
## Bugfixes

README.md

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,44 +7,68 @@ hardware usually means sex toys, but could honestly be just about
77
anything. It's basically a userland HID manager for things that may
88
not specifically be HID.
99

10-
In more concrete terms, think of Buttplug as something like
11-
[osculator](http://www.osculator.net/) or [VRPN](http://vrpn.org), but
12-
for sex toys. Instead of wiimotes and control surfaces, we interface
13-
with vibrators, electrostim equipment, fucking machines, and other
14-
hardware that can communicate with computers.
10+
If you're looking for the installer for the Websocket Server, Game
11+
Vibration Router, or Kiiroo Emulator, [visit our releases page.](https://github.com/metafetish/buttplug-csharp/releases/)
1512

16-
The core of buttplug works as a router. It is an application that
17-
connects to driver libraries, to register and communicate with
18-
different hardware. Clients can then connect over different means
19-
(network, websockets, etc...), to interact with the hardware.
13+
## Table Of Contents
2014

21-
## Other Buttplug Implementations
15+
- [Support The Project](#support-the-project)
16+
- [Buttplug Spec and Documentation](#buttplug-spec-and-documentation)
17+
- [Hardware Support](#hardware-support)
18+
- [Installation](#installation)
19+
- [Development](#development)
20+
- [Special Installation Steps When Building Buttplug Applications](#special-installation-steps-when-building-buttplug-applications)
21+
- [Applications Using Buttplug-C#](#applications-using-buttplug-c)
22+
- [License]()
23+
24+
## Support The Project
25+
26+
If you find this project helpful, you
27+
can
28+
[support Metafetish projects via Patreon](http://patreon.com/qdot)!
29+
Every donation helps us afford more hardware to reverse, document, and
30+
write code for!
31+
32+
## Buttplug Spec and Documentation
2233

2334
Buttplug implementations are available in multiple languages (rust,
2435
javascript, etc)/frameworks/platforms. For a full
25-
list,
36+
list of documentation, libraries, and applications,
2637
[see the README in the main buttplug repo](http://github.com/metafetish/buttplug).
2738

28-
## Platform Support
39+
## Hardware Support
2940

3041
Buttplug C# Supports the following platforms:
3142

3243
- Windows 10 - Creators Update (15063)
33-
- BLE Devices: Fleshlight Launch, Lovense Toys, Vorze Interactive,
34-
Vibratissimo, Magic Motion
44+
- BLE Devices: Fleshlight Launch, Lovense Toys, Vorze Interactive
45+
A10 Cyclone SA, Vibratissimo Toys, Magic Motion Toys, WeVibe Toys,
46+
Youcups Warrior II
47+
- Serial Devices: ErosTek ET312B
3548
- Other devices: Xbox Gamepads (XInput)
3649

3750
- Windows 7/8 and 10 pre 15063
51+
- Serial Devices: ErosTek ET312B
3852
- Other devices: Xbox Gamepads (XInput)
3953

54+
## Installation
55+
56+
The Buttplug C# Repo hosts the Buttplug C# Development Libraries, as
57+
well as the following applications:
58+
59+
- Websocket Server
60+
- Game Vibration Router
61+
- Kiiroo Desktop Platform Emulator
62+
63+
To download the installer for these applications, [visit our releases page.](https://github.com/metafetish/buttplug-csharp/releases/)
64+
4065
## Development
4166

42-
Packages and libraries from the buttplug-csharp repo are available
43-
via [nuget](http://nuget.org). Simply run a search for "buttplug",
44-
or
67+
Packages and libraries from the buttplug-csharp repo are available via
68+
[nuget](http://nuget.org). Simply run a search for "buttplug", or
4569
[follow this link to the nuget "buttplug" search](https://www.nuget.org/packages?q=buttplug).
4670

47-
## Special Installation Steps
71+
### Special Installation Steps When Building Buttplug Applications
4872

4973
Due to a bug in the Windows 15063 SDK, applications using the BLE APIs
5074
need to have an AppId in the registry with a special SDDL access
@@ -58,13 +82,9 @@ then choose File > Import, and select the app.reg file in this repo.
5882
This will set permissions for all executables named Buttplug.exe,
5983
ButtplugCLI.exe, and ButtplugGUI.exe
6084

61-
## Support The Project
85+
## Applications Using Buttplug C#
6286

63-
If you find this project helpful, you
64-
can
65-
[support Metafetish projects via Patreon](http://patreon.com/qdot)!
66-
Every donation helps us afford more hardware to reverse, document, and
67-
write code for!
87+
- [ScriptPlayer](https://github.com/FredTungsten/ScriptPlayer) - Native hardware synced movie player for Windows.
6888

6989
## License
7090

0 commit comments

Comments
 (0)