Перейти к основному содержанию

Documentation Index

Fetch the complete documentation index at: https://remnawave.shop/llms.txt

Use this file to discover all available pages before exploring further.

Баннеры

Бот поддерживает кастомные баннеры для каждой страницы и локали. Поддерживаемые названия страниц: menu, dashboard, subscription, promocode, referral, default. Поддерживаемые форматы: jpg, jpeg, png, gif, webp. Баннеры должны быть размещены по пути: /opt/remnashop/assets/banners/

Порядок поиска баннера

При загрузке баннера система ищет файл в следующем порядке:
  1. banners/{locale_пользователя}/{страница} — страничный баннер для локали пользователя
  2. banners/{locale_пользователя}/default — дефолтный баннер для локали пользователя
  3. banners/{locale_по_умолчанию}/{страница} — страничный баннер для локали по умолчанию
  4. banners/{locale_по_умолчанию}/default — дефолтный баннер для локали по умолчанию
  5. banners/default — глобальный запасной баннер

Примеры использования

  • Одно изображение для всего — разместите единственный файл banners/default.jpg
  • Своё изображение для каждой локали — разместите banners/{locale}/default.jpg для каждой локали
  • Изображения для каждой страницы — разместите banners/{locale}/{страница}.jpg для каждой страницы и локали

Пример структуры файлов

banners/
├── default.jpg             ← глобальный запасной баннер для всех страниц и локалей
├── ru/
│   ├── default.jpg         ← дефолтный баннер для всех страниц в локали ru
│   ├── menu.jpg
│   └── subscription.jpg
└── en/
    ├── default.jpg
    └── menu.jpg
Файл banners/default.jpg является глобальным запасным баннером и необходим для корректной работы бота. Не удаляйте его.

Переводы

Файлы переводов находятся по пути: /opt/remnashop/assets/translations/{locale}/
ФайлОписание
buttons.ftlПодписи кнопок
messages.ftlСообщения и тексты диалогов
notifications.ftlТексты уведомлений
events.ftlСообщения, отправляемые по событиям
utils.ftlВспомогательные строки (статусы, подписи и т.п.)
custom.ftlПользовательские переводы для названий планов, кнопок меню и т.п.
Файл custom.ftl предназначен для пользовательских ключей — например, переводов названий планов или дополнительных кнопок меню. Добавляйте свои ключи сюда, не изменяя основные файлы. После внесения изменений необходимо перезапустить контейнер, чтобы они вступили в силу.
cd /opt/remnashop && docker compose down && docker compose up -d
В настоящее время сохранение переводов при обновлении бота не поддерживается. При обновлении ваши предыдущие ассеты будут заархивированы по пути: /opt/remnashop/assets/*.bak

Логотип QR-кода

Вы можете добавить кастомный логотип в центр генерируемых QR-кодов приглашений.
  • Путь: assets/logo.png
  • Формат: PNG, желательно с прозрачным фоном
Если файл существует, он автоматически будет наложен в центр каждого сгенерированного QR-кода.