Buttplug sex toy control library
buttplug.io
1# Intiface Engine
2
3[](https://www.patreon.com/qdot)
4[](https://www.github.com/sponsors/qdot)
5[](https://discuss.buttplug.io)
6[](https://discord.buttplug.io)
7[](https://twitter.com/buttplugio)
8[](https://bsky.app/profile/buttplug.io)
9
10CLI and Library frontend for Buttplug
11
12Intiface Engine is just a front-end for [Buttplug](https://github.com/buttplugio/buttplug),
13but since we're trying to not make people install a program named "Buttplug", here we are.
14
15While this program can be used standalone, it will mostly be featured as a backend/engine for
16[Intiface Central](https://intiface.com/central).
17
18## Running
19
20Command line options are as follows:
21
22| Option | Description |
23| --------- | --------- |
24| `version` | Print version and exit |
25| `server-version` | Print version and exit (kept for legacy reasons) |
26| `websocket-use-all-interfaces` | Websocket servers will listen on all interfaces (versus only on localhost, which is default) |
27| `websocket-port [port]` | Network port for connecting via non-ssl (ws://) protocols |
28| `frontend-websocket-port` | IPC JSON port for Intiface Central |
29| `server-name` | Identifying name server should emit when asked for info |
30| `device-config-file [file]` | Device configuration file to load (if omitted, uses internal) |
31| `user-device-config-file [file]` | User device configuration file to load (if omitted, none used) |
32| `max-ping-time [number]` | Milliseconds for ping time limit of server (if omitted, set to 0) |
33| `log` | Level of logs to output by default (if omitted, set to None) |
34| `allow-raw` | Allow clients to communicate using raw messages (DANGEROUS, CAN BRICK SOME DEVICES) |
35| `use-bluetooth-le` | Use the Bluetooth LE Buttplug Device Communication Manager |
36| `use-serial` | Use the Serial Port Buttplug Device Communication Manager |
37| `use-hid` | Use the HID Buttplug Device Communication Manager |
38| `use-lovense-dongle` | Use the HID Lovense Dongle Buttplug Device Communication Manager |
39| `use-xinput` | Use the XInput Buttplug Device Communication Manager |
40| `use-lovense-connect` | Use the Lovense Connect Buttplug Device Communication Manager |
41| `use-device-websocket-server` | Use the Device Websocket Server Buttplug Device Communication Manager |
42| `device-websocket-server-port` | Port for the device websocket server |
43
44For example, to run the server on websockets at port 12345 with bluetooth device support:
45
46`intiface-engine --websocket-port 12345 --use-bluetooth-le`
47
48## Compiling
49
50Linux will have extra compilation dependency requirements via
51[buttplug](https://github.com/buttplugio/buttplug). For pacakges required,
52please check there.
53
54## Filing Issues and Contributing
55
56[See top level README for more info.](https://github.com/buttplugio/buttplug)
57
58## License and Trademarks
59
60Intiface is a Registered Trademark of Nonpolynomial Labs, LLC
61
62Buttplug and Intiface are BSD licensed.
63
64 Copyright (c) 2016-2025, Nonpolynomial Labs, LLC
65 All rights reserved.
66
67 Redistribution and use in source and binary forms, with or without
68 modification, are permitted provided that the following conditions are met:
69
70 * Redistributions of source code must retain the above copyright notice, this
71 list of conditions and the following disclaimer.
72
73 * Redistributions in binary form must reproduce the above copyright notice,
74 this list of conditions and the following disclaimer in the documentation
75 and/or other materials provided with the distribution.
76
77 * Neither the name of buttplug nor the names of its
78 contributors may be used to endorse or promote products derived from
79 this software without specific prior written permission.
80
81 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
82 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
83 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
84 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
85 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
86 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
87 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
88 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
89 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
90 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.