Skip to content

README-RU.md

Latest commit

 

History

History
148 lines (118 loc) · 5.14 KB

README-RU.md

File metadata and controls

148 lines (118 loc) · 5.14 KB
Raw

Proxima Telegram Bot

Telegram бот для организации матчей, отслеживания статистики и управления сообществом Standoff 2.

Python Aiogram Docker License

Возможности

  • Организация матчей через систему лобби
  • Выбор карт капитанами
  • Статистика игроков и таблица лидеров
  • Система кланов
  • Система жалоб
  • Двуязычность (EN/RU)
  • Ролевая модель (creator > admin > staff > match_checker > player)

Быстрый старт

Требования

Установка

git clone https://github.com/AnonimPython/Proxima.git
cd Proxima

Создайте файл .env:

TELEGRAM_TOKEN=ваш_токен_бота
ADMIN_TELEGRAM_ID=ваш_telegram_id

Сборка и запуск:

docker compose up -d --build

Команды

Создатель

Команда Описание
/alert Массовое уведомление
/make_me_admin Назначить себя админом

Админ

Команда Описание
/make_moderator Назначить staff
/warn Выдать предупреждение
/unwarn Снять предупреждение
/permaban Перманентный бан
/admin_ban Временный бан
/unban Разбан
/banlist Список активных банов
/banhistory История банов игрока

Staff

Команда Описание
/profile @user Профиль любого игрока
/warns @user История предупреждений
/mod_ban Бан (до 7 дней)
/mod_warn Выдать предупреждение
/mod_unban Разбан (свои баны)

Все игроки

Команда Описание
/start Главное меню
/register Создать игровой профиль
/profile Моя статистика
/lobby Поиск игры
/history История матчей
/stats Статистика
/top Топ игроков
/rename Сменить никнейм (500 звёзд)
/clan Управление кланом
/report @user причина Пожаловаться на игрока
/match_register Отправить результат матча
/project О проекте
/support Контакты поддержки
/commands Все команды
/help Помощь

Структура проекта

Proxima/
├── app/
│   ├── handlers/          # Обработчики команд
│   │   ├── start.py       # Старт и меню
│   │   ├── matches.py     # Матчи и лобби
│   │   ├── clans.py       # Система кланов
│   │   ├── rename.py      # Смена ника
│   │   ├── report.py      # Система жалоб
│   │   ├── warns.py       # Система предупреждений
│   │   ├── alert.py       # Массовые уведомления
│   │   ├── register_matches.py  # Регистрация результатов
│   │   └── personal/      # Команды админа и модератора
│   ├── database/
│   │   └── models.py      # Схема базы данных
│   ├── localization/
│   │   ├── en.json        # Английская локализация
│   │   └── ru.json        # Русская локализация
│   ├── utils/             # Вспомогательные функции
│   ├── middlewares/       # Промежуточные слои
│   ├── config.py          # Конфигурация бота
│   ├── logger.py          # Логирование
│   └── main.py            # Точка входа
├── docker-compose.yml
├── Dockerfile
└── README.md

Настройка

Для переименования проекта отредактируйте app/config.py. Остальные настройки в .env.

Планы

  • Система кланов
  • Дополнительные лиги
  • Оплата звёздами
  • Криптовалютные платежи
  • Верификация по телефону
  • Турнирная сетка
  • Достижения
  • Лутбоксы
  • Система пати

Лицензия

MIT

9a077fe (update russian readme to match english version)