Skip to content

CONFIGURATION.md

Latest commit

 

History

History
105 lines (93 loc) · 3.62 KB

CONFIGURATION.md

File metadata and controls

105 lines (93 loc) · 3.62 KB

Configuration

This documentation covers configurations files in configs/ directory, and its entries.

📄 general.json

It serves every common configurations, or configurations which haven't assigned dedicated file.
Example file is located at general.json.example.

  • version: Config Version Identifier
    • Required
    • Must be 1
  • discord.token: Token of the bot
  • discord.inviteLink: Invite link to the bot
    • Optional
    • Currently, does nothing.
  • status: Status message of the bot
    • Optional
    • Disabled when not set.
  • discord.archiveDuration: Duration until thread gets archived
    • Optional
    • Unit: Minute
    • Defaults to 60 minutes.
  • log.timeLimit: Time limit until log gets rotated.
    • Optional
    • Unit: Hour
    • Disabled when not set.
  • log.sizeLimit: File size limit until log gets rotated.
    • Optional
    • Unit: KB
    • Disabled when not set.
  • defaultLocale: Default locale to used by bot
    • Required
    • Used when failed to fetch locale from guild or user.
    • List of available locales are in this documentation.
  • cooldown: Cooldown to set in thread
    • Optional
    • Unit: second
    • Disabled when not set.
  • inactiveTimeout: Duration until bot disconnects from Voice due to inactivity
    • Optional
    • Unit: second
    • Disabled when not set.

📄 tts.json

It serves every configuration relative to Text-to-Speech.
Some of the options can be overriden by guild settings.
Example file is located at tts.json.example.

  • version: Config Version Identifier
    • Required
    • Must be 1
  • gender: Gender of the voice
    • Optional
    • Available values are:
      • female
      • male
      • neutral
    • Defaults to neutral.
  • pitch: Pitch of the voice
    • Optional
    • Any integer between 0 ~ 200 is available.
    • Defaults to 100.
    • Unit: %
  • speed: Speed of the voice
    • Optional
    • Any integer between 0 ~ 200 is available.
    • Defaults to 100.
    • Unit: %
  • volume: Volume of the voice
    • Optional
    • Any integer between 50 ~ 200 is available.
    • Defaults to 100.
    • Unit: %
  • allowSSML: Allow SSML to be used from chat
    • Optional
    • Defaults to false.
    • Currently, does nothing.
  • provider: Text-to-Speech provider to use
    • Required
    • Must specify one of providers below.
    • GoogleCloud is the only available provider currently.
  • providerOptions.GoogleCloud.preferredTypes: Priority of the voice type to use
    • Required
    • Must be specified as the array.
    • You can start by using one in example, and removing the type you don't want to use.
    • Additional Description: Neural2 part of en-US-Neural2-C.
  • providerOptions.GoogleCloud.defaultVariant: Variant of the voice to priotize
    • Optional
    • Uses first variant returned by API when not specified.
    • Additional Description: C part of en-US-Neural2-C.

📄 gcp-credentials.json

📌 Note: You don't need this file if you're using Workload Identity Federation as authentication method.

This is your Google Cloud Platform credentials file.
It is required if you're using Google Cloud Text-to-Speech as provider, and using Service Account Key to authenticate.

Follow this guide to create service account key or download a created service account key, rename it as gcp-credentials.json, and place it into configs/ directory.

Application will refuse to launch without it.