Skip to content

Ziang-Liu/neko-chan-telegram-bot

Repository files navigation

Neko-Chan

Neko is a self-hosted Telegram bot designed with many useful functions c:, especially for acg lovers.

💡 Features List

Telegram Bot Features

  • Download stickers
  • Upload manga as EPUB from Telegraph
  • Image search using Ascii2d and Iqdb
  • Sync manga from Telegraph to server
  • ChatGPT assistant support
  • Anime timeline search by using stickers(GIF)
  • Dmzj manga update notifications
  • Convert manga from Dmzj links to Telegraph
  • Convert manga from EX, EH, NH links to Telegraph

Back-end

  • Host Docker images on Docker Hub (support for arm64 and amd64)
  • Organize manga from provided Telegraph links (support for Komga and Tachiyomi)
  • Convert to EPUB using ebooklib
  • Image search using PicImageSearch for Ascii2d and Iqdb search
  • Integrate trace.moe API
  • Integrate ChatAnywhere v1 API
  • HTTP(S) and socks5 proxies support
  • CloudFlare Workers proxy support based on Cloudflare-Workers-Proxy
  • Fully integrate Dmzj v3 and v4 APIs
  • Fetch manga from EX, EH, NH sources

🔧 Docker Deployment

Get Image

You can pull the image from darinirvana/neko-chan:latest or manually build it from the Dockerfile.

Environment Variables:

Variable Description Default
BOT_TOKEN Required None
MY_USED_ID Required if you need Telegraph sync service -1
CF_WORKER_PROXY CloudFlare Workers proxy None
PROXY Required if you can't connect to the API directly None
TELEGRAPH_THREADS Number of images downloaded in a single batch 4
CHAT_ANYWHERE_KEY For GPT use, optional None

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 - chu 一下 Neko 的脸颊  
snog - 抱住 Neko 猛亲  
komga - 启用漫画下载模式  
chat - GPT 交流模式  
bye - 关闭 chat
help - Neko Chan 的使用方法