https://github.com/ruriys/hiurachat
A bot framework for chat.hiura.site
https://github.com/ruriys/hiurachat
bot golang
Last synced: about 1 year ago
JSON representation
A bot framework for chat.hiura.site
- Host: GitHub
- URL: https://github.com/ruriys/hiurachat
- Owner: RuriYS
- License: agpl-3.0
- Created: 2024-10-26T13:49:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-04T08:23:06.000Z (over 1 year ago)
- Last Synced: 2025-02-09T09:29:22.383Z (over 1 year ago)
- Topics: bot, golang
- Language: Go
- Homepage:
- Size: 85 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HiuraChat 🗣️
A **cool** **robust** chat bot and framework written in **Go** ✨.
## What's This?
HiuraChat is a WebSocket-based chat bot that's built to be reliable and nice to work with. It's got some neat features like:
- 🔄 Auto-reconnection with smart backoff
- 🚦 Built-in rate limiting to play nice with servers
- 💬 Easy command handling
- 🏓 Ping/pong heartbeat system
- 📝 Clean logging system
## Installation
### Using Pre-built Binary
1. Head over to the [Actions](https://github.com/RuriYS/HiuraChat/actions) or [Releases](https://github.com/RuriYS/HiuraChat/releases) page
2. Download the latest artifact or binary for your platform
3. If you downloaded the artifact, extract it
4. Make it executable (Linux):
```bash
chmod +x hiurachat
```
### Using Docker
Clone and run using Docker Compose:
```bash
git clone https://github.com/RuriYS/HiuraChat
cd HiuraChat
docker compose build
docker compose up -d
```
### Building from Source
1. First, make sure you've got Go 1.23+ installed
2. Clone this repo:
```bash
git clone github.com/RuriYS/hiurachat
cd hiurachat
```
3. Build it:
```bash
go build
```
## Configuration
Create a `config.yml` file:
```yaml
bot:
prefix: "!" # Command prefix
response_prefix: ">" # How the bot starts its responses
websocket:
url: "ws://your-chat-server/ws"
logger:
level: "info" # debug, info, warn, or error
use_colors: true # Pretty colors in console
```
If you're using Docker, mount your config file as shown in the docker-compose.yml:
```yaml
volumes:
- ./config.yml:/root/config.yml
- ./logs:/root/logs
```
## Running
### Binary
```bash
./hiurachat
```
### Source
```bash
go run main.go
```
### Docker
```bash
docker compose up -d
```
## Built-in Commands
- `!ping` - Check if the bot is alive (and see the latency!)
- `!echo ` - Have the bot repeat something
- `!help ` - Get info about commands
## Adding Your Own Commands
It's pretty easy to add new commands! Check out `internal/bot/commands.go` - just add your command to the `initializeCommands` function:
```go
"yourcommand": {
Name: "yourcommand",
Description: "Does something cool",
Execute: func(args []string) (string, bool) {
return "> Something cool happened!", true
},
},
```
## License
This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
---
Built with ❤️ and probably too much coffee ☕