Skip to content

Commit f40864c

Browse files
committed
feat(dockerignore, readme): added dockerignore and readme updated
1 parent 0707564 commit f40864c

3 files changed

Lines changed: 84 additions & 6 deletions

File tree

.dockerignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Dockerfile
2+
readme.md
3+
.github
4+
.gitignore

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Fast Sticker Bot
2+
3+
A Telegram bot for creating and managing sticker packs much faster than other bots.
4+
5+
Running instance: [@faststicker_bot](https://t.me/faststicker_bot)
6+
7+
## Features
8+
9+
- **Create sticker packs**`/new_pack`
10+
- **Add stickers** to existing packs — `/add_sticker`
11+
- **Delete sticker packs**`/del_pack`
12+
- **List your packs**`/my_packs`
13+
14+
Supported sticker types:
15+
- **Static** — images, photos, stickers
16+
- **Video** — animations, GIFs, MP4 (auto-converted to WEBM via ffmpeg)
17+
- **Animated (TGS)** — Telegram animated sticker format
18+
19+
Images are automatically resized to 512×512 while preserving aspect ratio.
20+
21+
## Commands
22+
23+
| Command | Description |
24+
|---------|-------------|
25+
| `/start` | Welcome message |
26+
| `/help` | List of commands |
27+
| `/about` | Bot info |
28+
| `/new_pack` | Create a new sticker pack |
29+
| `/add_sticker` | Add stickers to an existing pack |
30+
| `/del_pack` | Delete a sticker pack |
31+
| `/my_packs` | List your sticker packs |
32+
| `/cancel` | Cancel current operation |
33+
| `/copy_emoji` | Toggle auto-copying emoji from existing stickers |
34+
35+
## Running
36+
37+
### Docker (recommended)
38+
39+
```bash
40+
git clone <repo-url>
41+
cd faststickerbot
42+
echo "BOT_TOKEN=your_token_here" > .env
43+
docker compose up -d
44+
```
45+
46+
### Manual
47+
48+
```bash
49+
pip install -r requirements.txt
50+
# ffmpeg is required
51+
echo "BOT_TOKEN=your_token_here" > .env
52+
python main.py
53+
```
54+
55+
## Environment Variables
56+
57+
| Variable | Required | Description |
58+
|----------|----------|-------------|
59+
| `BOT_TOKEN` | Yes | Telegram Bot API token from @BotFather |
60+
61+
## Stack
62+
63+
- Python 3.14
64+
- aiogram 3.27
65+
- SQLite (aiosqlite)
66+
- Pillow (image processing)
67+
- ffmpeg (video conversion)
68+
69+
## File structure
70+
71+
```
72+
cogs/ # Command handlers
73+
utils/ # Core logic
74+
stores/ # Config, states, types
75+
integrations/ # Database, video conversion
76+
service.py # Bot class
77+
cog.py # Cog framework
78+
shortcuts.py # Utilities
79+
main.py # Entry point
80+
```

readme.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)