Created Configuring the plugin (markdown)

2020-01-18 12:05:47 +01:00
parent 0a15477783
commit f297283f38
1 changed files with 53 additions and 0 deletions
@@ -0,0 +1,53 @@
+### Main command message
+The /help command will always show the message specified under
+
+
+    lang:
+      la_ng:
+        1: |
+          >>>Here<<<
+
+### Subcommands
+For the subcommand to be recognized it has to have en_us version of itself specified in the config.yml
+You can simply go to the end of "en_us" section in fonfig and add a subcommand just by typing:
+
+***
+    yoursubcommand: |
+
+      Text to be shown after typing /help yoursubcommand
+***
+
+### Translating - adding a language
+To translate your new command, firstly, you have to add the locale tag of desired language to the "lang" section of the config. You can find full default locale list [here](https://minecraft.gamepedia.com/Language).
+After that you have to fill in translations of the error messages and your commands to that language section aswell. Example:
+
+***
+    lang:
+      en_us:
+        too-many-arguments: "Too many arguments"
+        invalid-argument: "Invalid argument"
+        invalid-page: "There is no page with that index"
+        1: |
+          &b-------- DynamicLangHelp (en_us) --------&r
+          Default help message for en_us locale!
+          See DynamicLangHelp/config.yml to change this message
+
+          You can add as many lines as you want, but remember,
+          that default client only shows 15 lines of text while
+          chat is open!
+    pl_pl:
+        too-many-arguments: "Zbyt dużo argumentów"
+        invalid-argument: "nieprawidłowy argument"
+        invalid-page: "Nie ma strony o takim indeksie"
+        1: |
+          &b-------- DynamicLangHelp (pl_pl) --------&r
+          Domyślna wiadomość pomocy dla lokalizacji pl_pl!
+          Sprawdź DynamicLangHelp/config.yml żeby zmienić tę wiadomość
+
+          Możesz dodać dowolną ilość linii, ale pamiętaj,
+          że domyślny klient pokazuje tylko 15 linii tekstu
+          przy otwartym czacie!
+
+***
+### Text formatting
+You can use default minecraft text formatting. You can find it [here](https://minecraft.gamepedia.com/Formatting_codes).