Translation

Communicate in your multilingual server with ease!

This module is only available to users with a Premium Subscription.

The Translation module allows you to translate texts via a Custom Command, quick-translations by reacting with a specified emoji, daily translation limits, and more!

Credentials

The Translation module requires you to add your own DeepL API key in order to handle translations, allowing you to select the account tier and the daily translations limit.

To create an API key, follow the steps below.

1

Create an account or log in the official DeepL website.

2

Select the tier you wish to use for your translations, whether it is the Free Tier or Paid Tiers. If you wish to have the free tier, please select 'Sign up for free'.

DeepL Tiers for the Translation module

3

Fulfill the following details. This is used to avoid potential misuses of their free API. DeepL will not charge you unless you manually upgrade your current subscription to a paid one.

DeepL Details for the Translation module

4

Once you have successfully fulfilled all the details, accept DeepL's Terms & Conditions and press 'Sign up for free'.

5

A similar page will appear upon signing up for free, click on 'Account management' to go to your account settings. If this page does not appear, please go to your account settings.

DeepL Account Management for the Translation module

6

Get the Authentication Key for DeepL in your account summary settings located in the bottom right corner.

Authentication Key for DeepL API for the Translation module

7

Once copied, paste it in the 'DeepL API Key' field in BotGhost.

Settings

Credentials

This section is where you input the API Key found from Credentials and also change other account settings.

DeepL API Key

Paste your DeepL API Key here. Learn how to get one in the Credentialssection. Make sure to not share it with anyone!

DeepL Account Tier

Set the account tier you selected when getting your API key. Remember to select the correct one as DeepL handles different API domains for free and paid tiers.

Daily Translation Limit

Define the maximum amount of translations that can be executed per day. Setting this to 0 will disable this limit.

Quick-Translation

The following parameters allow you to react with a specific emoji to automatically translate the content of the message, select the channels for quick translations, the required roles, the target language, and toggle if you wish to delete the original message upon successful translation.

Trigger Reactions

Select up to 10 different emojis to trigger the quick-translations.

Quick-Translation Channels

Choose the channels you wish to allow for quick-translation. If none is chosen, this feature will be available across all channels.

Required Roles

Select the roles that will require users with these roles to be the ones to use the quick translation.

Target Language

Define which language should the messages be translated to when triggering the quick-translations.

Delete Original Message

Enable or disable to delete the original message after a successful quick-translation.

Translate Command

Define the allowed roles and the default DeepL language when using the /translate custom command.

Allowed Roles

Select the roles that users must have to run the /translation custom command.

Default Language (DeepL)

Choose the language to translate messages to when using the custom command.

Translation Command Reply

Customize the reply in the /translate custom command. You can use {original_message} and {translated_message} to return the content of the original message and the translated content, respectively. All variables can be used. You can also toggle the embed to a plain text response using the switch in the top right.

Character Limit

Define the maximum amount of characters the command should allow to translate.

---

Command

Find the command for the Translation module and modify them. This will allow you to fine-tune the command's logic to your liking.

Custom Command for the Translation module

/translate

Translate the given text to the target language.

Events

Explore the events within the Translation module and customize them to your preferences. This allows you to change the events' logic according to your liking and needs.

Custom Events for the Translation module

Quick-Translation

This event handles the quick-translations, triggered with each reaction added to a message.

Daily Limit Handler

The timed event triggered daily to handle the daily limits.

---

It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended.

Additionally, a copy of the edited commands / events will be created if you update the module.