yyoung01/nazurin repository overview

⁠Nazurin

Documentation⁠ | 中文文档⁠

小さな小さな賢将, a Telegram bot that helps you collect ACG illustrations from various sites.

⁠Architecture

⁠Features

• View/Download artwork from various sites⁠
• Add images to your collection via Telegram
• Store your collection in Telegram channels
• Store images on multiple types⁠ of storage
• Store image metadata in multiple types⁠ of database

⁠Supported Sites

⁠Supported Databases

You can also implement your own database driver by creating a file under database folder, and set this option to the name of driver class.

⁠Supported Storage

⁠Configuration

For more information, see Documentation⁠.

⁠Deploy

⁠Manual

1. Install uv⁠
2. Create virtual environment and install dependencies: uv sync
3. Set the required environment variables or place them in .env file, you may refer to .env.example as an example
4. Start the bot: uv run nazurin or python -m nazurin

⁠Docker

1. Configure the options in .env
2. Run docker-compose up -d to use the lastet pre-built Docker images. (Alternatively, you may build the image yourself: docker-compose up -d --build)

⁠Usage

Commands:

• /ping - pong
• /pixiv <id> - view pixiv artwork
• /pixiv_download <id> - download pixiv artwork
• /danbooru <id> - view danbooru post
• /danbooru_download <id> - download danbooru post
• /yandere <id> - view yandere post
• /yandere_download <id> - download yandere post
• /konachan <id> - view konachan post
• /konachan_download <id> - download konachan post
• /zerochan <id> - view zerochan post
• /zerochan_download <id> - download zerochan post
• /bookmark <id> - bookmark pixiv artwork
• /clear_cache - clear download cache
• /help - get help text

⁠How to update your collection

Send the bot a message with a link of supported sites⁠, this message will be forwarded to GALLERY channel, the bot will then download the original images from the site, send the files to ALBUM channel, and finally store to your custom destinations.