Bot.Storage.EFCore 1.0.0

Bot

Минимальный фреймворк для создания Telegram-ботов на .NET.

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

1. Установите .NET 8 SDK.
2. Клонируйте репозиторий и перейдите в каталог проекта:

   git clone <repo-url>
   cd bot
   

3. Создайте бота через @BotFather и получите токен.
4. Запустите пример HelloBot с вашим токеном:

   cd Bot.Examples.HelloBot
   export BOT_TOKEN="<ваш-токен>"
   dotnet run
   

5. Отправьте /start в Telegram — бот ответит «Hello».

Настройки можно менять в appsettings.json или через переменные окружения.

Шаблоны

Доступен один шаблон: dotnet new bot.

Основные параметры:

• --transport polling|webhook — способ получения обновлений (по умолчанию polling);
• --store file|redis|ef — хранилище состояния (file по умолчанию);
• --admin — включить административное API;
• --webapp — добавить точки Mini App;
• --lang ru|en — язык исходников и комментариев.

Скрипты быстрого старта

scripts/quickstart.sh и scripts/quickstart.ps1 проверяют работоспособность шаблона: устанавливают его, запускают сгенерированный бот и вызывают набор тестовых команд.

Упаковка NuGet-пакетов

Для сборки NuGet-пакетов используйте scripts/pack.sh на Linux и macOS или scripts/pack.ps1 на Windows. Скрипт восстанавливает зафиксированные зависимости и собирает пакеты в конфигурации Release.

Переключение хранилища

Тип хранилища выбирается переменной Storage__Provider (file, redis или ef). Прочие параметры задаются в секции Storage.

Административное API

API включено по умолчанию. Для запросов необходим заголовок X-Admin-Token, значение берётся из секции Admin или переменной Admin__AdminToken.

Дополнительные переменные окружения

• QUEUE__POLICY — политика переполнения очереди (Wait или Drop);
• STOP__DRAIN_TIMEOUT_SECONDS — таймаут ожидания при остановке;
• OBS__EXPORT__OTLP — включение OTLP-экспортёра наблюдаемости;
• OUTBOX__PATH — каталог для хранения сообщений аутбокса.

Документация

• Обзор возможностей
• Mini App
• Сцены

Настройки Mini App

• WebApp__PublicUrl — публичный URL страницы;
• WebApp__AuthTtlSeconds — срок жизни JWT в секундах;
• WebApp__InitDataTtlSeconds — время жизни параметра initData;
• WebApp__Csp__AllowedOrigins__0 — дополнительный origin для CSP.

Лидерборды на Redis

using Bot.Storage.Redis;

var options = new RedisOptions { Connection = mux, Database = 0, Prefix = "lb" };
var board = new RedisSortedSet<Player>(options);

await board.AddAsync("game", new Player("Alice"), 1200, ct);
await board.AddAsync("game", new Player("Bob"), 1500, ct);

var top = await board.RangeByScoreAsync("game", 0, double.MaxValue, ct);

public sealed record Player(string Name);

Значения сериализуются в JSON и сохраняются с указанным префиксом ключей.