Skip to main content

Localization

Help Wanted! Contribute to Localization

If you know a language and want to contribute to localization. Please join our Discord group and ping Xinecraft#2139. It will be very helpful for the project as current translated text are mostly from Google Translate.

Localization feature allows you to translate the web in any language you want. You can choose from predefined language or add new one.

Below are list of languages which are already added by default.

NameCode
Englishen
Spanishes
Russianru
Slovaksk
Germande
Polishpl
Ukrainianuk
Hindihi
Italianit
Chinese (Traditional)zh-hk
Chinese (Simplified)zh-cn
Japaneseja
Hungarianhu

How to change default language?​

Open your .env file in any text editor and change APP_LOCALE environment variable to a valid language code for whatever language you want. Eg: en, fr, hi, ru etc.

.env
// For german it should be
APP_LOCALE=de

Next, clear the cache by running update.sh script so your changes will reflect instantly.

cd /var/www/minetrax
sudo sh update.sh

Done! Now open your website default language will be changed to the language you set.

How to make changes to language files?​

The default included translations was done using automatic translation script might not be correct, so it is recommended that you review the translation files for your language and make changes as per requirements.

Translations files are stored in folder lang in the root directory. To change text for your language you will have to edit all files in folder of your language code & {lang}.json. Eg, to edit for german you edit:

/lang
    /de
        auth.php
        pagination.php
        passwords.php
        validation.php
		//... all other file exists in this directory
	de.json

Translation files will look something like this.

  1. JSON file:
lang/de.json
{
	"Thanks": "Vielen Dank",
	"Hey :name": "Hallo :name",
}
  1. PHP File:
lang/de/auth.php
<?php 
return [
  'failed' => 'Diese Anmeldeinformationen stimmen nicht mit unseren Aufzeichnungen überein.',
  'password' => 'Das angegebene Passwort ist falsch.',
  'throttle' => 'Zu viele Anmeldeversuche. Bitte versuchen Sie es in :seconds Sekunden erneut.',
];

Left side of the expression in both JSON and PHP files are Key and should not be changed. Only the right side which is Value must be changed.

Feel free to translate the right part as per requirements.

After completing your changes clear the caches so your changes will reflect instantly.

cd /var/www/minetrax
php artisan cache:clear
info

Note that in some cases there is a colon (:) before some string, Eg: :name. Those are special placeholder which will be dynamically replaced to variables so those special placeholders should not be translated.

Language Switcher Feature​

MineTrax comes with a language switcher which allows users to change the language of the website. It is enabled by default and allows users to change to any supported language.

To disable the language switcher, open your .env file and change AVAILABLE_LOCALES to null.

.env
AVAILABLE_LOCALES=null

If you want to enable only specific languages, you can set the AVAILABLE_LOCALES to a comma separated list of language codes.

.env
AVAILABLE_LOCALES=en,de,fr,ru

How to add a new language?​

It is very simple to add new language if your desired language is not included in the list.

To add support for new language you have two methods:

Method 1 (Manual)​

  1. Go to minetrax folder Eg: cd /var/www/minetrax
  2. copy lang/en folder to lang/YOUR_LANGUAGE_CODE Eg: lang/hr.
  3. copy lang/en.json file to lang/YOUR_LANGUAGE_CODE.json Eg: lang/en.json.
  4. Now start adding translations in the newly created files as described above.
  5. Change the locale of your site to the new language by changing APP_LOCALE env variable as described here.

Using the above method might get cumbersome as you will have to add translations for every text manually. Follow the second method instead if you prefer automatic translation from google translate.

Method 2 (Automatic)​

This method uses google translate to add translation for all text automatically.

1. Go to MineTrax installation folder​

cd /var/www/minetrax

2. Run the language creator script for PHP​

Run the command in console.

php artisan translate:files

It will ask few questions, answer it as shown below:

 What is base locale? [en]:
 > en

 What are the target locales? Comma seperate each lang key [es,fr,ru,sk,de,pl,uk,hi]:
 > YOUR_DESIRED_LANGUAGE <- Replace with your desired language code

 Force overwrite existing translations? [No]:
  [0] No
  [1] Yes
 > 0

 Verbose each translation? [Yes]:
  [0] No
  [1] Yes
 > 1

 Use text exploration and json translation or php files? [php]:
  [0] json
  [1] php
 > php

 Are there specific target files to translate only? ex: file1,file2 []:
 >

 Are there specific files to exclude? [auth,pagination,validation,passwords]:
 > no

 0/1 [>---------------------------]   0%
 en -> xx translating...

Let it run and it should create a new folder named as your language code inside lang folder, with all php translation files.

3. Run the language creator script for JSON​

Run the command in console.

php artisan translate:files

It will ask few questions, answer it as shown below:

 What is base locale? [en]:
 > en

 What are the target locales? Comma seperate each lang key [es,fr,ru,sk,de,pl,uk,hi]:
 > YOUR_DESIRED_LANGUAGE <- Replace with your desired language code

 Force overwrite existing translations? [No]:
  [0] No
  [1] Yes
 > 0

 Verbose each translation? [Yes]:
  [0] No
  [1] Yes
 > 1

 Use text exploration and json translation or php files? [php]:
  [0] json
  [1] php
 > json

 0/1 [>---------------------------]   0%
en -> xx translating...

It will take a while, let it complete and it should create a new json file lang/YOUR_LANGUAGE_CODE.json.

3. Review the language files​

Text translated by Google will reduced your work but you still should check for wrong translations and fix them. Eg: Google translate will translate to word Steam in translation text but it shouldn't be in some cases.

Now open the newly created folder & files in lang directory for your language and review/edit them as required.

4. Finally change locale of Web to newly added language​

Change the locale of your site to the new language by changing APP_LOCALE env variable as described here.