Skip to main content
Version: Latest

config.yaml

πŸ›  How to Use Parameters​

To change RimTUB's behavior, simply add the desired parameter to the config.yaml file and specify its value using a colon.

For example, to disable sound:

PLAY_SOUND: No

Values can be of different types:

  • string β€” plain text. Can be written with or without quotes if it contains only letters and numbers.
    Example: 
    BOT_TOKEN: "123456:ABC-DEF"
  • number β€” integer or floating-point. Written without quotes.
    Example: 
    API_ID: 22983860
    DMF_TIMEOUT: 2.5
  • Yes / No β€” enable or disable a setting.
    Example: 
    SHOW_NOTIFICATION: Yes
    DISABLE_STARTUP_MESSAGE: No
  • list β€” multiple values. Written with indents and dashes.
    Example: 
    PHONES:
      - "380501234567"
      - "79001234567"

If a parameter is not specified, the default value is used.
Want to change something? Just add the necessary line and specify your value.

Main Settings​

  • PHONES (list of strings): List of phone numbers from which RimTUB will be launched.

  • BOT_TOKEN (string): Telegram bot token from BotFather.

  • PREFIX (string): Prefix before commands.
    Default: "."

  • PLAY_SOUND (Yes/No): Whether to play a sound when starting UB.
    Default: No

  • SHOW_NOTIFICATION (Yes/No): Whether to show a notification when starting UB.
    Default: Yes

  • SHOW_HEADER_IN_HELP (Yes/No): Whether to show the header in .help.
    Default: Yes

  • SHOW_MODULES_WITH_COMMAND_IN_HELP (Yes/No): Whether to show the .h command before module names in .help.
    Default: Yes

Telegram API​

  • API_ID (number): Telegram API ID.
    Default: 22983860

  • API_HASH (string): Telegram API Hash.
    Default: "37c11863c1bf2330c0cc64d1755f9e60"

Logging​

  • LOGGING_LEVEL (number): System logging level.
    Default: 10 ("DEBUG")

  • BOT_LOGGING_LEVEL (number): Bot logging level.
    Default: 40 ("ERROR")

  • DEFAULT_MODULE_LOGGING_LEVEL (number): Module logging level.
    Default: 10 ("DEBUG")

Startup Behavior​

  • DISABLE_STARTUP_MESSAGE (Yes/No): Disable the welcome message at startup.
    Default: No

Time Delays​

  • DMF_TIMEOUT (number): Timeout for .dmf in seconds.
    Default: 5

  • DML_TIMEOUT (number): Timeout for .dml in seconds.
    Default: 5

Checks and Whitelist​

warning

As of the release of this documentation, RimTUB does not support module authenticity checks. Therefore, these parameters have no effect. It is recommended to set the DISABLE_MODULE_CHECKING parameter to Yes to avoid wasting time on module checks that do not work.

  • CHECK_HASH_URL (string): URL for hash verification.
    Default: "https://rimtub.pp.ua/api/checkHash/{hash}"

  • DML_WHITELIST (list of strings): Allowed domains for downloading modules.
    Default: ["rimtub.pp.ua"]

  • CHECK_VERSIONS_URL (string): URL for retrieving available module versions.
    Default: "https://rimtub.pp.ua/api/getAvaiableRimTUBModuleVersions/{module_name}/{module_version}"

  • DISABLE_MODULE_VERSION_CHECKING (Yes/No): Disable module version compatibility checks.
    Default: No

  • DISABLE_MODULE_CHECKING (Yes/No): Disable module authenticity checks.
    Default: No

Proxy Support​

  • PROXY (dictionary or null): Proxy server or null if not used.
    Default: null

Device Info (for client)​

  • CL_DEVICE_MODEL (string): Device model.
    Default: 'M2102J20SG'

  • CL_SYSTEM_VERSION (string): System version.
    Default: 'SDK 30'

  • CL_LANG_PACK (string): Language pack name.
    Default: 'android'

  • CL_LANG_CODE (string): Language.
    Default: 'ru'

  • CL_SYSTEM_LANG_CODE (string): Full system language code.
    Default: 'ru_RU'

  • CL_CLIENT_PLATFORM (ClientPlatform): Client platform.
    Default: ClientPlatform.OTHER

Pickle Storage​

  • PICKLE_STORAGE_META_FILE (string): Metadata file.
    Default: 'pickle_meta.json'

  • CLEANUP_EXPIRED_PICKLE_STORAGE_FILES_INTERVAL (number): Cleanup interval in seconds.
    Default: 3600

  • DEFAULT_PICKLE_STORAGE_FILES_TTL (number): TTL for pickle files in seconds.
    Default: 259200 (3 days)

Logs​

  • COMPRESS_OLD_LOGFILES (Yes/No): Compress old log files.
    Default: Yes

  • AUTO_DELETE_OLD_LOGFILES (Yes/No): Automatically delete old log files.
    Default: Yes

  • DELETE_LOGFILES_OLDER_THAN_DAYS (number): Delete log files older than N days.
    Default: 7