Перейти к основному содержимому
Версия: Latest

config.yaml

🛠 Как пользоваться параметрами​

Чтобы изменить поведение RimTUB, просто добавь нужный параметр в файл config.yaml и укажи его значение через двоеточие.

Например, чтобы отключить звук:

PLAY_SOUND: No

Значения бывают разного типа:

  • строка — обычный текст. Пишется в кавычках или без, если там только буквы и цифры.
    Пример: 
    BOT_TOKEN: "123456:ABC-DEF"
  • число — целое или дробное. Пишется без кавычек.
    Пример: 
    API_ID: 22983860
    DMF_TIMEOUT: 2.5
  • Yes / No — включить или выключить настройку.
    Пример: 
    SHOW_NOTIFICATION: Yes
    DISABLE_STARTUP_MESSAGE: No
  • список — несколько значений. Пишется с отступами и тире.
    Пример: 
    PHONES:
      - "380501234567"
      - "79001234567"

Если параметр не указан — используется значение по умолчанию.
Хочешь изменить что-то — просто добавь нужную строку и укажи своё значение.

Основные настройки​

  • PHONES (список строк): Список номеров телефонов, с которых будет запускаться RimTUB.

  • BOT_TOKEN (строка): Токен Telegram-бота от BotFather.

  • PREFIX (строка): Префикс перед командами.
    По умолчанию: "."

  • PLAY_SOUND (Yes/No): Воспроизводить ли звук при запуске ЮБ.
    По умолчанию: No

  • SHOW_NOTIFICATION (Yes/No): Показывать ли уведомление при запуске ЮБ.
    По умолчанию: Yes

  • SHOW_HEADER_IN_HELP (Yes/No): Показывать ли шапку в .help.
    По умолчанию: Yes

  • SHOW_MODULES_WITH_COMMAND_IN_HELP (Yes/No): Показывать ли команду .h перед названиями модулей в .help.
    По умолчанию: Yes

Telegram API​

  • API_ID (число): Telegram API ID.
    По умолчанию: 22983860

  • API_HASH (строка): Telegram API Hash.
    По умолчанию: "37c11863c1bf2330c0cc64d1755f9e60"

Логирование​

  • LOGGING_LEVEL (число): Уровень логирования системы.
    По умолчанию: 10 ("DEBUG")

  • BOT_LOGGING_LEVEL (число): Уровень логирования бота.
    По умолчанию: 40 ("ERROR")

  • DEFAULT_MODULE_LOGGING_LEVEL (число): Уровень логирования модулей.
    По умолчанию: 10 ("DEBUG")

Поведение при запуске​

  • DISABLE_STARTUP_MESSAGE (Yes/No): Отключить приветственное сообщение при старте.
    По умолчанию: No

Временные задержки​

  • DMF_TIMEOUT (число): Таймаут .dmf в секундах.
    По умолчанию: 5

  • DML_TIMEOUT (число): Таймаут .dml в секундах.
    По умолчанию: 5

Проверки и Whitelist​

warning

На момент релиза этой документации, RimTUB не поддерживает проверку модулей на подлинность. Так-что эти параметры ни на что не влияют. А параметр DISABLE_MODULE_CHECKING советую устанавливать в Yes, чтобы не тратить время на проверку модулей, которая и так не работает.

  • CHECK_HASH_URL (строка): URL для проверки хэша.
    По умолчанию: "https://rimtub.pp.ua/api/checkHash/{hash}"

  • DML_WHITELIST (список строк): Разрешённые домены с которых скачиваются модули.
    По умолчанию: ["rimtub.pp.ua"]

  • CHECK_VERSIONS_URL (строка): URL для получения доступных версий модулей.
    По умолчанию: "https://rimtub.pp.ua/api/getAvaiableRimTUBModuleVersions/{module_name}/{module_version}"

  • DISABLE_MODULE_VERSION_CHECKING (Yes/No): Отключить проверку модулей на соответствие версии модуля и ЮБ. По умолчанию: No

  • DISABLE_MODULE_CHECKING (Yes/No): Отключить проверку модулей на подлинность. По умолчанию: No

Поддержка прокси​

  • PROXY (словарь или null): Прокси-сервер или null, если не используется.
    По умолчанию: null

Инфо об устройстве (для клиента)​

  • CL_DEVICE_MODEL (строка): Модель устройства.
    По умолчанию: 'M2102J20SG'

  • CL_SYSTEM_VERSION (строка): Версия системы.
    По умолчанию: 'SDK 30'

  • CL_LANG_PACK (строка): Название языкового пакета.
    По умолчанию: 'android'

  • CL_LANG_CODE (строка): Язык.
    По умолчанию: 'ru'

  • CL_SYSTEM_LANG_CODE (строка): Полный код языка системы.
    По умолчанию: 'ru_RU'

  • CL_CLIENT_PLATFORM (ClientPlatform): Платформа клиента.
    По умолчанию: ClientPlatform.OTHER

Pickle-хранилище​

  • PICKLE_STORAGE_META_FILE (строка): Файл метаданных.
    По умолчанию: 'pickle_meta.json'

  • CLEANUP_EXPIRED_PICKLE_STORAGE_FILES_INTERVAL (число): Интервал очистки, сек.
    По умолчанию: 3600

  • DEFAULT_PICKLE_STORAGE_FILES_TTL (число): TTL файлов pickle в сек.
    По умолчанию: 259200 (3 дня)

Логи​

  • COMPRESS_OLD_LOGFILES (Yes/No): Сжимать старые логи.
    По умолчанию: Yes

  • AUTO_DELETE_OLD_LOGFILES (Yes/No): Удалять старые логи.
    По умолчанию: Yes

  • DELETE_LOGFILES_OLDER_THAN_DAYS (число): Удаление логов старше N дней.
    По умолчанию: 7