rob-via / ritabot Goto Github PK

A Translation bot built using discord.js and a custom Google Translate API. (The NPM Version of Google Translate API is outdated and does not work with this distribution, as such a custom and maintained version is installed.)

1. Error Message Support Section.
2. Auto Reverse translation for the auto function.
3. !t tasks #TargetChannel Implementation.
4. Introduction of a Streamlined Command Handler. (This will be done as a New Project)

• 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 Security vulnerabilities fixed.
• Various Spelling mistakes in ReadMe have been corrected.
• Dev Dependencies core to this bot, the google-transalte-api & google-transalte-token have been updated

• Setup on a Raspberry Pi Section.
• 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.

1. Features
2. Usage
3. Setting up a New Bot (RECOMMENDED)
4. How to Update
5. C-3PO to RITA Bot Migration (EXPERIMENTAL)
6. Heroku Database Support
7. Local Installation Support
8. Setup on a Raspberry Pi
9. Troubleshooting
10. Error Messages
11. Commands
12. Credits & License
13. Design Team
14. What, Who, How and Why?

• Translate custom messages
• Translate messages by reacting with flag emoji
• Translate last message(s) in channel
• Translate to multiple languages at once
• Automatic translation of channels with option to forward translations to users or separate channels.
• Supports 100+ languages

• Cerate your own with the instructions below.
• Write !translate help or !t help for a list of commands.

If you are looking to set up a New Bot then follow the instruction below, If you already have a Heroku Bot Using C-3P0 then Scroll down for instruction on how to migrate your translation settings.

To deploy a free translation bot that you can add to your discord server, follow these easy steps.

• If you don't yet have a Github account, create one! It's free and easy.
• Use the button in the upper righthand side of this page to fork the repo so that it will be associated with your Github account.

• Give app a friendly name and click the Create App button
  • I like the name C-3PO, but feel free to pick something different if you fear George Lucas's wrath. Maybe C-4PO
• Take note of the app CLIENT ID, you will need it later
• Scroll down to the Bot section
• Click the Create a Bot User button
• Click the Yes, do it! button
• Copy the bot's TOKEN, you will need it later

• Create a new app. It's name must be unique and composed of all lowercase letters and dashes. Something like yourname-discordbot is fine
• Under Deployment Method select Github. Connect to your Github account and search for this repo by name.
• Scroll down to the manual deploy section, and select the Master branch. Click deploy branch, and wait for the successfully deployed message.
• Go to the Resources tab and look for the addons section. Search 'Postgres', and add a 'Hobby Dev - Free' version of Heroku Postgres. This will be automatically attached as your bot's database.
• Go to the Settings tab. Click to reveal Config Variables, then add then add the following:
  • KEY: = DISCORD_TOKEN
  • Value: = Your discord bot's token that you copied earlier.
  • KEY: = NODE_MODULES_CACHE
  • Value: = false
    • This is to ensure that when the bot updates it does not use any old Dependencies that Heroku has stored and gets fresh ones from the package.json file
• Go to the Overview tab and click configure dynos. Turn off the default web npm start dyno and turn on the worker node src/bot.js dyno. Your bot will now be up and running!

• Replace the CLIENTID string in the following URL with your own apps client id: https://discordapp.com/oauth2/authorize?&client_id=CLIENTID&scope=bot&permissions=8
• Visit the resulting URL and add your bot to any server where you have admin privileges.
• Once added, your bot should show up more or less instantaneously. Type !t help within the discord chat for more details on how to use it. Happy translating!

• You must have a bot already running on your server, if not then refer to Setting up a New Bot

• Complete a Pull Request from the master Branch of ZyC0R3/Rita to your master branch.
• Detailed instructions with example can be found here: https://www.sitepoint.com/quick-tip-sync-your-fork-with-the-original-without-the-cli/

• Log in to your Heroku account.
• Select the bot you made in step 3 of Setting up a New Bot
• Under Deployment Method Scroll down to the manual deploy section, and select the Master branch. Click deploy branch, and wait for the successfully deployed message.

If you already have a Heroku Bot Using C-3P0

• Make sure you have completed the following steps before attempting to migrate translation settings.

1. You have an already up and running C-3P0 Bot.
2. You are using Heroku to run the old version.
3. Make sure you do not disable, reset or delete your database (preferably Postgres from Heroku)
4. You have already completed a Pull Request from the master Branch of ZyC0R3/Rita to your master branch.

• Go to Heroku and click your app of C-3PO, and locate the Deploy section. Scroll down until you see the current fork your C-3PO bot is running off of, next to it there should be a button saying Disconnect
• Next click search on repositories and select your fork of this project and wait for it to load. Once that is completed you need to Deploy the 'Master' Branch/Version of the bot.
• Wait for it to finish deploying and you should be good to go. Turn on your worker dyno (if it was not already) and make sure your DISCORD_TOKEN is connected in the variables section in Settings. All data from your previous C-3PO bot should be saved in the database of Postgres as long as you do not delete it and will connect to all the previous channel translation connections. Happy Translating!

Sometimes you need to edit the Database manually, This is not something you should be playing around with unless you really know what you are doing.

1. Know that you are doing, if you don't then don't touch the DB. Simple.
2. Download and Install Postgres Admin 4, Located Here or Here. This guide will be for Windows, but it shouldn't be much different for any other OS.
3. Locate your credentials for you Heroku Database, Log in to Heroku > Select your App > Click Resources > Click Heroku Postgres > Click Settings > Click View Credentials (Note: Heroku rotates credentials periodically and updates applications where this database is attached.)

For a fresh install of pgAdmin, the dashboard likely contains only one server. This is your local server, Ignore this.

1. Right click server(s) > create > server …
2. Fill out the following:

• Name: This is solely for you. Name it whatever you want, I chose ‘Heroku-Run — On’

Under the connection tab:

• Hostname/Address: This is the host credential you located in Step 3. It should look like **-**-**...amazonaws.com
• Port: Keep the port at 5432, unless your credentials list otherwise
• Maintenance databaseL This is the database field located in Step 3 Below.
• Username: This is the user field in the credentials
• Password: The password field located in Step 3. I highly advise checking save password so that you don’t have to copypasta this every time you want to connect.
• In the SSL Tab, mark SSL mode as require

At this point, if we were to hit ‘save’ (please don’t), something very strange would happen. You’d see hundreds if not thousands of databases appear in pgAdmin. This has to do with how Heroku configures their servers. You’ll still only have access to your specific database, not those of others. In order to avoid parsing so many databases, we have to white list only those databases we care about.

3. Go to the Advanced tab and under db restriction copy the database name (it’s the same value as the Maintenance Database field filled earlier).
4. Click Save/Connect and you are done. Edit away.

The bot can also be run locally without Heroku. The local setup requires more steps since the database needs to be setup and the development tools need be installed. Start with the steps 1 and 2 in Setting up a New Bot and the continue as follows:

Any Database that runs with SQL Sequelize ('https://sequelize.org/master/') can be used. My recommendation is to use the SQL Lite database since the setup is fast and access is easy. Copy the connection details to the database for the next step. Example: The connection to a sqlite database with the name database.db stored at the same level of this README file would be ./database.db.

Copy the existing .env.example file and name it .env. Edit the Values of DISCORD_TOKEN, DISCORD_BOT_OWNER_ID and the DATABASE_URL according to the values that you copied earlier.

Install nodejs from https://nodejs.org/en/

Run npm install -g gulp in your console to install gulp. Build the bot code using npm build and run the bot with npm start.

• Replace the CLIENTID string in the following URL with your own apps client id: https://discordapp.com/oauth2/authorize?&client_id=CLIENTID&scope=bot&permissions=8
• Visit the resulting URL and add your bot to any server where you have admin privileges.
• Once added, your bot should show up more or less instantaneously. Type !t help within the discord chat for more details on how to use it. Happy translating!

We recommend to initially run your bot in a local environment on your laptop before you run the translator on a Raspberry Pi. The local setup allows you to get familiar with the setup and the settings.

The following description allows a headless configuration. Only a network connection is required. This description is explicitly for running the bot on a Raspberry Pi 4, but the setup should be similar for earlier version.

Recommendation: run it locally first before putting the code on pi. Easier to ensure that .env variables are setup correctly.

Download the minimal image of Raspbian (https://www.raspberrypi.org/downloads/raspbian/). This setup is based on Raspbian Buster Lite, July 2019.

Use balenaEtcher(https://www.balena.io/etcher/) to write the image on your SD card.

For more Information: See https://www.raspberrypi.org/documentation/installation/installing-images/README.md

Enable SSH by placing a file named “ssh” (without any extension) onto the boot partition of the SD card.

• Pop your prepared SD card, power and a network cable into the Pi.
• Find your Pi's IP Address. Check your Router's DHCP allocation table or use a mobile app like Fing (https://play.google.com/store/apps/details?id=com.overlook.android.fing) to find the IP of Pi.
• Install WinSCP and Putty on your Laptop.
• Start Putty and login into your Pi. Username: pi, PW: raspberry. Change your password with 'passwd'.

• Type raspi-config and change your locales
• Update the package lists from repositories: sudo apt-get update
• Update your repositories: sudo apt-get dist-upgrade

The fastes way to install the current node and npm versions (https://nodejs.org/en/download/) was to follow the description from nodesource (https://github.com/nodesource/distributions/blob/master/README.md):

• Get the source: curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
• Install: sudo apt-get install -y nodejs
• Check version: node -v and npm -v

It is recommend to install git and pull from your fork or main:

• Install git: sudo apt-get install git
• Create the folder for the source: mkdir Rita
• Clone the repository: git clone https://github.com/ZyC0R3/RitaBot.git
• Checkout the branch you need: git checkout --track origin/1.1.7

Alternative: move the source code with WinSCP from your local environment to the Pi.

Install sqlite3 with sudo apt-get install sqlite3.

Create an empty database file (sqlite3 database.db)and call .tables)

Use WinSCP to copy your .env file from your local environment to the Pi.

• Install gulp is installed: sudo npm install -g gulp (not sure if still necessary)
• Make sure you are in the Rita folder
• Get and install all packages of RITA: npm install
• Build the code: npm run-script build
• Start the bot: npm run-script start

There are different ways to make the bot initialize at startup. The following description is based on init.d and update-rc.d:

• Create a init.d script: Edit the script template in .pi/translate_bot if necessary and copy it to the folder /etc/init.d/ with sudo mv .pi/translate_bot /etc/init.d/.
• Make the file executable: sudo chmod +x /etc/init.d/translate_bot
• Update the system script links: sudo update-rc.d translate_bot defaults
• Now, you can interact with the bot service with commands sudo service translate_bot start, sudo service translate_bot status and sudo service translate_bot stop
• The logging will be in /var/log/translate_bot.err and /var/log/translate_bot.log
• Reboot and hope everything is running smooth: sudo reboot
• Enjoy (or return to step 4 in Setting up a New Bot if you haven't done yet)

• You can set up debugging Webhooks using the following steps
  1. Create a new channel on your server to receive the Webhooks, let's say #Webhooks.
  2. Go to Server Settings -> Webhooks -> Create Webhook. Select the #Webhooks channel, then copy the Webhook's URL. It will look something like https://discordapp.com/api/webhooks/012345678901234567/VCj9yOOtJF9VCm-BU2F9xrbnoWD5gBZZ-UU1mZHcxi5VLgr3bPb9NanRJM8YD9cpBisL
  3. In the Settings tab of your Heroku app add the following Config Variables (values extracted from your URL):
     • DISCORD_DEBUG_WEBHOOK_ID : 012345678901234567
     • DISCORD_DEBUG_WEBHOOK_TOKEN : VCj9yOOtJF9VCm-BU2F9xrbnoWD5gBZZ-UU1mZHcxi5VLgr3bPb9NanRJM8YD9cpBisL
  4. Restart your app's worker node src/bot.js dyno, and you will begin to receive debugging messages in your #Webhooks channel.
• If your bot in unresponsive, the first thing to check is Heroku. Log in and manually restart the worker node src/bot.js dyno.
• For further troubleshooting, it's helpful to install the Heroku command line interface. Once installed you can login from a terminal with heroku login and check your apps logs with heroku logs --tail -a <your-app-name>
• If you are unable to solve a problem yourself, report it with as much detail as possible in this repo's issue tracker.

This section/feature is being Created, Check back soon or join the support discord.

• Translate Custom Text
• Translate by Reaction
• Translate Last Message
• Translate Channel
• Settings
• Misc. Commands

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

• Zycore / ZyC0R3
• Artanis / ArtanisTheOne
• Balthazar / Jshep89
• Z3US / cyberlooper
• Maddious / MadIndex
• defqon.1 / wdaniel1985

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, Self-hosted on Heroku (or a local install) and Completly 100% Free. She is maintained by a small group of users, each with different backgrounds and some learning as we go.

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

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.

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 moulded, moulded into something amazing, moulded into Rita. The Real-Time Interchangeable Translating Assistant.

Released under MIT license.