Skip to content

Languages

AfkF24 edited this page Sep 7, 2022 · 43 revisions

Kingdoms is an international plugin. The default language file is en.yml which is not saved in the plugin, it's generated automatically.
Language files automatically add new entries to their list, however they don't remove any old ones. If a translated language file is missing an entry, it'll copy one from the original (English) version into the file instead. Language entries don't have any explanation, they're mostly easy to understand. If you couldn't find the usage for an entry, you can always ask.

All supported language files can be viewed here however the plugin doesn't come with any of these languages (except English of course) pre-installed. You'd have to use /k admin languagepacks command in order to download them.

The plugin can display information based on each individual player's preferred supported language using /k language command. The plugin will attempt to detect the client's locale and automatically assign a language for them, but if they're using a modded client or their client's language isn't supported by the plugin, the option below will be used instead.

You can change the language by changing lang option in config.yml to one of the supported language codes (specified above the option) and then use /k reload command.

The language entry format for all the commands are commands -> [groups...] -> <name> where [groups...] are the main command names of that command and <name> is the main command name of that command. The group and names are explained in the permissions section.

All the language entries support:

  • Chat Colors and 1.16 Hex Colors
  • Line Breaks \n (It also keeps the color for the next line.)
  • Complex Messages (90% of the non-GUI messages)
  • Internal & External Placeholders
  • Complete Removal (by setting the message to ~ or null)
  • If prefix option is enabled in config, you can use NOPREFIX| at the beginning of a message to exclude it, or if the option is disabled, you can use PREFIX| to use the prefix for that specific message.

All community translations are welcomed. You can also improve existing translations. You can translate the language file and all the GUIs located in the guis folder, but plugin configs are not translatable.
Here are some rules when translating the plugin. These rules apply to GUI translations as well.

  • Obviously don't just drop them in Google Translate and paste them back to the file. Translate them manually.
  • You shouldn't change how the sentences are phrased and add or remove a part of the description unless it makes it easier to understand in that particular language.
  • You can change the colors, but do not use 1.16 hex color codes.
  • You shouldn't change the plugin prefix. Anywhere that the name Kingdoms is used that is referring to the plugin and not the name itself, shouldn't be translated.
  • Make sure to validate your files.
  • You can change the GUI design as long as it has all the functional options used.
  • You can give credits, but only at the beginning of the file. No IPs are allowed unless you have a domain that redirects to an appropriate website with SSL certificate (HTTPS).
  • You can add explanations anywhere in the file if you want.

After translating your language file, place your translated file in the plugin's folder. The file's name should be the same as the option below without the .yml file extension. Some of these language files are outdated. Standard way of naming this is to follow IETF language tags from IETF use ISO-639-1 codes. If you can't find it, or don't feel like it, don't bother.
If you translated the plugin, you can contact me and I'll add it to the plugin.

All the language files are translated by the community. They're not guaranteed to be 100% accurate or complete. Outdated translations might even cause errors during validation. Developers and translators are not responsible to update the language files. Latest available translations can be found here and GUI.

Basics

Advanced

Others

Clone this wiki locally