https://github.com/douxxtech/circles-ws
An interactive WebSocket-based visualization that connects multiple clients with animated circles.
https://github.com/douxxtech/circles-ws
circles development web websocket
Last synced: 11 months ago
JSON representation
An interactive WebSocket-based visualization that connects multiple clients with animated circles.
- Host: GitHub
- URL: https://github.com/douxxtech/circles-ws
- Owner: douxxtech
- License: other
- Created: 2025-06-11T21:14:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-11T21:14:52.000Z (about 1 year ago)
- Last Synced: 2025-07-13T01:34:53.865Z (11 months ago)
- Topics: circles, development, web, websocket
- Language: HTML
- Homepage: https://npmjs.org/package/circles-ws
- Size: 820 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Circles-WS
An interactive WebSocket-based visualization that connects multiple clients with animated circles.
## Installation
Install the package globally:
```bash
npm install -g circles-ws
```
## Usage
Run the server:
```bash
circles-ws [options]
```
### Options
- `--port`: Specify the port to run the server on (default: 8080)
- `--tick`: Specify the tick rate in milliseconds (default: 16)
### Controls
Once the server is running, you can use these keyboard controls:
- `o`: Open browser (create circle)
- `c`: Count connected clients
- `l`: Kick all clients
- `h`: Show help
- `q`: Quit the server
## Development
1. Clone the repository
2. Install dependencies: `npm install`
3. Run the server: `npm start`
## License
[NSDv1.0](LICENSE)
