StarNumber12046 / i18n

The languages used by the bot.

I18n

Manages the translation files used by Plum. They're downloaded every reboot.

Contributing

To help translate Plum, clone this repository and check if the folder of the language you're translating exists. If it doesn't, copy the folder en-US and rename it as the ISO 639-1 code formatted as: lang-REGION (example: it-IT). If it does, don't do anything.

Enter the folder and check out the YML files. Each YML is made like this:

# Comment to explain
KEY: Value, with a {{placeholder}}
KEY_WITH_OBJECTS:
    NESTED_KEY:
        - Array values
        - Start with
        - a dash
    ANOTHER_KEY: This key is nested

As per the YML spec, indentation is important.

DON'T rename the files and DON'T edit the keys names, otherwise it won't work. {{placeholder}}s are also values that shouldn't be edited, they'll be replaced at runtime.

Lines that start with a hash sign (#) are just comments to provide more context or an explanation for a better understanding of the meaning of the translations. They can be safely removed in the translations.

Once you're done translating, just send a pull request. If it's accepted, you'll see your changes on the next reboot of the bot.

Obviously, don't forget to join our Discord!

By the way, if you help translating Plum, you'll get 1 month of free Premium! Join!

Updating the translations

If you want to update translations without checking by hand where the strings have been added, we provide a simple script to manually add strings where they are missing. We recommend combining it with Gitpod or Visual Studio code which have the particularity of showing which files have been modified by the script.

Listed below are the steps for the best procedure for updating strings.

Using Gitpod

1. Fork the repository into your account
2. Connect Gitpod to GitHub and open the repository on Gitpod
3. In Terminal, run npm install yaml
4. Run node addstrs.js lang-code where instead of lang-code you have to put the language code (eg it-IT)
5. Check the files modified by the program and update them
6. Once you finished translating, move to Source Control section
7. Press the "+" in "CHANGES" to stage the changes
8. Write a commit message in the top and CTRL+ENTER to submit it.
9. Run git push in terminal and you should be ready to pull request!