Skip to content
This repository has been archived by the owner on Apr 15, 2021. It is now read-only.

intiface/intiface-cli-node

Repository files navigation

DEPRECATED AND ARCHIVED

This project has been superceded by intiface-cli-rs and will no longer be updated.

Buttplug Node.js Websocket Server

Build Status

Patreon donate button Discourse Forum Discord Twitter

Native server frontend for Buttplug. Currently supports connections via:

  • Websocket

With the following Subtype Managers:

  • BluetoothLE

On the following platforms:

  • MacOS (> 10.10)
  • Linux (built on Ubuntu 16.04, needs Bluez >= 5.24)

Table Of Contents

Support The Project

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

Installation

yarn build

To run the server after it is built, run the following command:

yarn start

Running Without Root or Sudo on Linux

To connect to bluetooth without having to use sudo or root on Linux, run the following command:

sudo setcap cap_net_raw+eip $(eval readlink -f `which node`)

This grants the node binary cap_net_raw privileges, so it can start/stop BLE advertising.

Note: The above command requires setcap to be installed, it can be installed using the following:

  • apt: sudo apt-get install libcap2-bin
  • yum: su -c \'yum install libcap2-bin\'

License

buttplug-js is BSD 3-Clause licensed.

Copyright (c) 2017-2019, 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 the project 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.