Skip to content

Commit

Permalink
feat: Add ButtplugUnity directory
Browse files Browse the repository at this point in the history
When CI builds, it should copy DLLs for the core and websocket client
into Runtime, zip the directory, and keep it as an artifact.
  • Loading branch information
qdot committed Jun 17, 2020
1 parent 072bec2 commit 779f810
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 0 deletions.
1 change: 1 addition & 0 deletions ButtplugUnity/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.meta
27 changes: 27 additions & 0 deletions ButtplugUnity/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Copyright (c) 2020, Nonpolynomial Labs, LLC
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of buttplug nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 changes: 26 additions & 0 deletions ButtplugUnity/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Buttplug Unity

Unity Package for Buttplug support in Unity 2019.1+.

Only the following classes should be used:

- ButtplugClient
- ButtplugWebsocketConnector

Trying to use an embedded connector will fail as no
DeviceSubtypeManagers are distributed with this package (UWP doesn't
play well with Unity, so you wouldn't get Bluetooth anyways). It is
expected that anything built with this will either connect to
[Intiface Desktop](https://github.com/intiface/intiface-desktop) or
[Intiface CLI](https://github.com/intiface/intiface-cli-csharp).

Future releases will contain the Intiface CLI executable and will work
as a standalone.

## Installation

- [Download latest zip from releases section](https://github.com/buttplugio/buttplug-unity/releases)
- Unzip somewhere
- In Unity Project Frame, right click "Assets" > "Import Package" > "Custom Package"
- Choose package.json from buttplug-unity.
- Start using Buttplug classes in your scripts
1 change: 1 addition & 0 deletions ButtplugUnity/Runtime/.keep
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Null file to make sure directory stays in git
7 changes: 7 additions & 0 deletions ButtplugUnity/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "com.nonpolynomial.buttplug-unity",
"version": "0.5.8",
"displayName": "Buttplug Unity",
"description": "Buttplug for Unity",
"unity": "2019.1"
}

0 comments on commit 779f810

Please sign in to comment.