71 lines
1.8 KiB
Markdown
71 lines
1.8 KiB
Markdown
[](https://www.npmjs.com/package/@stevanfreeborn/streamplace-term-chat)
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
# Streamplace Chat Client
|
|
|
|
A lightweight, terminal-based live chat client for Streamplace powered by AT Protocol OAuth and Bluesky Jetstream.
|
|
|
|
## Features
|
|
|
|
- Secure browser login flow with persistent session storage.
|
|
- Subscribes to live `place.stream.chat.message` events.
|
|
- Efficient handle/DID resolution to minimize network overhead.
|
|
- Auto-reconnecting WebSocket for uninterrupted stream chat.
|
|
|
|
## Quick Start
|
|
|
|
Run directly using `npx`:
|
|
|
|
```bash
|
|
# Connect to your own stream chat room
|
|
npx @stevanfreeborn/streamplace-term-chat your-handle.bsky.social
|
|
|
|
# Connect to another streamer's chat room
|
|
npx @stevanfreeborn/streamplace-term-chat your-handle.bsky.social --streamer streamer-handle.bsky.social
|
|
```
|
|
|
|
## Global Installation
|
|
|
|
Install globally via npm to use the streamplace-term-chat anywhere on your system:
|
|
|
|
```sh
|
|
npm install -g @stevanfreeborn/streamplace-term-chat
|
|
```
|
|
|
|
## From Source
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js (v20+ recommended)
|
|
- npm
|
|
|
|
### Quick Start
|
|
|
|
Clone the repository and install dependencies:
|
|
|
|
```bash
|
|
git clone https://github.com/StevanFreeborn/stream.place-chat-client.git
|
|
cd stream.place-chat-client
|
|
npm install
|
|
```
|
|
|
|
Start the chat client:
|
|
|
|
```bash
|
|
# Connect to your own stream chat
|
|
npm run dev -- <your-handle.bsky.social>
|
|
|
|
# Connect to a target streamer's chat room
|
|
npm run dev -- <your-handle.bsky.social> --streamer <streamer.bsky.social>
|
|
```
|
|
|
|
Chat commands:
|
|
|
|
- Type your message and hit `Enter` to post.
|
|
- `/help`: Show available in-chat commands.
|
|
- `/quit` or `/exit`: Gracefully disconnect and exit.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE.md)
|