Official NucleusBot Translations

#1

NucleusBot Translations

Here at NucleusBot we want to offer streamers the ability to make the most of their streams, and to make them as easy as possible. While many streamers may be bilingual and capable of using the majority of bots that are only available in English, we want to give the opportunity for streamers to use a bot that is available in their native tongue.

Since the beginning of NucleusBots development, we have been working to achieve this goal wherever possible. Below is an outline of how NucleusBot reads translation files and displays them during use. This information is also included in the provided zip file in the form of a README.md

Contributing

If you would like to help by contributing to the official translations please see the files listed. If you find any mistranslations, typos, or errors please comment below.

A repository may be made on GitHub in the future.

Current Available Translations (Language - Contributors)

English (en_US)
Norwegian (nb_NO) - Nicomedes

README.MD

INTRODUCTION

NucleusBot uses “.properties” files to parse and store text at startup.
Each property is stored with a defined “key”, which is used to fetch the necessary value when needed, as so:

KEYS

key = Value

Each key is provided in lowercase-snakecase. Values can be provided in any casing needed. Please refer to the “English” files provided for examples.

ARRAYS

Keys that end with a “[]” are ARRAYs. These keys support multiple Values that are separated by a semi-colon “;”

key = Value1;Value2

ArrayValues can be split into multiple lines using a backslash “\

key = Value1;\
Value2;\
Value3

EMBEDDING

A “Value” may also contain other Keys within them by using curly brackets {} like so {key2}.
This is called “Embedding” which includes another language value in the current one.

key1 = World
key2 = Hello {key1}

“key2” as shown above would display “Hello World”.

Keys from a separate language file may be used by including that files name within the brackets, separated by a colon “:”, {file_name:key}.

key = {example:key}

Embedded keys may also include a value from an array.
Including an ArrayValue will pick one of the values from the array at RANDOM when ran.

key1 = {key_array[]}
key2 = {example:key_array[]}

VARIABLES

The “Value” for each key may contain a “Variable” which will be added to the Value at runtime, and may include usernames, numeric values, or otherwise.

Variables are set as follows

%s - Represents a string, Can be a username, rank, or parsed numeric value (1,000)
%d - Represents an integer/digit. Can be a representative length of time, or other value
%1$ - The n^th provided variable, “%n$”, if order of variables needs to be repeated or changed.
%n$s - Represents the n^th variable as a string. Replace “n” with a digit
%n$d - Represents the n^th variable as an integer/digit. Replace “n” with a digit

The number of Variables in the “Value” MUST be equal to the number of Variables as provided in the “English” examples. Failure to do so may cause errors while the bot is running.
The “Empty” folder provided may be copied or overwritten to compensate for a new set of Language files.

pinned #2