Documentation | 中文文档

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

• 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

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.

For more information, see Documentation.

For more deploy options, checkout Documentation.

Tips: You may comment out unused dependencies in requirements.txt before installation.

1. Install dependencies: pip install -r requirements.txt
2. Set the required environment variables or place them in .env file, you may refer to .env.example as an example
3. Start the bot: python -m nazurin

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)

Use /help command to get a list of available commands or help for a specific command, use /set_commands to set bot commands in command menu.

Some system commands are listed below:

• /clear_cache — Clear cache
• /help [COMMAND] — Get help of all commands or a specific command
• /ping — Pong
• /set_commands — Set commands
• /start — Get help

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.

Tips: On mobile you can use the share button in apps, as long as the final message contains a link.