RitaBot Discord Translator

RitaBot is a fast, automatic Discord Translating Bot. Allowing communication across the language barrier from features like automatic-channel translation, to flag reaction translations and many more.

Rita was created because of a drive to communicate with others. Chatting platforms are awesome things and allow fast & simple communication across the entire world. However, something as simple as translating messages for others to understand can become so complicated. Across the internet, there are hundreds of translation bots but a flaw in many of them is increasing costs, changing features & overall difficulty to use.

This is where RitaBot came in. Many bots feature translations which are pricey due to hosting costs & translation costs. Rita, however, is an affordable bot & getting translations straight from the Google Translation API.

In this documentation, we'll teach you the functionalities and abilities of RitaBot

Things you can do with Rita

• 🗣️ Speak with others across multiple channels using the /group command.

• 🪝 Use webhooks to send translations in a beautiful, user-like manner.

• 🇺🇸 🇫🇷 🇪🇸 Use flag reactions to translate any message. Simply add a reaction of the country of your choice and a translation will pop up with the languages of that country.

• 💪 The most powerful Translator Bot. Providing fast, automatic translation to thousands.

• ❤ Made with love by the Rita Dev Team

How much does it cost?

In order to pay for translations, for both Google's API and our own Machine Learning API, RITA makes use of a subscriptions with given tiers.

The overview here explains further, and you can see how much it costs on the Dashboard or by reading Avalaible Plans

How to intall ?

To install, you can follow the guide Quick setup steps

The Owners

Development & Core Staff

Bot & Community Helpers

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. Invite RITA in your discord server : https://ritabot.gg/invite

3. Subscribe to a RITA plan through dashboard : https://dashboard.ritabot.gg/

4. On dashboard, select the server you want to link to the subscription you've just took

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 /group createand following the instructions displayed

With the release of Version 1.3.0, we introduced the new /quicksetup command to simplify the entire server setup process.

This command automatically handles the creation of the required group, channels, permissions, and access controls for you. To complete the setup, it also configures a reaction role system, allowing users to grant themselves access to the newly created channels.

Whether you're setting up Rita for the first time or creating additional translation groups, /quicksetup provides the fastest and easiest way to get started.

Setup FAQ

Slash Command

/reward balance

!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.

For support, please visit us at our Discord Server If you wish to email us about payments, please use Payments@ritabot.gg

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 introduction page.

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.

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.

Inital Release

### 1.3.12-0
Date: 30/10/22
User: Qjuh
> ----------
>>> auto.js, send.js
* Added support for stickers being sent as attachments for cross-channel translation tasks
* Added the error log for empty message again, as it should be fixed now

>>> translate.js
* Fixed translation throwing empty message errors in blockChain mode

>>> events.js
* Fixed joining of Threads to only try threads we didn't join yet

Wait, what, I've missed something?

If you have not been following our announcement channel, or have not read our previous Update; we would advise you to do this. It will answer most of your questions.

For further information check out FAQ or join our support server.

How do I Subscribe?

You can do this in a few ways. You can purchase from Ko-Fi or Patreon. For info and step by step guide check this out.

I've Subscribed, Now what?

Head to #active-rita-here and type `!tr sub` to get started... What are you waiting for?.

Something has gone wrong, it didn't work!

If you cant see the Subscription category in the Support server, you can't access the #active-rita-here channel, or something went wrong then please #open-a-ticket and we will assist you ASAP.

RITA Rewards is our loyalty programme designed to thank subscribers for supporting the continued development and operation of RITA.

Every month you remain subscribed, you'll earn Reward Points based on your subscription tier. These points can then be redeemed for subscription discounts or used to generate a one-month gift subscription for a friend.

Unlike traditional promotional offers that are only available during special events, RITA Rewards is designed to provide ongoing value to every subscriber, rewarding loyalty and long-term support.

Why Did We Create RITA Rewards?

RITA has grown significantly over the years thanks to the support of our community. Many subscribers have remained with us for months, and in some cases years, helping us continue to develop new features, improve translations, expand language support, and maintain the infrastructure required to keep RITA running.

We wanted a way to recognise that commitment.

RITA Rewards was created to:

• Thank subscribers for their continued support.

• Reward long-term loyalty.

• Provide additional value beyond the subscription itself.

• Give subscribers a simple way to share RITA with friends.

Most importantly, we wanted to ensure that the longer someone supports RITA, the more they benefit from doing so.

Getting Started

Reward Points are awarded automatically whenever a subscription payment is processed.

You can view your current points balance, available rewards, active reward codes, and redemption history at any time using the /reward command.

Reward Points can currently be redeemed for discount codes ranging from 25% to 100% off a subscription, or for a one-month gift subscription code for a new user.

Commands and prefix

You can use discord slash commands to interact with the bot (recommanded and more user friendly).

If you want to use legacy features, bot’s default prefix is !tr, or !translate - All commands must start with this prefix for the bot to process them.

Legacy command structure

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

For Example:

!translate help modules

!tr help modules

!tr help

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.

Inital Release

V-1

### 1.3.20-1
Date: 8/12/22
User: Zycore
> ----------
>>> translate.js
* Removed console log messages
* Removed message.type variable created in 1.3.20-0 as it was only for testing.
* Minor change to char counters

>>> stats.js
* Added Global total for ml and google
* Added server total for ml and google

>>> misc.js
* Added char values
* Added engine value

Inital Release

V-1

V-2

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

Inital Release

### 1.3.18-0
Date: 24/11/22
User: Qjuh
> ----------
>>> shard.js, commands.js
* New command `!tr shard restart {shardId}` to restart a specific shard

>>> misc.js
* Fixed `!tr shards` to list shard ids starting from 1 instead of 0 to be in line with `!tr check` and `!tr proc`

V-1

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.

Inital Release

V-1

V-2

V-3

V-4

Inital Release

### 1.3.10.0
Date: 27/10/22
User: Zycore
> ----------
>>> permission.js
* new file, playing around with BitField

>>> events.js
* saved supportguild to client, but im not sure if this will run every action and thus leak or if it will only store once.

>>> message.js
* if a command is run, then the BitField value is added ot data.BitField

>>> misc.js, args.js
* Test command

Inital Release

### 1.3.17-0
Date: 21/11/22
User: Qjuh
> ----------
>>> commands.js
* New file for checking command permissions, sub-only commands, tier-restricted commands and potentially more
* Moved list of commands from args.js to commands.js

>>> args.js
* Calls commands.js to determine what function to call

>>> permissions.js, auth.js
* Added auth.helperID and use it to populate the BitField with BotHelper value
* Fixed GuildAdmin using BitField value of GlobalChanManager by accident

Slash Command

/reward gift

Once a code has been generated, you will be given the following output.

You must provide the discount code to the intended recipient, the code will be valid for 30 days, and can only be used once. The message is not a public responce so other can not see it, so you must share it.

If the message is removed or deleted, you can get the code again by typing /reward history

FAQ

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

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

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.

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?

Major Changes

• Sharding is now automatic, this should auto scale to the needed amount.

• A Major memory leak causing rita to restart every few hours has now been fixed.

Bug Fixes

• !tr announce on/off has been fixed.

• !tr settings has been unrestricted.

• !tr blacklist {ServerID} has been fixed.

• !tr channel from {lang} to {lang} no longer defaults to a DM task.

Command Changes

• !tr react on/off now turns on and off flag reactions.

Database Changes

• Added in 3 new columns ready for auto-warn and eject management

  Servers will be allowed 10 Permission Errors Before a Warning

  Server will be given a Maximum of 3 Warning before they are Ejected

  If your server should be Ejected a second time it will be blacklisted

Misc. Changes

• Sooooooo Many spelling mistakes corrected that it would be too many to list here.

• Help Menu updated with new commands.

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.

Inital Release

V-1

V-2

The following explains new additions to our newest release of Rita (v.1.4.1) which will be released in the coming days/weeks

New soft limitations

Will accuracy be affected?

Important changes to Privacy Policy

How can I increase Google character limit?

Issues with ML

Soft limits

Ex. You use 700k characters next month with the "Casual" plan (100 tasks) - 200k of that would use google, and the other 500k characters are translated with ML. Then on renewal date, the character count resets. If you have any questions or concerns, feel free to open-a-ticket As always, thank you for using RitaBot and supporting us, - The RitaBot Team

Inital Release

### 1.3.15-0
Date: 13/11/22
User: Qjuh
> ----------
>>> db.js
* added subscriptions to server_obj
* refactored building of server_obj to do three seperate loops for servers, stats and subscriptions instead of nested loops
* removed global property from server_obj as it's not used anymore
* removed .paused from `server_obj[].servers` as its now accessible from subscriptions directly
* changed `updatePaused()` to only update subscriptions and not servers anymore (see above)

>>> translate.react.js, translate.js, message.js
* Removed mentions of `server_obj.global`

>>> translate.react.js, pause.js, message.js, slashcommand.js
* Moved .paused check from `server_obj[].servers` to `server_obj[].subscriptions`

>>> send.js
* Refined check for empty message error to not apply for stickers/attachments sent in same channel translations

Inital Release

V-1

V-2

Inital Release

### 1.3.11-0
Date: 30/10/22
User: Qjuh
> ----------
>>> check.js (both /commands and /slashcommands)
* Added whitelist status and applications.commands scope to bot/server check
* Implemented `/check channel` and `!tr check channel` command

>>> pause.js
* Fixed display of paused servers

>>> auto.js
* Fixed ForumChannels translating although env var is not set

>>> db.js
* Fixed paused status getting set to false although subscription has a value of true

>>> interaction.reply.js
* Fixed usage of editReply if reply was deferred before

>>> send.js
* Commented logging of empty message errors because they're annoying atm and we know the reason

>>> slashcommands/settings.js
* Fixed usage of servers table from server_obj in `/settings show` command

Inital Release

### 1.3.28-0
Date: 09/03/23
User: Artanis, Qjuh
> ----------
>>> Core Code Files
* Refactoring of variables for `getInfo`
* Edit translation incorporated using ML
* Fixed a embed off bug

V-1

Inital Release

V-1

### 1.3.7-1
Date: 19/10/22
User: Qjuh
> ----------
>>> translate.js
* Fixed `catch` statement in `sendData` function

Inital Release

### 1.3.21-0
Date: 8/12/22
User: Zycore
> ----------
>>> db.js
* Created case 
    db.updateTable (action, id, columnName, value, _cb)
        action = (server, stats, reset)
    db.increaseCount (action, column, id)
        action = (server, stats)
    db.sumCharUsed (action, _cb)
        action = (google, ml)

>>> Core Code Files
* Changed db.updateServerTable > db.updateTable
* Changed db.updateStatsTable > db.updateTable
* Changed db.increaseServerCount > db.increaseCount
* Changed db.increaseStatsCount > db.increaseCount

V-1

Inital Release

V-1

V-2

Inital Release

V-1

V-2

V-3

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.

• 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.

RITA - All-in-One Builder This tool will guide you through creating a category, adding translation channels, creating the required roles, configuring permissions, and optionally creating a reaction role message so users can access the channels.

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 or /settings

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

!tr prefix [prefix]

!translate prefix [prefix]

This command will turn off messages from the Development team.

!tr announce [on/off]

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

• !tr embed [on/off]

• /settings embed

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

• !tr settings langdetect [on/off]

• /settings langdetect

This command will allow RITA to translate messages from most bots

!tr bot2bot [on/off]

!tr help bot2bot

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]

none - RITA won't ignore any mentions

everyone - RITA will ignore everyone and here tags

all - RITA will ignore all mentions

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

!tr react [on/off]

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]

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

!tr debug [on/off]

!tr help debug

This command will reset all Settings to their default setting.

!tr settings reset

Inital Release

### 1.3.5-0
Date: 17/10/22
User: Zycore
> ----------
>>> .env File
* Defined `DISCORD_BOT_DEV_ID` in env file

>>> message.js
* Changed variable `message.isOwner` to `message.isGuildOwner`

>>> events.js
* Added in `process.env.DISCORD_BOT_DEV_ID = process.env.DISCORD_BOT_DEV_ID || "0";` to load variables on boot.

>>> translate.js
* Updated with arts new code

>>> auth.js
* Removed `exports.donation` as it was not used
* Removed `exports.changelog` as it was not used
* Removed `devID` and set variable in `.env` file
* Set fallback for if `DISCORD_BOT_DEV_ID` is missing and will use `DISCORD_BOT_OWNER_ID`

>>> settings.js
* Removed `listservers` command from settings.js
* Removed `listusers` command from settings.js

>>> misc.js
* Removed `costcalc` commands and variables
* Removed Mentions of ko-fi from responces

>>> join.js, invalid.js, choose_server
* Removed Mentions of ko-fi from responces

V-1

### 1.3.5-1
Date: 17/10/22
User: Zycore
> ----------
>>> translate.js
* New `translate.js` code

>> Error's
TypeError: Cannot read properties of null (reading 'user_id')
    at Object.checkSubActive (c:..\GitHub\RitaBotBuild\src\core\helpers.js:79:24)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Object.subExpired (c:..\GitHub\RitaBotBuild\src\core\helpers.js:39:7)
    at async run (c:..\GitHub\RitaBotBuild\src\message.js:265:8)

V-2

### 1.3.5-2
Date: 18/10/22
User: Qjuh
> ----------
>>> message.js
* Removed `message.server` and `message.stats` being attached to cached messages

>>> profanity.js, send.js, translate.js, translate.last.js
* Changed to use `db.server_obj` instead of the now removed `data.message.server`

>>> helpers.js
* added check `if(!sub)` to account for non-subbed servers and fix the error in console `Cannot read properties of null (reading 'user_id')`

BETA TESTERS WANTED

As RITA moves into the next phase and new features are implemented we want to be able to test RITA without impacting the wider user base with potential bugs resulting in downtime. This is where you, our users, can help. 

What We are looking for in BETA Testers: 

How many do we need?

To start with we are looking for 5 servers willing to be BETA Testers. 

Are there any restrictions?

You must have no more than 100 tasks, a monthly usage limit of no more than 500k characters and more than 20 users. For simplicity of communication, you must be proficient in communicating in English. 

What do I need to do?

Open a general ticket in open-a-ticket providing your server ID, and stating you want to be a BETA Tester. One of the admin team will evaluate your server to ensure it meets our requirements. 

What next?

You will be invited to install a separate version of RITA on your server. This version is invite-only and will only work on the servers we approve.

Will I need to set everything up again?

No, your tasks will be intact and RITA will start working straight away. 

What do I have to do as a BETA Tester?

The simple answer, use BITA as normal, we will create a separate ticket where you will report any issue you find. 

Are there any downsides?

While we will continue to try and provide a guaranteed uptime like Global RITA there may be a time when BETA RITA stops working. 

New features we add may be removed and you may find random bugs. 

Your feedback will help us to fix these and get them ready for global launch. 

You won't be able to have more than 1000 Tasks. 

What's in it for me?

This is the best bit, we will provide RITA for free. 

Through the BETA Platform. So you won't have to pay for a subscription. 

There will be rules but we will let you know them before you agree. 

But.......

Some codeUpdates may be made multiple times a day, with reboot times being an average of 5 mins. We can't always guarantee notification of reboots. 

But we will let you know of any changes. 

BETA RITA is not a permanent bot, and while we will give you as much notice as we can it may be deactivated at any time.

A Year in Review - RITA 2022

This year has seen over 780 new user’s subscribe to RITA! At the start of 2022 RITA was using version 1.3.0, now as we start 2023 RITA is using version 1.3.24. 

Thanks to the tireless work the RITA development team. 

More than 150 individual updates, fixes, and patches have been made. Resulting in over 32,000 lines of new code being added and nearly 16,000 lines of code being deleted due to refactoring and optimization. 

RITA Message Statistics for 2022:

* Total characters translated by RITA = 949,434,521
* Total messages translated by RITA = 17,749,158
* Translations sent by RITA in embed off mode = 13,119,780
* Translations sent by RITA in embed mode = 7,267,768
* Pictures sent by RITA = 462,227
* Number of messages translated via flag emoji reactions = 155,512
* Gif’s sent by RITA = 131,845

Numbers like this are what keeps us going, knowing that you truly use RITA to her full potential! 

RITA Artificial Intelligence Machine Learning (ML) Work In Progress

As of July of 2022, a part of the RITA development team has been hard at work creating our very own machine learning translation model.
 
For those who aren’t familiar with a machine learning model or a neural network. Instead of relying on Google to translate the messages.
 
We are using various data sets to train the machine learning model via different means so that eventually we can offer an even lower cost translation bot.
 
With the same level of translation quality you’ve come to expect and depend on from RITA. This is still very much in the early stages of development, so far thanks to numerous training iterations we have decent coverage for the following 11 languages:
 
English, German, Russian, Spanish, French, Romanian, Italian, Portuguese, Japanese, Chinese, and Korean. 

Please stay tuned for more information regarding the ML progress RITA is making.
 
Total character translated with RITA’s ML engine = 9,721,043

RITA Team and Server Updates for 2022

Introducing Qjuh and Z3US, two very skilled developers.

And introduced a wonderful team of Community Helpers (T•K, Mairin Lilith, KingLion1314, and Slasky) and bot helpers (iconoclast and LOKI)
 
We have been community verified and have added 2 new bots to the RITA family.
 
Thank you for an amazing 2022 and here’s to an even better 2023!

The RITA development team

Inital Release

### 1.3.29-0
Date: 12/03/23
User: Artanis, Qjuh
> ----------
>>> Core BOT code
* Implimented ML Translation Engine Support
    > Each uer has a limit to the number of Google Characters they were able to use, Once a user reached this limit the following was performed
	If the user only had tasks that were supported and optimised by our ML Engine then their subscription was "Forced" to ML only
	Any further usage was utilised via ML and not Google API
	> Now once a used hits their Limit set by thier subscription, any translation will be performed via ML if the language is supported and optimised
	If the lanauge is not then it will continue to use Google API.
	
>>> events.js
* Fixed a bug with message deletion

>>> translate.js, message.js
* Errors are now console logged
* Fix edits for auto and embed on
* Fix zh-CN to zh in parsing

>>> FUNDING.yml
* Added Patreon link

V-1

### 1.3.29-1
Date: 13/03/23
User: Artanis, Qjuh
> ----------
>>> Env Files
* Update dependancies
    > discord.js               ^14.7.1  →  ^14.8.0

>>> Core BOT code
* Fix multiple same-channel translation - typing changes - fixed edit discord parsing

V-2

### 1.3.29-2
Date: 14/03/23
User: Artanis
> ----------
>>> send.js, message.js
* Fixed errors in webhook property and webhook mode

Interpretation and Definitions

The words of which the initial letter is capitalized have meanings defined under Interpretations and Definitions, they are located Here.

Disclaimer

You are strictly prohibited to use RitaBot against the ToS of discord or for illegal purposes. We are doing our best to prevent these activities, while trying to provide the best user experience as possible. If you find people or communities using RitaBot against the ToS of discord or even for illegal activities, please send us an email to dev@ritabot.gg

Proprietary Rights

We (RitaBot) own and retain all rights for public available data (including but not limited to templates). We grant you the permission to use this available data for your own needs, but strictly disallow any commercial use. You therefore shall not sell, license or otherwise commercialize the data except if the permission was expressly granted to you.

Availability

• RitaBot is provided as-is. There are no guarantees that it will be available in the future, and its purpose or availability may be changed at any time.

• Usage Data including backups may be deleted at any time.

• Any "pro" or "premium" Features are not guaranteed. They may change or be revoked at any time.

• Access to all or specific Features of RitaBot may be revoked, for all or a specific user, at any time.

To operate RitaBot and in specific the Database we use requieres we save some information about You, your Discord server and the members.

• Usernames & Discriminators.

• Server Name & ID

• Channel ID's, Role ID's and User/Owner ID's

We may also store anonymized Personal Data about you including your username, discriminator and public flags (badges) in line with our . This information is only used for analytics and can not be tracked back to You.

S.A.L.T.S Stands for Subscription, Activation, Limitations, Termination and Suspension Policy. This describes Our policies and procedures on how each of the aformentioned processes are handled.

By using the Service, You agree to the following processes and be subject to enforcment of them. Please refer to for more information.

Inital Release

### 1.3.14-0
Date: 01/11/22
User: Qjuh
> ----------
>>> choose_server.js, logger.js
* Added log for activated subscriptions in activity log

V-1

### 1.3.14-1
Date: 11/11/22
User: Qjuh
> ----------
>>> helpers.js, events.js
* Fetch members of support server instead of relying on cache

>>> events.js
* Fix messageDelete to also work for deleting translations in Threads

V-2

### 1.3.14-2
Date: 11/11/22
User: Zycore
> ----------
>>> sub.js, args.js
* Removed global sub code
* Removed sub check code as its redundant, can be found in !tr stats sub

>>> choose_server.js
* If not BITA bot wont assign BITA Variable in DB
* Fetch members of support server instead of relying on cache
* Now refers to plan for tier,task and engine info. Plan is collected from helpers.js > getPlan

>>>  helpers.js > getPlan
* Import (data, user) export (plan.tier, plan.taskAmount, plan.engine)

>>>  settings.js
* target server code `!tr settings server [ID]` (Check with BitField)

>>> db.js
* Comment text Changed

>>> permissions.js
* You can now validate with BitField by `if (await permissions.check(data, "Permission Name Here"))`, it will return true or false

Interpretation and Definitions

The words of which the initial letter is capitalized have meanings defined under Interpretations and Definitions, they are located Here.

Disclaimer

You are strictly prohibited to use RitaBot against the ToS of discord or for illegal purposes. We are doing our best to prevent these activities, while trying to provide the best user experience as possible. If you find people or communities using RitaBot against the ToS of discord or even for illegal activities, please send us an email to dev@ritabot.gg

Proprietary Rights

We (RitaBot) own and retain all rights for public available data (including but not limited to templates). We grant you the permission to use this available data for your own needs, but strictly disallow any commercial use. You therefore shall not sell, license or otherwise commercialize the data except if the permission was expressly granted to you.

Availability

• RitaBot is provided as-is. There are no guarantees that it will be available in the future, and its purpose or availability may be changed at any time.

• Usage Data including backups may be deleted at any time.

• Any "pro" or "premium" Features are not guaranteed. They may change or be revoked at any time.

• Access to all or specific Features of RitaBot may be revoked, for all or a specific user, at any time.

• Promotional programmes, including the RITA Rewards Programme, may be modified, suspended, or withdrawn at any time.

Participation in the RITA Rewards Programme is optional and available only to eligible users.

By earning, holding, or redeeming Reward Points, You agree to be bound by the RITA Rewards Programme Terms & Conditions, which form part of these Terms of Service.

Reward Points have no monetary value, are non-transferable unless expressly authorised by Us, and may only be redeemed in accordance with the RITA Rewards Programme Terms & Conditions.

We reserve the right to modify, suspend, or discontinue the Rewards Programme at any time.

To operate RitaBot and in specific the Database we use requieres we save some information about You, your Discord server and the members.

• Usernames & Discriminators.

• Server Name & ID

• Channel ID's, Role ID's and User/Owner ID's

We may also store anonymized Personal Data about you including your username, discriminator and public flags (badges) in line with our . This information is only used for analytics and can not be tracked back to You.

S.A.L.T.S Stands for Subscription, Activation, Limitations, Termination and Suspension Policy. This describes Our policies and procedures on how each of the aformentioned processes are handled.

By using the Service, You agree to the following processes and be subject to enforcment of them. Please refer to for more information.

We reserve the right to amend or update these Terms of Service at any time.

Where changes materially affect Your rights or obligations, We will make reasonable efforts to notify Users through our Website, Discord server, or other appropriate communication channels.

Your continued use of the Service after the effective date of any changes constitutes acceptance of the updated Terms.

Where applicable, any Right to Exit will be governed by the Right to Exit Policy.

We're excited to announce the launch of the Rita Rewards Programme, a new way of recognising and rewarding our subscribers for their continued support.

Starting today, every subscription payment earns Reward Points automatically based on your subscription tier:

⭐ Reaction – 3 Points per month ⭐ Casual – 7 Points per month ⭐ Tinkerer – 11 Points per month ⭐ Pro – 16 Points per month ⭐ Ultima – 22 Points per month

As a thank you to our long-term supporters, points have been awarded retrospectively based on your subscription history. That means many existing subscribers will already have points waiting to be redeemed.

Reward Points can be exchanged for discounts on future subscriptions, existing subscriptions or used to generate a gift subscription for a friend:

🎁 25% Discount for one month – 25 Points 🎁 50% Discount for one month – 50 Points 🎁 75% Discount for one month – 75 Points 🎁 100% Discount for one month – 100 Points 🎁 1 Month Gift Subscription – 80 Points

Gift subscriptions can only be redeemed by new subscribers, making them a great way to introduce friends to Rita.

To keep the programme fair and sustainable, the following restrictions apply:

• Reward codes expire after 30 days if unused

• Gift subscription codes expire after 30 days if unused

• Only one reward may be redeemed every 90 days

• 100% discount rewards may only be redeemed once every 180 days

You can view your Reward Point balance, reward history, available rewards, and redeem points at any time using the /reward command.

This is our way of saying thank you to everyone who has supported Rita, whether you've been with us for a month or for several years. We appreciate every subscriber who helps make the project possible.

Thank you for being part of the Rita community.

Slash Command

/reward history

This shows your latest reward actions (up to 10 entries), including:

• Reward type

• Cost in points

• Code/tracking reference

• Created date

• Expiry date (when applicable)

• Redeemed status (Yes/No)

/reward claim

This creates a one-time discount code you can use later or share with someone else.

• Discount selector: Choose 25%, 50%, 75%, or 100% (based on available points).

  • Only discount avaliable to you based on the number of points you have will be shown.

Thank you too:

The Stats:

So to everyone, All our users, all our subscribers

About Subscribing

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.

How to Activate?

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.

• 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

• 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.

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.

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

Goodbye Patreon, Hello Stripe

Over the last year, we have been hard at work integrating Stripe subscription and payment process, With a dedicated DASHBOARD to allow you to manage your subscription,

• Manage every aspect of your RITA subscription past, present, and future,

• We now offer Bi-monthly subscriptions, allowing you to pay for 2 months in advance,

• Role-based subscriptions are so RITA 1.0.

  • Thanks to our dashboard integration we know who you are and which discord account to link with at the point of sale. Click, Pay, Go,

• Modify server settings such as embed style, reaction translation etc.,

• Select the translation engine you want

  • 100% Machine Learning

  • Optimized

  • Normal

• Built with Stripe in mind. (More about Stripe below),

• Contact Support directly from the Dashboard,

• These are just some of the current features. Expect increased functionality in the Dashboard as we continue development!,

• Just login and get started! Current subscriptions with Patreon will appear, but you can buy new Dashboard subscriptions

We will be expanding the features available to users in the dashboard as we continue development, For now, the core functions and most important ones are available to use.

• You can choose to pay on the 1st of each month like we currently offer, or the same day you subscribe, free to choose.

• You will be able to see all your subscriptions in one place.

• You can modify server settings such as embed style, reaction translation etc.

• What is a Dashboard?

  • The RITA Dashboard is a website in which you login with your Discord account and can oversee all your RITA servers, access the billing portal, and buy new plans,

• Will 'I' need to do anything to keep using my current paid version of RITA?:

• Great news for any RITA users who speaks Spanish, Italian, Portuguese, Russian, Simplified Chinese, or Turkish

  • Once you've set the server's language to one of the above,

  • Or after checking that your Discord client's location is set to one of those above locals,

• RITA's slash commands will now be in those languages,

• Reply function: These are now translated across channels just like the original message.

• Style: you can now prefix the message with the source language Emoji

• Slash commands: Most of the core function commands are now available as slash commands.

• Our Dedicated ML server got some upgrades, increasing performance and resulting in reduced downtime (if you ever felt it),

• Improved redundancy and fall over protection for RITA.

• Database Changes, are not important for you, but important for us.

  • We made several changes to the way we store and manage data.

• A HUGE Thank you to the entire RITA Team. Without each of you RITA wouldn't be what it is today!

• Thanks to you all the RITA users! It's our pleasure to keep making RITA better and better. I can't wait to see what RITA 3.0 will look like!

• As always we are available to answer any questions you have or assist with troubleshooting any issues.