Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LolipopJ/telly-bot
A Telegram bot based on Bun.
https://github.com/LolipopJ/telly-bot
alist bun chatgpt github-issues mongodb pixiv telegram-bot
Last synced: about 1 month ago
JSON representation
A Telegram bot based on Bun.
- Host: GitHub
- URL: https://github.com/LolipopJ/telly-bot
- Owner: LolipopJ
- License: mit
- Created: 2022-01-07T05:24:30.000Z (almost 3 years ago)
- Default Branch: bun
- Last Pushed: 2024-08-18T06:35:34.000Z (4 months ago)
- Last Synced: 2024-08-18T07:37:39.039Z (4 months ago)
- Topics: alist, bun, chatgpt, github-issues, mongodb, pixiv, telegram-bot
- Language: TypeScript
- Homepage: https://t.me/lolipop_mini_bot
- Size: 1.01 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - LolipopJ/telly-bot - A Telegram bot based on Bun. (TypeScript)
README
# telly-bot
## Start service
This project based on [Bun](https://bun.sh), which needs to be installed globally:
```bash
npm install -g bun
```
To install dependencies:
```bash
bun install
```
To start bot service:
```bash
bun run server
```
## Start service with Docker
Build Docker image:
```bash
docker build --pull -t telly-bot:latest .
```
Use the image to spin up a container:
```bash
docker run -d -p 3300:3300 --name telly-bot telly-bot:latest
```
## Configurations
Create `.env` in root directory to hold environment variables.
### Required
**Required** environment variables:
```bash
# Telegram bot token
TELEGRAM_BOT_TOKEN=XXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXX
```
### Common
Optional common environment variables:
```bash
# Listening port of service. Default to `3300`
PORT=3300
# Secret token to execute private (POST) API
API_SECRET_TOKEN=YOUR_SECRET_TOKEN
# Telegram chat that receives monitoring messages and so on. The chat between bot and yourself is recommended
TELEGRAM_CHAT_ID_ADMIN=TARGET_CHAT_ID
```
### Database / MongoDB
Telly bot chooses MongoDB as the provider of database service. Some features require connecting to MongoDB.
```bash
# MongoDB uri
MONGO_URI=mongodb://username:[email protected]:27017/telly-bot
```
Don't worry, Telly bot can work without MongoDB.
### AList
```bash
# AList address
ALIST_URL=http://127.0.0.1:5244
# AList login username
ALIST_USERNAME=YOUR_ALIST_USERNAME
# AList login password
ALIST_PASSWORD=YOUR_ALIST_PASSWORD
# Custom service routes
ALIST_ROUTES=[{"route":"/random-img","path":"/path/to/img-dir","type":"random-image"}]
```
When visit `http://127.0.0.1:3300/alist/random-img` or send `/random_img` to bot, you will get a random image from the `/path/to/img-dir` directory in AList.
Notes: If directory `/path/to/img-dir` has too many files, the first request in a certain time interval may failed. This is due to AList's file cache mechanism (default to 30 minutes, can be configured on the AList management page), please wait a few seconds and try again.
### ChatGPT
Adapt to [ChatAnywhere](https://github.com/chatanywhere/GPT_API_free).
```bash
# ChatGPT model version. Default to `gpt-3.5-turbo-0125`
CHATGPT_MODEL=gpt-3.5-turbo-0125
# ChatAnywhere API key
CHATGPT_API_KEY=YOUR_CHATGPT_API_KEY
# Telegram chat that receives key usage
TELEGRAM_CHAT_ID_CHATGPT_BALANCE=TARGET_CHAT_ID
```
Send `/chat ${message}` to play with a cat girl! You can also:
- `/chat_cat_girl ${message}`: Same to `/chat ${message}`.
- `/chat_dan ${message}`: Chat with an unlimited AI agent named Dan.
- `/chat_poet ${message}`: Talk with a poet who writes impressive words.
Visit `http://127.0.0.1:3300/chatgpt/balance` to view key usage. If `TELEGRAM_CHAT_ID_CHATGPT_BALANCE` (higher priority) or `TELEGRAM_CHAT_ID_ADMIN` is set, key usage will also be forwarded to target chat every 9 AM and 9 PM.
### Github
```bash
GITHUB_PERSONAL_ACCESS_TOKEN=YOUR_GITHUB_PERSONAL_ACCESS_TOKEN
```
### Minecraft
Based on [Minecraft Server Status](https://mcstatus.io/).
```bash
MINECRAFT_SERVER_HOST=example.domain.com
TELEGRAM_CHAT_ID_MINECRAFT_MONITOR=TARGET_CHAT_ID
```
## API
### Telegram bot API
#### Query bot status
```ts
axios.get("http://127.0.0.1:3300/bot/status");
```
#### Send custom message
Send custom message to target chat. Content should be parsable by HTML mode: .
```ts
axios.post(
"http://127.0.0.1:3300/bot/send-message",
{
content: "custom message",
chatId: TELEGRAM_CHAT_ID_ADMIN,
},
{
headers: { Authorization: API_SECRET_TOKEN },
},
);
```
If `chatId` is blank, `TELEGRAM_CHAT_ID_ADMIN` will be used.
### ChatGPT API
#### Query CA key usage
```ts
axios.get("http://127.0.0.1:3300/chatgpt/balance");
```
#### Chat with a cat girl
```ts
axios.post(
"http://127.0.0.1:3300/chatgpt/chat",
{
content: "custom message",
},
{
headers: { Authorization: API_SECRET_TOKEN },
},
);
```
## Development
To develop:
```bash
bun run start
```
To lint files and fix code syntax:
```bash
# Require a Node.js >=20.11.0 to get typing check
bun run lint
# Auto fix
bun run lint:fix
```