UI_Config.json

{
    "output_file": "Settings/settings.json",
    "read_all_text": {
        "type": "checkbox",
        "value": false,
        "label": "Read ALL chat",
        "tooltip": "Check this to read all chat disregarding the command.\nIF YOU ARE USING THIS FEATURE MAKE SURE TO SET A FAST SPEED SO THE CHATBOT CAN KEEP UP!",
        "group": "General"
    },
    "tts_case": {
        "type": "dropdown",
        "label": "Force lower or upper case",
        "value": "",
        "tooltip": "Set this if you want TTS to read lowercase (could avoid acronyms reading on uppercase words) or uppercase (could read words as acronym).",
        "items": [
            "",
            "Lower",
            "Upper"
        ],
        "group": "General"
    },
    "tts_clean_repeated_letters": {
        "type": "checkbox",
        "value": true,
        "label": "Clean repeated letters",
        "tooltip": "Prevent repeated letters to be spoken and only speak them twice.\nExample: noooooooo -> noo.",
        "group": "General"
    },
    "tts_clean_repeated_words": {
        "type": "checkbox",
        "value": true,
        "label": "Clean repeated words/emotes",
        "tooltip": "Prevent repeated words/emotes to be spoken and only speak them as max as setted below.\nExample: :Kappa: :Kappa: :Kappa: :Kappa: :Kappa: :Kappa: -> :Kappa:",
        "group": "General"
    },
    "tts_max_repeated_words": {
        "type": "slider",
        "label": "Max words/emotes repeat allowed",
        "value": 3,
        "min": 1,
        "max": 5,
        "ticks": 1,
        "tooltip": "How many times you allow to repeat a word/emote.",
        "group": "General"
    },
    "tts_clean_urls": {
        "type": "checkbox",
        "value": true,
        "label": "Clean links",
        "tooltip": "Prevent links to be spoken and say the replacement text instead",
        "group": "General"
    },
    "tts_replacement_urls": {
        "type": "textbox",
        "value": "link removed",
        "label": "Replace links with",
        "tooltip": "If Clean links is checked, the links will be replaced with this text",
        "group": "General"
    },
    "say_username": {
        "type": "checkbox",
        "value": true,
        "label": "Say username before message",
        "tooltip": "Check this to say the username before the message",
        "group": "General"
    },
    "say_after_username": {
        "type": "textbox",
        "value": "says",
        "label": "Say this after the username",
        "tooltip": "Append this text to the username so the TTS makes more sense.\nNote: it will not apply if a language is chosen by chatter with multi language option active.",
        "group": "General"
    },
    "ignore_starting_with": {
        "type": "textbox",
        "value": "!",
        "label": "Ignore messages starting with",
        "tooltip": "Ignore messages starting with any of these characters to prevent commands being spoken",
        "group": "General"
    },
    "tts_replaces": {
        "type": "textbox",
        "value": "_@",
        "label": "Replace these with spaces",
        "tooltip": "For each character in here, replaces each occurrence of it with a white space, so TTS will not read them literally.",
        "group": "General"
    },
    "tts_emote_prefix": {
        "type": "textbox",
        "value": "",
        "label": "Emote prefix, don't read this",
        "tooltip": "If you want to read your own channel emotes name as words and skip prefix, specify it here.\nBe sure it is not a common char sequence used in your TTS, otherwise it would became mute at any occurrence, also outside emotes' name. It is case sensitive.\nSetting the other option (First emotes' name letter is uppercase) could help.\nLeft empty if you don't want to use this option.",
        "group": "General"
    },
    "tts_emote_name_first_is_upper": {
        "type": "checkbox",
        "value": true,
        "label": "First emotes' name letter is uppercase, after prefix",
        "tooltip": "Check this if the first letter of your emotes' name (the first letter after your channel prefix) is uppercased.\nChecking this flag could help next option (Emote prefix, don't read this) to not be too invasive and to create less oddities.",
        "group": "General"
    },
    "tts_alias_list": {
        "type": "textbox",
        "value": "Word1:Alias1;Word2:Alias2;Word3:Alias3",
        "label": "Alias to apply to words or nicknames",
        "tooltip": "You can set aliases for words or nicknames (only full words, no partials), if you want them to be spelled differently. Expressed with 'Word:Alias' or 'Name:Alias' couples separated by semicolon.\nNote1: It also applies on 'Say username' option. \nNote2: Blacklist checks will be made on original nicknames.",
        "group": "General"
    },
    "tts_chars_swapping": {
        "type": "textbox",
        "value": "Chars1:Swaps1;Chars2:Swaps2;Chars3:Swaps3",
        "label": "Character series to swap",
        "tooltip": "Swaps series of characters with another series, if you want them to be spelled differently. Expressed with 'Chars:Swaps' couples separated by semicolon.\nNote: at the contrary of aliases, as for the option above, this option is case sensitive but swaps also partial words, so it could be invasive and create oddities. Be sure to use the most rich series of characters possible.",
        "group": "General"
    },
    "tts_cut_max_chars": {
        "type": "checkbox",
        "value": true,
        "label": "Cut automatically to Max chars allowed",
        "tooltip": "Check this to let the system automatically cut text to max characters allowed, to be able to play TTS.\nOtherwise the text will not be read if too long (silently ignored).",
        "group": "General"
    },
    "tts_max_chars": {
        "type": "slider",
        "label": "Max chars allowed",
        "value": 200,
        "min": 1,
        "max": 200,
        "ticks": 1,
        "tooltip": "Max characters allowed to submit to TTS.",
        "group": "General"
    },
    "tts_preview": {
        "type": "checkbox",
        "value": false,
        "label": "Write in chat the text to be read",
        "tooltip": "Turn ON to write in chat the sentence TTS is gonna read.\n(Mainly for debug purposes.)",
        "group": "General"
    },
    "command": {
        "type": "textbox",
        "value": "!tts",
        "label": "Command",
        "tooltip": "Command for users to say something with TTS.",
        "group": "Command configuration"
    },
    "permission": {
        "type": "dropdown",
        "value": "Everyone",
        "items": [
            "Everyone",
            "Regular",
            "VIP",
            "Subscriber",
            "Moderator",
            "Editor"
        ],
        "label": "Minimum permission level",
        "tooltip": "Set the permission level for the command.",
        "group": "Command configuration"
    },
    "cooldown": {
        "type": "numberbox",
        "value": 0,
        "label": "Global cooldown (seconds)",
        "tooltip": "Cooldown applied globally.",
        "group": "Command configuration"
    },
    "user_cooldown": {
        "type": "numberbox",
        "value": 0,
        "label": "User cooldown (seconds)",
        "tooltip": "Cooldown applied for each user.",
        "group": "Command configuration"
    },
    "cost": {
        "type": "numberbox",
        "value": 0,
        "label": "Cost",
        "tooltip": "Command cost.",
        "group": "Command configuration"
    },
    "do_msg_missing_text": {
        "type": "checkbox",
        "value": true,
        "label": "Missing text",
        "tooltip": "Check this to shown a message when someone tries to issue the command without a text to be read.",
        "group": "Command messages"
    },
    "msg_missing_text": {
        "type": "textbox",
        "value": "You need to specify a message.",
        "label": "Missing text message",
        "tooltip": "Message shown when someone tries to issue the command without a text to be read.",
        "group": "Command messages"
    },
    "do_msg_permission": {
        "type": "checkbox",
        "value": true,
        "label": "Permissions",
        "tooltip": "Check this to shown a message when someone tries to issue the command without enough permissions.",
        "group": "Command messages"
    },
    "msg_permission": {
        "type": "textbox",
        "value": "You don't have enough permissions to use this command.",
        "label": "Permissions message",
        "tooltip": "Message shown when someone tries to issue the command without enough permissions.",
        "group": "Command messages"
    },
    "do_msg_cooldown": {
        "type": "checkbox",
        "value": true,
        "label": "Cooldown",
        "tooltip": "Check this to shown a message when someone tries to issue the command but it is still on cooldown.",
        "group": "Command messages"
    },
    "msg_cooldown": {
        "type": "textbox",
        "value": "This command is still on cooldown!",
        "label": "Cooldown message",
        "tooltip": "Message shown when someone tries to issue the command but it is still on cooldown.",
        "group": "Command messages"
    },
    "do_msg_user_cooldown": {
        "type": "checkbox",
        "value": true,
        "label": "User Cooldown",
        "tooltip": "Check this to shown a message when someone tries to issue the command while they are on cooldown.",
        "group": "Command messages"
    },
    "msg_user_cooldown": {
        "type": "textbox",
        "value": "You need to wait before using this command again.",
        "label": "User Cooldown message",
        "tooltip": "Message shown when someone tries to issue the command while they are on cooldown.",
        "group": "Command messages"
    },
    "do_msg_cost": {
        "type": "checkbox",
        "value": true,
        "label": "Cost",
        "tooltip": "Check this to shown a message when someone tries to issue the command without enough points.",
        "group": "Command messages"
    },
    "msg_cost": {
        "type": "textbox",
        "value": "You don't have enough money to use this command.",
        "label": "Cost message",
        "tooltip": "Message shown when someone tries to issue the command without enough points.",
        "group": "Command messages"
    },
    "do_msg_too_long": {
        "type": "checkbox",
        "value": true,
        "label": "Too long",
        "tooltip": "Check this to shown a message when someone tries to issue the command with a message too long.",
        "group": "Command messages"
    },
    "msg_too_long": {
        "type": "textbox",
        "value": "{0}'s message was too long!",
        "label": "Too long message",
        "tooltip": "Message shown when someone tries to issue the command with a message too long. {0} is where user's nickname will go.",
        "group": "Command messages"
    },
    "do_msg_blacklisted": {
        "type": "checkbox",
        "value": true,
        "label": "Blacklisted",
        "tooltip": "Check this to shown a message when someone banned tries to issue a command.",
        "group": "Command messages"
    },
    "msg_blacklisted": {
        "type": "textbox",
        "value": "{0} is Blacklisted!",
        "label": "Blacklisted message",
        "tooltip": "Message shown when someone banned tries to issue a command. {0} is where user's nickname will go.",
        "group": "Command messages"
    },
    "cmd_skip": {
        "type": "textbox",
        "value": "!ttskip",
        "label": "Skip currently playing text command",
        "tooltip": "Use this command to skip the currently playing text in case of a troll.\nYou can even skip all texts in queue containing a reference word, if any word is specified after the command.",
        "group": "Moderator commands"
    },
    "cmd_skipnext": {
        "type": "textbox",
        "value": "!ttskipnext",
        "label": "Skip next text command in queue, without need the current one ends up",
        "tooltip": "Use this command to skip the next text queue, in case of a troll, without need to wait the current one ends up.",
        "group": "Moderator commands"
    },
    "cmd_skipall": {
        "type": "textbox",
        "value": "!ttskipall",
        "label": "Skip the whole text command queue, and start a new one",
        "tooltip": "Use this command to skip the whole texts queue, for any reason, like going to close the session.",
        "group": "Moderator commands"
    },
    "cmd_pause": {
        "type": "textbox",
        "value": "!ttspause",
        "label": "Pauses\\Unpauses the script.",
        "tooltip": "Use this command to pause or unpause the script.\nNote: if the TTS is already reading, it will still finish the current reading.",
        "group": "Moderator commands"
    },
    "do_keep": {
        "type": "checkbox",
        "value": false,
        "label": "Keep queuing on pause",
        "tooltip": "Check this to keep queuing new TTS messages even if you paused the script.\nAll queued messages will be read sequentially after unpaused, you can still skip them with skip commands.",
        "group": "Moderator commands"
    },
    "cmd_keep": {
        "type": "textbox",
        "value": "!ttskeep",
        "label": "Keep\\Unkeep queuing on pause.",
        "tooltip": "Use this command to keep queuing or not TTS messages while the script is paused.\nNote: this command changes the setting only for current session. Next session will start as for general settings flag.",
        "group": "Moderator commands"
    },
    "cmd_ban": {
        "type": "textbox",
        "value": "!ttsban",
        "label": "Add user to blacklist command",
        "tooltip": "Use this command to add an user to the blacklist",
        "group": "Moderator commands"
    },
    "cmd_unban": {
        "type": "textbox",
        "value": "!ttsunban",
        "label": "Remove user from blacklist command",
        "tooltip": "Use this command to remove an user from the blacklist",
        "group": "Moderator commands"
    },
    "moderator_permission": {
        "type": "dropdown",
        "value": "Caster",
        "items": [
            "Moderator",
            "Editor",
            "Caster"
        ],
        "label": "Moderator permission",
        "tooltip": "Allow these users to blacklist/unblacklist people",
        "group": "Moderator commands"
    },
    "mod_bannable": {
        "type": "checkbox",
        "value": false,
        "label": "Allow bannable moderators",
        "tooltip": "Check this to make moderators bannable from using Moderator commands.",
        "group": "Moderator commands"
    },
    "do_msg_missing_target": {
        "type": "checkbox",
        "value": true,
        "label": "Missing target",
        "tooltip": "Check this to shown when moderator forget to specify the target user.",
        "group": "Moderator commands message"
    },
    "msg_missing_target": {
        "type": "textbox",
        "value": "Usage: {0} <username>",
        "label": "Missing target message",
        "tooltip": "Message shown when moderator forget to specify the target user. {0} is where the command will go.",
        "group": "Moderator commands message"
    },
    "do_msg_paused": {
        "type": "checkbox",
        "value": true,
        "label": "TTS paused",
        "tooltip": "Check this to shown a message when TTS is paused with pause command.",
        "group": "Moderator commands message"
    },
    "msg_paused": {
        "type": "textbox",
        "value": "TTS paused.",
        "label": "TTS paused message",
        "tooltip": "Message shown when moderator paused TTS with pause command.",
        "group": "Moderator commands message"
    },
    "do_msg_unpaused": {
        "type": "checkbox",
        "value": true,
        "label": "TTS unpaused",
        "tooltip": "Check this to shown a message when TTS is unpaused with pause command.",
        "group": "Moderator commands message"
    },
    "msg_unpaused": {
        "type": "textbox",
        "value": "TTS unpaused.",
        "label": "TTS unpaused message",
        "tooltip": "Message shown when moderator unpaused TTS with pause command.",
        "group": "Moderator commands message"
    },
    "do_msg_keep": {
        "type": "checkbox",
        "value": true,
        "label": "TTS keeps queuing on pause",
        "tooltip": "Check this to shown a message when TTS keeps queuing on pause after keep command.",
        "group": "Moderator commands message"
    },
    "msg_keep": {
        "type": "textbox",
        "value": "TTS keeps queuing on pause.",
        "label": "TTS keeps queuing on pause message",
        "tooltip": "Message shown when moderator set TTS to keeping queuing on pause after keep command.",
        "group": "Moderator commands message"
    },
    "do_msg_unkeep": {
        "type": "checkbox",
        "value": true,
        "label": "TTS stops queuing on pause",
        "tooltip": "Check this to shown a message when TTS keeps stops queuing on pause after keep command.",
        "group": "Moderator commands message"
    },
    "msg_unkeep": {
        "type": "textbox",
        "value": "TTS stops queuing on pause.",
        "label": "TTS stops queuing on pause message",
        "tooltip": "Message shown when moderator set TTS to stop queuing on pause after keep command.",
        "group": "Moderator commands message"
    },
    "do_msg_blacklisted_success": {
        "type": "checkbox",
        "value": true,
        "label": "Successfully blacklisted",
        "tooltip": "Check this to shown when moderator succeed to ban an user.",
        "group": "Moderator commands message"
    },
    "msg_blacklisted_success": {
        "type": "textbox",
        "value": "{0} successfully blacklisted!",
        "label": "Successfully blacklisted message",
        "tooltip": "Message shown when moderator succeed to ban an user. {0} is where user's nickname will go.",
        "group": "Moderator commands message"
    },
    "do_msg_blacklisted_unsuccess": {
        "type": "checkbox",
        "value": true,
        "label": "Unsuccessfully blacklisted",
        "tooltip": "Check this to shown when moderator tries to ban an already banned user.",
        "group": "Moderator commands message"
    },
    "msg_blacklisted_unsuccess": {
        "type": "textbox",
        "value": "{0} already blacklisted!",
        "label": "Unsuccessfully blacklisted message",
        "tooltip": "Message shown when moderator tries to ban an already banned user. {0} is where user's nickname will go.",
        "group": "Moderator commands message"
    },
    "do_msg_unbanned_success": {
        "type": "checkbox",
        "value": true,
        "label": "Successfully unbanned",
        "tooltip": "Check this to shown when moderator succeed to unban an user.",
        "group": "Moderator commands message"
    },
    "msg_unbanned_success": {
        "type": "textbox",
        "value": "{0} removed from blacklist!",
        "label": "Successfully unbanned message",
        "tooltip": "Message shown when moderator succeed to unban an user. {0} is where user's nickname will go.",
        "group": "Moderator commands message"
    },
    "do_msg_unbanned_unsuccess": {
        "type": "checkbox",
        "value": true,
        "label": "Unsuccessfully unbanned",
        "tooltip": "Check this to shown when moderator tries to ban a not banned user.",
        "group": "Moderator commands message"
    },
    "msg_unbanned_unsuccess": {
        "type": "textbox",
        "value": "{0} was not blacklisted!",
        "label": "Unsuccessfully unbanned message",
        "tooltip": "Message shown when moderator tries to unban a not banned user. {0} is where user's nickname will go.",
        "group": "Moderator commands message"
    },
    "tts_lang": {
        "type": "dropdown",
        "label": "TTS Language",
        "value": "English (US) [en-US]",
        "tooltip": "Change Language",
        "items": [
            "Arabic [ar-XA]",
            "Czech (Czech Republic) [cs-CZ]",
            "Danish (Denmark) [da-DK]",
            "Dutch (Netherlands) [nl-NL]",
            "English (Australia) [en-AU]",
            "English (India) [en-IN]",
            "English (UK) [en-GB]",
            "English (US) [en-US]",
            "Filipino (Philippines) [fil-PH]",
            "Finnish (Finland) [fi-FI]",
            "French (Canada) [fr-CA]",
            "French (France) [fr-FR]",
            "German (Germany) [de-DE]",
            "Greek (Greece) [el-GR]",
            "Hindi (India) [hi-IN]",
            "Hungarian (Hungary) [hu-HU]",
            "Indonesian (Indonesia) [id-ID]",
            "Italian (Italy) [it-IT]",
            "Japanese (Japan) [ja-JP]",
            "Korean (South Korea) [ko-KR]",
            "Mandarin Chinese [cmn-CN]",
            "Norwegian (Norway) [nb-NO]",
            "Polish (Poland) [pl-PL]",
            "Portuguese (Brazil) [pt-BR]",
            "Portuguese (Portugal) [pt-PT]",
            "Russian (Russia) [ru-RU]",
            "Slovak (Slovakia) [sk-SK]",
            "Spanish (Spain) [es-ES]",
            "Spanish (Latin America) [es-MX]",
            "Swedish (Sweden) [sv-SE]",
            "Turkish (Turkey) [tr-TR]",
            "Ukrainian (Ukraine) [uk-UA]",
            "Vietnamese (Vietnam) [vi-VN]"
        ],
        "group": "TTS Configuration"
    },
    "tts_volume_on": {
        "type": "checkbox",
        "value": true,
        "label": "Alter volume?",
        "tooltip": "Alter volume of TTS generated file?",
        "group": "TTS Configuration"
    },
    "tts_volume": {
        "type": "slider",
        "label": "TTS Volume",
        "value": 90,
        "min": 1,
        "max": 100,
        "ticks": 1,
        "tooltip": "Change volume",
        "group": "TTS Configuration"
    },
    "tts_pitch_on": {
        "type": "checkbox",
        "value": true,
        "label": "Alter pitch?",
        "tooltip": "Alter pitch of TTS generated file?\nNote: Pitch will still influece speed final effect, if alter speed is enabled.",
        "group": "TTS Configuration"
    },
    "tts_pitch": {
        "type": "slider",
        "label": "TTS % Pitch",
        "value": 100,
        "min": 50,
        "max": 150,
        "ticks": 1,
        "tooltip": "Change default pitch of voice",
        "group": "TTS Configuration"
    },
    "tts_speed_on": {
        "type": "checkbox",
        "value": true,
        "label": "Alter speed?",
        "tooltip": "Alter speed of TTS generated file?\nNote: Pitch value will also be involted, even if alter pitch is disabled.",
        "group": "TTS Configuration"
    },
    "tts_speed": {
        "type": "slider",
        "label": "TTS % Speed",
        "value": 100,
        "min": 75,
        "max": 250,
        "ticks": 1,
        "tooltip": "Change default speed of voice",
        "group": "TTS Configuration"
    },
    "tts_length": {
        "type": "slider",
        "label": "Max length (seconds)",
        "value": 26,
        "min": 2,
        "max": 60,
        "ticks": 1,
        "tooltip": "Limit the duration the TTS will be speaking.",
        "group": "TTS Configuration"
    },
    "tts_confirm": {
        "type": "textbox",
        "value": "Configuration updated successfully",
        "label": "Settings update confirmation",
        "tooltip": "TTS will say this sentence to confirm settings are updated successfully.",
        "group": "TTS Configuration"
    },
    "tts_multi_lang_on": {
        "type": "checkbox",
        "value": false,
        "label": "Allows multi languages?",
        "tooltip": "It enables codes (from list below) to allow users to request TTS for different languages.",
        "group": "TTS Multi languages"
    },
    "tts_multi_lang": {
        "type": "textbox",
        "value": "Arabic: ar-XA; Czech: cs-CZ; Danish: da-DK; Dutch: nl-NL; English (AUS): en-AU; English (IND): en-IN; English (UK): en-GB; English (US): en-US; Filipino: fil-PH; Finnish: fi-FI; French (CAN): fr-CA; French (FRA): fr-FR; German: de-DE; Greek: el-GR; Hindi: hi-IN; Hungarian: hu-HU; Indonesian: id-ID; Italian: it-IT; Japanese: ja-JP; Korean: ko-KR; Mandarin: cmn-CN; Norwegian: nb-NO; Polish: pl-PL; Portuguese (BRA): pt-BR; Portuguese (PRT): pt-PT; Russian: ru-RU; Slovak): sk-SK; Spanish (ESP): es-ES; Spanish (LATAM): es-MX; Swedish: sv-SE; Turkish: tr-TR; Ukrainian: uk-UA; Vietnamese: vi-VN;",
        "label": "Set all custom languages available",
        "tooltip": "Set all custom languages available, with their \"in chat\" codes. Like \"Language: code; Language2: code2;\" without quotes.\nThe code will have to follow the command itself, as first parameter before the text to be read.",
        "group": "TTS Multi languages"
    },
    "tts_multi_lang_case_sensitive": {
        "type": "checkbox",
        "value": false,
        "label": "Codes are case sensitive?",
        "tooltip": "If enabled, languages' code uppercases and lowercases have to be respected.",
        "group": "TTS Multi languages"
    },
    "tts_show_multi_lang_on": {
        "type": "checkbox",
        "value": true,
        "label": "Show available languages?",
        "tooltip": "If enabled, the following command \"Show available languages command\" will be activated for chatters.",
        "group": "TTS Multi languages"
    },
    "tts_show_multi_lang": {
        "type": "textbox",
        "label": "Show languages command",
        "value": "!langs",
        "tooltip": "Litellary writes in chat your custom languages setting, to let chatters know possible languages.",
        "group": "TTS Multi languages"
    },
    "tts_show_multi_lang_cooldown": {
        "type": "numberbox",
        "value": 25,
        "label": "Show languages cooldown (secs)",
        "tooltip": "Cooldown applied to \"Show available languages command\".",
        "group": "TTS Multi languages"
    },
    "tts_params": {
        "type": "textbox",
        "value": "\"i.e. this will replace {2}\"\"This will replace {3}\"",
        "label": "Custom parameters",
        "tooltip": "These parameters will fill the webservice call, replacing in order {2}, {3} and so on.\nThey have to be enclosed in quotation marks.\n{0} and {1} are not included because they'll be {0} = text to read and {1} = lang.\nIf your webservice lang format is different than default (i.e not: 'en-GB', 'fil-PH', 'it-IT') you can set it as custom parameter.",
        "group": "TTS Server"
    },
    "tts_webservice": {
        "type": "textbox",
        "value": "https://translate.google.com/translate_tts?ie=UTF-8&tl={1}&client=tw-ob&q={0}",
        "label": "Webservice",
        "tooltip": "The webservice to be called for TTS services. {0}, {1} and so on will be replaced by parameters, in order, as for previous field.",
        "group": "TTS Server"
    },
    "tts_audio_format": {
        "type": "textbox",
        "value": ".mp3",
        "label": "Audio format",
        "tooltip": "Audio file extention generated by TTS service.",
        "group": "TTS Server"
    }
}