Relay a hack.chat channel to a HiveMind hub — a HiveMind satellite whose input and output are a hack.chat channel
Project description
HiveMind HackChat Bridge
Relay a hack.chat channel to a HiveMind hub.
hack.chat is a minimal, anonymous, channel-based websocket chat. This bridge is a HiveMind satellite whose input and output are a hack.chat channel instead of a microphone. Channel messages become utterances sent to the hub; the hub's spoken reply is posted back into the channel, addressed to the user. Any HiveMind hub (and the OVOS skills behind it) becomes a hack.chat bot.
hack.chat channel ⇄ HiveMind-HackChatBridge ⇄ HiveMind hub ⇄ OVOS skills
Prerequisites
- A running HiveMind hub (hivemind-core) reachable over the network, and a HiveMind access key for this bridge (
hivemind-core add-client). - A hack.chat channel name to join, and a nickname for the bot. hack.chat is anonymous — no account or token is required.
Install
pip install HiveMind-HackChatBridge
Or from a checkout:
git clone https://github.com/JarbasHiveMind/HiveMind-HackChatBridge
cd HiveMind-HackChatBridge
pip install .
Declared dependencies: hivemind-bus-client, ovos-bus-client, ovos-utils, websocket-client, click.
Quickstart
1. Register the bridge on the hub (where hivemind-core is installed):
hivemind-core add-client --name hackchat-bridge \
--access-key "your-access-key" --password "your-password"
2. Run the bridge. Configuration is passed on the command line via the hivemind-hackchat-bridge console script (or python -m hackchat_bridge):
hivemind-hackchat-bridge \
--channel your_channel \
--username Jarbas_BOT \
--access-key "your-access-key" \
--password "your-password" \
--host ws://127.0.0.1 \
--port 5678
4. Send a message. Open the same channel at https://hack.chat/?your_channel and type:
what time is it?
The bridge forwards the message to the hub and posts the reply back as @user , <answer>.
Configuration
hivemind-hackchat-bridge options:
| Option | Description | Default |
|---|---|---|
--channel |
hack.chat channel name to join | — (required) |
--username |
Bot nickname shown in the channel | Jarbas_BOT |
--host |
HiveMind hub host (wss:// / ws://) |
ws://127.0.0.1 |
--port |
HiveMind hub port | 5678 |
--access-key |
HiveMind access key | None |
--password |
HiveMind password | None |
--self-signed |
Accept self-signed SSL certificates | off |
--lang |
Language code for utterances | en-us |
The bridge forwards every channel message except its own, stripping a leading @username mention of the bot before sending.
Troubleshooting
- Bot joins but never answers — confirm the hub is reachable and the access key/password are registered (
hivemind-core list-clients), and that the hub produces aspeakfor the answer. - Wrong channel — the bot and the user must be on the same hack.chat channel name; open
https://hack.chat/?<channel>.
Documentation
- Operator setup — hack.chat is anonymous (no account/token); registering the bridge on a HiveMind hub, the run command, and the network-only live e2e.
See also docs/ for a full setup walkthrough, a configuration reference, and worked examples.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hivemind_hackchatbridge-0.1.0a2.tar.gz.
File metadata
- Download URL: hivemind_hackchatbridge-0.1.0a2.tar.gz
- Upload date:
- Size: 10.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2e9d664210e19923fa3733e8ec22526881ca155d4340d0d3e52ff13f14e15f13
|
|
| MD5 |
3379c76b39164279aea76649d26f6923
|
|
| BLAKE2b-256 |
fd86189ca54c0fde0bab830cc7e617e65b3ec3d3b40a3d4258b2c8186d03ddc4
|
File details
Details for the file hivemind_hackchatbridge-0.1.0a2-py3-none-any.whl.
File metadata
- Download URL: hivemind_hackchatbridge-0.1.0a2-py3-none-any.whl
- Upload date:
- Size: 11.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6eb16aa543424d8561453025f6392075bae3f23c9a922059d903ee47607c5d2c
|
|
| MD5 |
432db9c977255d085c44b2386fafd1bc
|
|
| BLAKE2b-256 |
4992a63d74b4ac714a8b46ff2340b275a4a3e78068db65fcdbedab21596330b8
|