Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 2.83 KB

README.md

File metadata and controls

59 lines (44 loc) · 2.83 KB
Raw

EmpyManager-Languages

Empymanager-Languages is a collection of YAML files used by EmpyManager Discord bot to localise every message used by the bot. Each server owner will be able to choose their favourite language and that shall be used to display every message.

The default language is en-UK.yaml, and the goal is to translate the bot in as many languages as possible thanks to the help of the community.

As a new language is added, you will be able to use it once the next update has been deployed.

If a message is not available in the selected language, the bot will fall back to using the en-UK.yaml file.

How to contribute

You can countribute to this repository as you would do with any other Git repository like this.

Naming system

Each file must be named like the language they represent + the code of the country capitalised. For example, for United Kingdom's English: en-UK.yaml. Each file should also contain a flag representing the main country where the subject language is spoken (See en-UK.yaml's first line).

How to translate

  • As you translate to your original language, always use en-UK.yaml as a base for translation and not other languages, as they might be outdated.

  • You should try to preserve as much as possible the original message. That is, you can of course change the structure of the phrase to best fit the language, but keep the original formatting, syntax, punctuation, usage of emojis, etc.

  • If you don't like a message If you wish to change a specific message because you think it is more fitting the bot, do not edit it in the translation, but edit before the original en-UK.yaml file.

How to write a yaml file

You can simply write a line like this:

message-to-translate: This is my message.

If the first character is special, you should use double quotes:

message-to-translate: "%message% is my message."

You should also use quotes if the string contains :.

To write a multiline message, use a bar:

message-to-translate: |
  This is my multiline 
  
  message.

Keep the same lines

As you translate to another language, please make sure that same position is kept. This means that on the same line of the two different files, you will find the same message.

Variables

You will find variables in some messages. Those are words surrounded by % that will be replaced with a dynamic string by the bot. For example in :

tempchannel-panel-title: "%owner%'s Private Chat"

%owner% will be replaced with the owner's name.

Variables shouldn't be translated or edited in any way.