Steps to follow in order to install RITA

1. Check that your discord account is the owner of the server or an admin of the server you want RITA Bot in

2. Join RITA's discord server with this Discord account

3. Subscribe to RITA in Patreon (need email to be verified)

4. Link your Patreon account to your discord account

5. Invite RITA in your discord server : https://ritabot.gg/invite

6. With the same discord account, go into your Discord server and run !tr sub in any of your discord server channels to activate your RITA plan.

7. Now you can Personalize your RITA's setting and translate a Discord chanel into another one with serveral commands. Most common use is by running !tr groupand following the instructions displayed

Quick setup steps FAQ

Prefix and Commands

The bot’s default prefix is !tr, or !translate - All commands must start with this prefix for the bot to process them.

Command structure

[prefix] + [main command] + [parameters]

For Example:

!translate help modules

!tr help modules

!tr help

Automatically translates any new messages in the current channel and forwards them to the target channel. Admins/mods can set forwarding to the same channel(not recommended) or other channels(recommended).

Please note that when you setup an auto command the target channel will not send back to main channel unless you tell it to

Command

!tr channel from [lang] to [lang] for #[dest]

!tr auto to [lang] for #[same channel dest]

!tr channel from [lang] to [lang] for #[dest] filter @[role]

Parameters

• for [dest] The target channel you want the translation of the from [lang] to go to.

• to [lang] (optional) The language to translate to, defaults to server default language if none provided.

• from [lang] The language to translate from.

• filter [role] can be used to restriction translation to a specific role.

• NOTE : Auto is for a single ( same channel ) translations, as photos, and Gifs, will not be duplicated or sent.

Examples

Using full language names

!tr channel from english to spanish for #target-channel

!tr auto to spanish for #current-channel

Using language short codes

!tr channel from en to es for #target-channel

!tr auto to es for #current-channel

Using Auto detection

!tr auto to ru for #current-channel

Server Admins/Mods

Send translations to same channel ( Not recommended for more than 3 languages )

!tr channel from english to spanish for #current-channel

!tr auto to spanish for #current-channel

Send translations to another channel in server ( Recommended )

!tr channel from english to spanish for #target-channel

!tr channel from english to spanish for #target-channel

!tr auto to spanish for #current-channel

Send translations to multiple channels in the server at once

!tr channel from english to spanish for #target-channel-es1, #target-channel-es2, #target-channel-es3, #target-channel-es4

!tr channel from english to spanish for #target-channel-es1, #target-channel-es2, #target-channel-es3, #target-channel-es4

Stopping Translations

To stop an automatic translation task, simply go the origin channel of the task and use the stop command:

!tr stop

!tr stop task [id!tr stop for [me]

!tr for [@user]

!tr stop for [#channel]

!tr stop for [all]

!tr stop for [server]

Parameters

• [id], ID number for the task you want to stop, run !tr tasks to get id.

• for [me] - Stops translations via DM to yourself.

• for [@user] - Stops the task for user.

• for [channel] - Stops the task from the channel posted to the channel destination.

• for [all] - Stops all translations in the channel its posted in.

• for [server] - Stops all translations being done in your server.

Admins/Mods

Stop all automatic translations

!tr stop task [ID]

Stop a single task by running !tr task, and taking note of the ID of the item to remove.

!tr stop for [@UserID]

Stop a translation being sent to a user.

!tr stop for #target-channel

Stop all automatic translations for specific channel in server

!tr stop for all

Stop all automatic translations for the channel.

!tr stop for server

Stop all tasks in the server.

Help command for stop: !translate help stop

Notes

Help command for automatic translation: !translate help auto.

• Values wrapped in brackets [ ] are solely for illustrative purposes to demonstrate the use of the command. Brackets are not in any command.

[lang] values can be language names in English, native language names or ISO 639-1 codes. For example, german de and deutsch will all work the same.

• Messages by all bots are currently ignored to avoid loops, but we are working on different bot modes to enable bot translation.

  • Any message that begins with !tr or !translate will be determined to be a bot command and thus shall not be allowed to be translated.

The Owners

Artanis - CDO

I'm Artanis, the resident geek on the team. When I'm not procrastinating or playing video games (including Starcraft of course), I train and manage our Machine Learning API and models. I'm curious person at heart, and always love to learn about new things. I taught myself to code in Node as a 13 year old (at the beginning of Rita), and have since expanded to Python, Typescript, and some scripting languages such as AutoHotKey for some gaming side projects. I'll be the one to disappear into random projects only to leave them unfinished.

Jupiter - CCO

He looks sometimes like if he was not born in earth, but he's nice too

JShep89 - CHRO

The funny one (when he forget he's an HR ).

Always thinking about improvement of bot from user-ends, he will always listen to your feedbacks (even if he hates writing)

Zycore - CFO

The one who doesn't want to fill this section

He's shy but not that much.

Development & Core Staff

Support Staff

Community Helpers

!tr stats - Shows a summary of the Global & Server stats.

!tr stats sub - View character usage for your subscription, and other information.

!tr stats global - Shows a summary of Global stats, all the servers the bot is currently on.

!tr stats server - Shows a summary of the Server stats.

!tr proc - Shows the processor usage, CPU, Ram and Uptime of the bot.

!tr shards- Shows the number of shards the bot is running on.

Important Note

The bot’s default prefix is !tr (or !translate) - All commands must start with this prefix for the bot to process them. Bot must have proper permissions in all relevant channels for full functionality (read, write, react, mention, attachments, embed).

Users who wish to receive automatic translations in private must enable DMs via server privacy settings.

Help

!tr help - Shows RITA's help menu for all help commands.

!tr help modules - Shows RITA's help menu for all modules.

!tr help commands - Shows RITA's help examples for common commands. Such as Translation Commands, Information Commands, Style Commands, Misc Commands, and Debug Commands.

!tr help [command] - Give usage info for each command.

Example: !tr help last - will open the help menu for the command last.

Links

!tr invite - Creates an invite link for the bot so other can use it, i would not recommend using this command.

Supported Languages

!tr list - Lists all supported languages the bot can use.

Version

!tr version - Shows the current version of the bot.

!tr history - Shows list of previous bot versions.

!tr history [version] - show all the revisions made to the designated version.

Parameters

** [version]** - Version number.

Tasks

!tr tasks - Lists all current translation tasks for the channel the command is used in. This command is very useful to check what tasks you have currently set in a channel as well as easily identify if you've created an invalid translation tasks.

Donate

!tr donate oc - Donation link for open Collective.

!tr donate github - Donation link for GitHub.

Prefix

!tr prefix [prefix] - Sets custom bot prefix

parameters

** [prefix] - custom prefix**

ID Info

!tr id - Shows various ID info

Important Note

The bot’s default prefix is !tr (or !translate) - All commands must start with this prefix for the bot to process them. Bot must have proper permissions in all relevant channels for full functionality (read, write, react, mention, attachments, embed).

Users who wish to receive automatic translations in private must enable DMs via server privacy settings.

Command

!tr this: [msg] - Translates to default server language

!tr this to [lang]: [msg] - detects language and translates to your to langugae

Parameters

• to [lang] - Defaults to server default language

• to [lang, lang, ...] - Translates to multiple languages

• from [lang] - Defaults to automatic detection

Examples

!tr this: bonjour

!tr this to spanish: hello world

!tr this to arabic, hebrew: I love you

!tr this to de from en: how are you?

Translates last message chain(s) in channel. A chain is a collection of messages by the same author, to keep things simple.

Commands

!tr last

!tr last [n] to [lang] from [lang]

Parameters

• to [lang] - Defaults to server default language

• to [lang, lang, ...] - Translates to multiple languages

• from [lang] - Defaults to automatic detection

• [n] - Number of chains to translate, default is 1

• [-n] - Negative number means only one chain is translated

Examples

!tr last 2

!tr last to english

!tr last to english, german, french

!tr last -6 to english from german

This project was originally released by Aziz under the MIT license. He chose to take the project private/commercial at version 0.4.2 Beta. Bobby Johnson forked the project and renamed it Louie after his dog. AlooAkbar forked Louie and added the necessary modifications for simple and free deployment of the bot using Heroku. RitaBot-Project Picked up the fork and as part of a team fixed over 200 errors and brought it in to the modern age, All would like to thank Aziz for his hard work and making these early versions OSS so that others may learn and build on his hard work to share with the community.

Copyright (c) 2019 RITA

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2017 Aziz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Groups channels using Automatic Channel Translation in a simple, easy-to-manage manner.

Command

• !tr group ⬅ create new channel group

  • Respond with new group name, number of channels that should be in group, and for each channel prompt respond with channel language and ping which channel to assign

• !tr group link [GROUPNAME] ⬅ link a new channel into group

  • Respond to prompts by pinging which channel to add and what language to assign to that channel

• !tr group unlink [GROUPNAME] ⬅ delete a channel from group, opposite of group link

• !tr group delete [GROUPNAME] ⬅ delete entirety of group

• !tr group list ⬅ list all groups present in guild

Parameters

• [GROUPNAME] refers to the group name you give to the group (can check groups with !tr group list)

Examples

Group Creation

Group List

Group Link

Group Unlink

Group Delete

Notes

• There is a max of 10 channels/languages per group

• Groups cannot have repeats of languages or channels. All added channels and langs must be unique and not already in the group

• Languages should be in their ISO-639-1 format, list can be found here

Important Note

The bot’s default prefix is !tr (or !translate) - All commands must start with this prefix for the bot to process them. Bot must have proper permissions in all relevant channels for full functionality (read, write, react, mention, attachments, embed).

Users who wish to receive automatic translations in private must enable DMs via server privacy settings.

These commands are available only to admins.

Current-server-settings

This command will display a printout of your current server settings.

!tr settings

Set custom Bot Prefix

This command will allow you to set a custom prefix for RITA in your server.

!tr prefix [prefix]

!translate prefix [prefix]

Developer Announcement Messages

This command will turn off messages from the Development team.

!tr announce [on/off]

Embedded Message Style

This command will allow you to use either embed or webhook translation Styles.

!tr embed [on/off]

!tr help embed

This is embed style: This is webhook style:

Language Detection

This command will add a source Language marker to the translated text.

!tr settings langdetect [on/off]

Bot to Bot Translation Status

This command will allow RITA to translate messages from most bots

!tr bot2bot [on/off]

!tr help bot2bot

Tags(everyone, here and user)

This command will allow you to disable RITAs ability to use the everyone, here and user tags when using Webhook translation style.

!tr settings tags [Parameter]

Parameters

none - RITA won't ignore any mentions

everyone - RITA will ignore everyone and here tags

all - RITA will ignore all mentions

Reaction Translations

This command will turn off the ability to translate a message with Country flags.

!tr react [on/off]

Auto Deletion Commands

These commands are to enable/disable various auto delete functions.

!tr settings menupersist [on/off]

!tr settings reactpersist [on/off]

!tr settings flagpersist [on/off]

Webhook Debug Active State

This command will allow you to turn on debugging for RITA related errors in your server.

!tr debug [on/off]

!tr help debug

Reset All Settings

This command will reset all Settings to their default setting.

!tr settings reset

About Subscribing

In order to subscribe to RitaBot, you must be on our Discord Server. Subscriptions are role-based, meaning that Rita updates subscriptions based on which roles you have been given by the payment platform (which tier you have bought). If you leave the server, Rita will cancel your subscription at the end of a one-month period from the last subscription date, even if your subscription is still active.

Maintenance and Uptime

There may be times RitaBot ceases to function, in which the procedure for us will be to verify the problem and fix it as soon as possible. We are not responsible for any issues this may cause.

Furthermore, there may be times of maintenance in order to improve and exceed Rita's capabilities. In line with our Refund Policy, We aim for a service uptime of >80% (24 Days in a rolling 30-day period) of core functionality.

Servers

Currently, only the server owner or admin can buy a subscription for a server. Furthermore, only one server can be activated with your subscription at a time. This will be liable to change in the future as time goes on.

How to Activate?

To activate your subscription after you have paired your Discord Account to your payment, you must run the !tr sub command in the #activate-rita-here channel in our Discord Server, after you do so follow the prompts to activate your subscription for the specific server.

Soft Limit

In order to provide a virtually "unlimited" pricing model, we've incorporated soft limits into Rita. Essentially, each tier has X amount of chars per month that will be translated with Google. Meanwhile, all other translations will use our own Neural Machine Translation server.

Quality

• While we are working hard to make our own translations as seemingless as ever, Google translations will be similar/better than ML translations simply due to Google's resources

  • We are working to provide clarifying examples of quality for language pairs to be as clear as possible

Limits

• To clarify; all tiers are still unlimited character wise.

  • The only difference shall be if you've used more than the soft limit for your tier in a month, then all other translations will use our ML until month is reset.

What do I get with each plan?

The only difference between our plans at the moment, and for the foreseeable future is the task limit that you are restricted to. If this changes however we will let you know, You won't lose access to anything you don't already have.

What is a task?

A task is a singular channel setup for automatic channel translation. Tasks are simply the setup, not the usage. For example; 1 channel translating from English to French counts as a task. As you add more languages to an interconnected language setup, the task utilization increases exponentially.

You can calculate how many tasks you use for each channel by using the amount of languages (including source) you want to have for that channel in the equation x * (x-1)

• Reaction translation, utilisation of tasks, or anything else do not count towards task count

  • Only the group , auto , and channel commands contribute to task count

!tr react [on/off]

!tr settings reactpersist [on/off]

!tr settings flagpersist [on/off]

react - [on/off] disabes the ablity to use flag reactions to translate.

reactpersist - [on/off] removes the translation after 60 seconds

flagpersist - [on/off] removes the flag.

• Recommended to use reactpersist and flagpersist together.

Translates a message in the server when you react to it with a flag emoji.

The full Supported list can be found below

What is Patreon

On Patreon, you can let your fans become active participants in the work they love by offering them a monthly membership. You give them access to exclusive content, community, and insight into your creative process. In exchange, you get the freedom to do your best work, and the stability you need to build an independent creative career.

How to Subscribe

• Navigate to Patreon

• Select the plan that you wish to use by pressing Join

• If you have an account with Patreon already, please select Log-In from the bottom of the page.

• If you don't have an account, You can Sign up with Google or Facebook or you can fill in the form and select Sign Up when you are done

• For those creating new accounts. Confirm your Country of Residence

• NOTE: DON'T FORGET TO VERIFY YOUR EMAIL

• For those paying with a card, Select that option and fill out your details to process your payment.

Selecting Pay with Card will then process through and you will receive a confirmation by email.

• For those paying with PayPal, select this option, and then Pay with PayPal. You can then sign into PayPal.

• Once you have signed in, confirm your payment method and then Agree and Continue

As soon as you select continue as per the previous step, the payment will process and you will get a confirmation on screen that you were sucessful.

You can now link your Discord account to your patron. Scroll down until you see Connect to Discord. You can then sign in to discord and receive your roles.

Linking/Creating an Account - Before & After

Now you have a subscription with RITA, you can link your discord to get Roles. To do this either select Connect to Discord on the confirmation page, or go to your profile:

• Profile > Edit Profile > Connected Apps

• Select Connect on the Discord option

• Sign in as you normally would. Then select Authorise to confirm

Cancelling a Subscription

To cancel a subscription, you will need to do this from within Pateon.

• Sign into Patron

• Navigate to your profile Menu

• Select Manage Memberships

• Locate RITA under Active Memberships

• Select Edit for the RITA membership

• Select Edit for Cancel Membership

• Select the Cancel your Membership option

• Select the black Cancel your Membership button to confirm

Your membership will now be cancelled subject to Pro-Rata. This means your membership will end at the end of the month you paid for. If you have any issues or concerns, please open a ticket in the RITA Management Server.

Please review our S.A.L.T.S Policy for more information on Availability, Limitations and Restrictions.

For support, please visit us at our If you wish to email us about payments, please use

What is RITA and who are we?

RITA is the culmination of many things, it started with a mobile game, a community of gamers, a discord server of different languages and a desire to all be understood. She is a Real-Time Translator Bot for use on Discord. She is maintained by a small group of users (that have a real life and a job), each with different backgrounds and some learning as we go. You want to learn more about Rita and what she does ? Just take a loot at the .

Why did you make Rita?

The mobile game itself would get old, fast. The community around it, however, is what kept us going. The one downside was we did not all speak the same language. The game we played translated our conversations for us, but Discord did not, so the server admins used a translation bot called C-3P0. This introduction is the start of the story.

The history of Rita?

There are loads of different translation bots out there, some are amazing, some are expensive, some are free but have limits, and others are just rubbish. C-3P0 checked all these boxes.

Originally called discord-translator and made by Aziz, then forked By NotMyself and renamed Louie, forked again By AlooAkbar and renamed C-3P0, its code was neglected, not maintained, left outdated and iterations made private for commercial gains.

Why RITA and what does it stand for?

I and a group of fellow C-3P0 users decided that collectively we could do better, plagued with crashes, API changes, relentless bugs and issues, the drive to make something better was born.

Rita’s history and various iterations each added something extra, it just needed to be brought together and molded, molded into something amazing, molded into Rita. The Real-Time Interchangeable Translating Assistant.

Then we provided for a few time a self-hosted version before making the actual version of Unified Rita as it was impossible for everyone to request the google API, to maintain all codes, to help everyone with his particular settings. And moreover, self hosting would not answer to an easy installation with an invite link. Also code was not already used in a good way (meaning, taking some code in order to add it in some exepensive ones).

There you have it, the story, dramatized and electrified for effect, but all true, of how RITA was born.

Major Changes

• Environment changes - MESSAGE_DEBUG - For servers that want to show debug message content to find out what pesky message is causing that error, set this to 1. By Default it is 0. Rita global bot is also 0 and will remain that way.

Bug Fixes

• With the changes to the google-translate-api it dug up a load of new bugs, Lazarus & EDW have been hard at work fixing them, (DM Lazarus to say thank you, he will love it.)

• @everyone & @here will now also be conveyed across channels correctly.

• Emojis, roles and user pings will now function as intended. With a new system used to manage and correct them

Command Changes

• !tr stats global / !tr stats server now show message based stats, take a look.

Database Changes

• It working so were not going to touch it. (Well Zycore wont)

Misc Changes

• Zycore broke something (alot of times) Zycore fixed it again.

• All debug messages have been commented out in all files, This make the console log look so much cleaner.

Major Changes

Dev only Command handler has been added in to enable fast changes to command restrictions.

Bug Fixes

• Lots of little things, nothing of consequence.

Command Changes

• !tr history shows Development History of the bot.

• !tr stats server [ServerID] shows stats for the targets server.

• !tr blacklist [ServerID] Blacklists a server (Developers Only).

• !tr unblacklist [ServerID] un-Blacklists a server (Developers Only).

• !tr warn [ServerID] Warns a server (Developers Only).

• !tr unwarn [ServerID] un-Warns a server (Developers Only).

• !tr eject [ServerID] Removes RITA from the target server (Developers Only).

• !tr check [ServerID] Checks Warn & Blacklist status of the given server.

• !tr checkperms [bot/user] checks permissions of the bot and the user for RITA compatibility.

Database Changes

• A new column has been added to manage blacklisting and Warning, backwards compatible to all previous versions.

Misc. Changes

• Once again Zycore broke something (a lot of times) Zycore fixed it again.

• Help muenus update with new commands.

• Help menus has been reworked, Still a work in progress but they look much better now.

Change Log

• No Code changes, just URL updates for New name of Bot

• Published to NPM

• Non code changes will be appended with Version-** from now on.

• Various Spelling mistakes in ReadMe have been corrected.

• Dev Dependencies core to this bot, the google-translate-api & google-translate-token have been updated

• Setup on a Raspberry Pi instruction Section added.

• gulp-watch updated dependencies. (Moved to Local Repo as it was out-of-date and full of Security Issues.)

• Patch for Chinese language support.

• Various Security vulnerabilities fixed.

• Various commands re-activated.

Change Log

• New commands added (embed, bot2bot, settings updatedb)

  • embed command allows you to change the type of message that is sent to the translation channel, in embed format or standard text. Standard text shows the users avatar and name instead of the bot.

  • bot2bot allows for messages sent from other bots, in non embedded format to be translated as well. (Due to limitation this has been implimented but is disabled for now)

  • As the new variables above are stored in the DB, they need new Columns to be added, as such updatedb will complete these actions.

• Major code changes, new code implementations will change the DB and produce errors on first build, but this is a safe version to update to. Follow the below instructions.

  • Step 1: Make a pull request and update from Master branch.

    • Once you update the bot and it initializes you WILL get a db error, this is normal. (we are working on suppressing these)

  • Step 2: !t settings updatedb

    • This will throw another error but it will build the missing columns.

    • The default value for embed is on and botbot is off.

    • Running this multiple times will cause error to be posted to webhook chan, this is a "Value exists" error. Preventing you from destroying the DB

  • Step 3: Completed, and now working.

    • Once you have completed Step 2, the bot will have come online, but it wont have fully Initialised.

    • To prevent a never ending loop of errors, the VERY FIRST message or command sent on the server will Initialise the DB fully. Meaning you will have to send that message again.

      • Please Note Due to Automatic dyno restarts the first message after each restart will share the same behaviour as above.

• Added in command triggers and command deletion to clean up command channels.

• Custom Emoji's are now supported and will be sent with the translated message correctly, with the exception of a few languages.

• DM Translation have been disabled as it has been identified they never worked as intended. they will be re-introduced in a later update.

• Various Security vulnerabilities fixed.

• Dev Dependencies core to this bot, the google-translate-api & google-translate-token & gulp-watchhave been updated

• eslint has been replaced with babel-eslint

• !t settings updatebot Has been DISABLED - This is not needed as of yet and with the similarities to the !t settings updatedb command it may cause issues.

• Deploy with Heroku Setup and integration.

Major Changes

• db.js has had a overhaul

• Database has been migrated to a larger DB, We wont be needing to do that again for a good 5 years.

Bug Fixes

• Color now working in Embed on and takes user role color.

• Stop command for @user has now been fixed

Command Changes

• Welcome message added for all new servers. System Channel is default, if not available it will pick first channel that has Write permissions.

• Announcement command added, This is Restreicted to DEV ONLY.

• Opt in and out commands added for announcements.

• !tr settings persist [on/off] command has been added, this will prevent bot responses from being deleted.

Database Changes

• Validation Checks added at startup to avoid Blacklist and Stats SQL Errors

Misc. Changes

• New Debug Settings for console.

• MESSAGE_DEBUG

  • 0 - Error's Only

  • 1 - Console for all Messages

  • 2 - Console for Translate Messages only

  • 3 - Content of all Messages

  • 4 - Content of Translate Messages only

  • 5 - Commands Only