Skip to content

wiseCirno/neko-chan-telegram-bot

Repository files navigation

banner.png

🐱 neko-chan-telegram-bot

Docker Image CI

neko is a self-hosted Telegram bot designed for acg lovers.

💡 Features

Anime Search

📺 Anime search

Chat Anywhere

💬 In-APP ChatGPT

Stickers

😊 Get sticker & 🐉 "Long Sticker"

Image Reverse Search

🖼️ Image reverse search

Upload EPUB

📖 Pack Telegraph to Epub

Sync Komga

💾 Sync manga from Telegraph

🔧 Docker Deployment

Get Image

You can pull the image from darinirvana/neko-chan:latest or manually build it from 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:

hug - 抱抱 Neko!  
cuddle - 轻轻搂住 Neko
pet - 摸摸 Neko 的头
kiss - 亲亲 Neko 的脸颊  
snog - 抱住 Neko 猛亲 
anime - 通过一瞬截图搜索动漫
komga - 启用漫画下载服务  
chat - 和 Neko 交流! 
bye - 关闭 chat
help - Neko 的使用方法  

Acknowledgements

Epub generation based on ebooklib

Image search based on PicImageSearch

Anime search based on trace.moe API

Integrated ChatGPT based on ChatAnywhere v1 API

CloudFlare Workers proxy support based on Cloudflare-Workers-Proxy

Self manga host using Komga