From 7232a8d3047f233a1307a328868cd7bffb154880 Mon Sep 17 00:00:00 2001 From: vrubelroman Date: Thu, 13 Nov 2025 23:40:13 +0300 Subject: [PATCH] add about.md --- README.md | 16 ++++++-- about.md | 107 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+), 3 deletions(-) create mode 100644 about.md diff --git a/README.md b/README.md index c6aa972..cfd24f7 100644 --- a/README.md +++ b/README.md @@ -110,24 +110,30 @@ REST API для получения статистики игроков Lichess. ### 2. LichessClientTG_bot (Telegram бот) -Telegram бот для управления отслеживанием игроков. +Telegram бот для управления отслеживанием игроков Lichess. **Возможности:** -- Добавление игроков для отслеживания +- Добавление игроков для отслеживания (друзья, соперники, ученики) - Выбор активного игрока - Получение статистики (сегодня/вчера/неделя) +- Статистика по режимам (Bullet, Blitz, Rapid) +- Статистика решения задач (puzzles) - Настройка периодических уведомлений - Каждый пользователь имеет свой набор игроков **Команды:** - `/start` - начало работы с ботом -- `/adduser` - добавить игрока Lichess +- `/addgamer` - добавить игрока Lichess (только имя пользователя) +- `/addtoken` - добавить игрока с токеном (для статистики по задачам) - `/getgamers` - выбрать активного игрока +- `/delgamer` - удалить игрока из списка - `/today` - статистика за сегодня - `/yesterday` - статистика за вчера - `/week` - статистика за неделю - `/setperiod` - настроить уведомления +**Подробнее о боте:** см. [about.md](about.md) + ### 3. LichessWebView (Веб-интерфейс) Веб-интерфейс для просмотра пользователей и их игроков. @@ -232,6 +238,10 @@ MIT Roman Vrubel +## 📖 Дополнительная информация + +- **[О боте](about.md)** - подробное описание функций бота, для кого он предназначен и примеры использования + ## 🔗 Полезные ссылки - [Lichess API Documentation](https://lichess.org/api) diff --git a/about.md b/about.md new file mode 100644 index 0000000..0c0fee3 --- /dev/null +++ b/about.md @@ -0,0 +1,107 @@ +# 📊 Lichess Statistics Bot - О боте + +## 🎯 Что это? + +**Lichess Statistics Bot** — это Telegram-бот для автоматического отслеживания статистики игроков на платформе Lichess.org. Бот предоставляет детальную информацию о рейтингах, играх, задачах и активности игроков в режиме реального времени. + +## ✨ Основные функции + +### 📈 Статистика и аналитика +- **Статистика за сегодня** — мгновенный обзор активности за текущий день +- **Статистика за вчера** — анализ вчерашних результатов +- **Статистика за неделю** — недельный отчет о прогрессе +- **Рейтинги по режимам** — отслеживание рейтинга в Bullet, Blitz и Rapid +- **Статистика задач** — количество решенных задач (puzzles) с детализацией правильных и неправильных ответов + +### 🔔 Автоматические уведомления +- **Периодические отчеты** — настройка автоматических уведомлений с заданным интервалом +- **Умные уведомления** — бот отправляет сообщения только при наличии активности +- **Гибкие настройки** — выбор интервала от 15 минут до 24 часов + +### 👥 Управление отслеживанием +- **Множественное отслеживание** — добавление неограниченного количества игроков +- **Активный игрок** — выбор основного игрока для быстрого доступа к статистике +- **Простое управление** — добавление и удаление игроков через удобные команды + +## 👨‍👩‍👧‍👦 Для кого этот бот? + +### 🎓 Для тренеров +- **Отслеживание учеников** — мониторинг прогресса всех ваших подопечных в одном месте +- **Анализ активности** — понимание, кто и как часто тренируется +- **Контроль выполнения заданий** — отслеживание решения задач и игровой активности +- **Сравнительный анализ** — возможность отслеживать нескольких учеников одновременно + +### 🏆 Для игроков +- **Собственный прогресс** — отслеживание своих результатов и рейтинга +- **Мониторинг соперников** — следите за активностью и прогрессом ваших соперников +- **Отслеживание друзей** — держите руку на пульсе активности ваших друзей по шахматам +- **Мотивация** — регулярные уведомления помогают поддерживать регулярность тренировок + +### 👨‍👩‍👧 Для родителей +- **Контроль активности детей** — узнавайте, когда и как часто ваш ребенок играет +- **Отслеживание прогресса** — видите рост рейтинга и улучшение результатов +- **Безопасность** — получайте уведомления о активности без необходимости постоянно проверять сайт +- **Множество детей** — отслеживайте нескольких детей одновременно + +### 🤝 Для всех +- **Отслеживание друзей** — следите за активностью ваших друзей на Lichess +- **Мониторинг соперников** — анализируйте игру ваших постоянных соперников +- **Сравнение результатов** — отслеживайте несколько игроков для сравнения прогресса +- **Гибкость** — каждый может настроить бота под свои нужды + +## 🚀 Как начать использовать? + +1. **Найдите бота в Telegram**: [@LichessStat_bot](https://t.me/LichessStat_bot) +2. **Отправьте команду** `/start` для начала работы +3. **Добавьте игроков** с помощью команды `/addgamer` или `/addtoken` +4. **Выберите активного игрока** через `/getgamers` +5. **Получайте статистику** командами `/today`, `/yesterday`, `/week` +6. **Настройте уведомления** через `/setperiod` для автоматических отчетов + +## 📋 Доступные команды + +- `/start` — начало работы с ботом и добавление первого игрока +- `/addgamer` — добавить игрока Lichess для отслеживания (только имя пользователя) +- `/addtoken` — добавить игрока с токеном для получения статистики по задачам +- `/getgamers` — выбрать активного игрока из вашего списка +- `/delgamer` — удалить игрока из списка отслеживания +- `/today` — статистика активного игрока за сегодня +- `/yesterday` — статистика активного игрока за вчера +- `/week` — статистика активного игрока за неделю +- `/setperiod` — настроить периодические уведомления для активного игрока + +## 💡 Примеры использования + +### Пример 1: Тренер отслеживает учеников +``` +Тренер добавляет всех своих учеников в бот. +Настраивает уведомления каждые 2 часа. +Получает регулярные отчеты об активности каждого ученика. +``` + +### Пример 2: Игрок следит за соперником +``` +Игрок добавляет своего постоянного соперника. +Проверяет его статистику перед важной партией. +Отслеживает изменения рейтинга. +``` + +### Пример 3: Родитель контролирует активность ребенка +``` +Родитель добавляет аккаунт ребенка с токеном. +Настраивает ежедневные уведомления. +Получает информацию о количестве игр и решенных задач. +``` + +## 🔗 Связь с Lichess + +Бот использует официальный API Lichess.org для получения данных. Все данные актуальны и синхронизированы с платформой в реальном времени. + +## 📞 Обратная связь + +**Отзывы и предложения:** [@vrubelr](https://t.me/vrubelr) — буду рад отзывам и предложениям! + +--- + +**Попробуйте бота прямо сейчас:** [https://t.me/LichessStat_bot](https://t.me/LichessStat_bot) +