https://github.com/wisecirno/neko-chan-telegram-bot
A self-hosted Telegram bot designed for acg lovers
https://github.com/wisecirno/neko-chan-telegram-bot
chatbot chatgpt docker-compose docker-image komga picimagesearch telegram-bot telegram-userbot telegraph
Last synced: about 1 month ago
JSON representation
A self-hosted Telegram bot designed for acg lovers
- Host: GitHub
- URL: https://github.com/wisecirno/neko-chan-telegram-bot
- Owner: wiseCirno
- License: gpl-3.0
- Created: 2023-09-24T12:57:13.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T17:03:46.000Z (about 1 year ago)
- Last Synced: 2025-06-03T22:27:01.533Z (about 1 year ago)
- Topics: chatbot, chatgpt, docker-compose, docker-image, komga, picimagesearch, telegram-bot, telegram-userbot, telegraph
- Language: Python
- Homepage:
- Size: 8.69 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🐱 neko-chan-telegram-bot
[](https://github.com/wiseCirno/neko-chan-telegram-bot/actions/workflows/docker-image.yml)
neko is a self-hosted Telegram bot designed for acg lovers.
## 💡 Features
📺 Anime search
💬 In-APP ChatGPT
😊 Get sticker & 🐉 "Long Sticker"
🖼️ Image reverse search
📖 Pack Telegraph to Epub
💾 Sync manga from Telegraph
## 🔧 Docker Deployment
### Get Image
You can pull the image from **darinirvana/neko-chan:latest** or manually build it
from [Dockerfile](https://github.com/Ziang-Liu/Neko-Chan/blob/master/Dockerfile).
### Environment Variables:
| Variable | Description | Default |
|----------------------|-------------------------------------------------------|---------------|
| BOT_TOKEN | (Required) You can not leave this | `None` |
| MY_USED_ID | (Optional) Used for Telegraph sync service | `-1` |
| CHAT_ANYWHERE_KEY | (Optional) You can use your personal key | `None` |
| CHAT_ANYWHERE_MODEL | (Optional) Choose the custom model | `gpt-4o-mini` |
| CHAT_ANYWHERE_PROMPT | (Optional) Customized for different purposes | `TL;DR` |
| CF_WORKER_PROXY | (Optional) CloudFlare Workers proxy | `None` |
| PROXY | (Optional) For special network environment use | `None` |
| TELEGRAPH_THREADS | (Optional) Set this value too high is not recommended | `2` |
### Additional Information
Mount `/path/to/your/localhost` to `/neko`.
## Bot Config
Below is a set of sample commands that can be added to your personal bot:
``` txt
hug - 抱抱 Neko！
cuddle - 轻轻搂住 Neko
pet - 摸摸 Neko 的头
kiss - 亲亲 Neko 的脸颊
snog - 抱住 Neko 猛亲
anime - 通过一瞬截图搜索动漫
komga - 启用漫画下载服务
chat - 和 Neko 交流！
bye - 关闭 chat
help - Neko 的使用方法
```
## Acknowledgements
Epub generation based on [ebooklib](https://github.com/aerkalov/ebooklib)
Image search based on [PicImageSearch](https://github.com/kitUIN/PicImageSearch)
Anime search based on [trace.moe](https://soruly.github.io/trace.moe-api/#/) API
Integrated ChatGPT based on [ChatAnywhere](https://chatanywhere.apifox.cn/) v1 API
CloudFlare Workers proxy support based on [Cloudflare-Workers-Proxy](https://github.com/ymyuuu/Cloudflare-Workers-Proxy)
Self manga host using [Komga](https://github.com/gotson/komga)