Sueta

EasyTranslation - Fast, Free, Automatic Server Translations

0.2.6

Automatically translate chat, plugins, and other server messages to player's native languages!

·Plugin




YouTube


Some Important Tips for Usage:
- Total Translate mode is SLOW without Redis
- Total Translate mode will overwrite most of the mymessages settings but not the translations settings.
- You can use SSL Redis with EasyTranslation!


/translate locale - See your currently set locale
/translate locale [ISO-631:2002 Country Code] - Set your country locale (ex: English = en, Spanish = es, German = de)
/translate enable translations - Enable translations of other people's messages
/translate disable translations - Disable translations of other people's messages


Installation for EasyTranslation is very simple. Read the guide below to get started.

Installation Guide

1. First download the EasyTranslation-X.X.X.jar from this page.
2. Setup a Google Account if you don't have one already!
3. Go to the Google Cloud Platform Homepage and click on "Get Started for Free"

If you go through the Sign Up process and create a billing account (you will not be charged), you will be able to get $300 USD in Credit on GCP for 1 year. The Cloud Translation API is free for the first 20 MILLION characters per month (so unless you have people chatting at a higher rate than 256 characters per message, you can translate around 72k+ messages a month)

After signing up you must go to the Console Dashboard and open up the sidebar. On the sidebar you'll see a section called "APIs & Services", click on that and then open up Credentials. Here you will create new credentials and choose "API Key". Create your new API key and copy it to your clipboard.

Now add the Cloud Translation API to your project. Go here for more information on how.

4. Drop the EasyTranslation jar-file you downloaded earlier in your plugins directory on your server. When you first run EasyTranslation it will not work since the API key has not been set in config. Open up the config.yml file in the plugins/EasyTranslation directory. Once this is open you can replace the "API_KEY" field with your API key. Save the config.yml and restart or stop/start your server.

5. Once you have added your API key the config.yml file you are all set! Read below for more information on the configuration file.

*Contact me if you need help setting up the API key credentials.

Redis Setup Guide:
(You can use Redis to speed up EasyTranslation)

Redis Setup Guide

Setting up Redis for EasyTranslation is extremely simple. First install Redis on your server (Google can help you with that). Once you setup Redis, open the configuration for EasyTranslate and set enabled in redis_settings to true. If you are hosting Redis locally, keep the default localhost as the host. If you are using a password, put that in the password field. Finally, if the port of your Redis server is something other than 6379 (which is the default) you can set that in the port field.

The next time you start EasyTranslation, it will start using your Redis Cache Database to store translations in order to make it faster in the future for players.



EasyTranslation's configuration is extremely simple to setup and modify. There aren't many values to mess with as the plugin itself is pretty simple. Expect changes to the configuration in future updates.

# Google Cloud API Key
API_KEY: READ WIKI FOR INFO
settings:
  # Players see translations by default
  default_player_translations_setting: true
  # Players messages are translated by default
  default_player_mymessages_setting: true
  # Show welcome message with info on turning of translations
  welcome_message: true
  # Prefix for translation when not using Total Translate
  prefix: "&lTranslation:"
  # Color of translated message in chat
  translation_color: "&6"
  # Ticks in between message sending and translation sending (shouldnt change this)
  translation_delay: 10
  # Translate plugin messages and server messages to players
  total_translate: false
  # Redis Cache Settings
  redis_settings:
    # Requires Redis to be Installed!
    enabled: false
    # Your Host for Redis
    host: "localhost"
    # Your Password for Redis
    password: ""
    # Your Port for Redis (Usually 6379 by Default)
    port: "6379"
# DO NOT DELETE ANYTHING BELOW HERE UNLESS YOU WANT TO RESET SOMEBODIES SETTINGS
player_settings:

Similar projects

Plugin →