Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-12-25 18:47:50 +01:00
Code Issues Projects Releases Wiki Activity

Update Locale Documentation

Browse Source
This commit is contained in:
Rsl1122 2017-08-10 20:59:48 +03:00
parent a11e507308
commit 1839307e3e
2 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
documentation/Configuration.md
View File

@ -15,6 +15,7 @@ Config.Point | Version introduced | Type | Default | Description
--- | ---- | ------ | --- | ---------------------------------
Debug | 3.0.0 | boolean | false | Enables debug messages on console.
Locale | 2.5.0 | String | default | Two letter Locale combination. Can be set to one of the Available locales. If a faulty combination is used, default locale will be used. [Available locales](https://github.com/Rsl1122/Plan-PlayerAnalytics/tree/master/Plan/localization)
WriteNewLocaleFileOnStart | 3.6.2 | boolean | false | Setting this to true & reloading the plugin will generate a new locale.txt & it will be set back to false. [Localization](/documentation/Localization.md)
UseTextUI | 3.0.0 | boolean | false | Redirects */plan inspect* and */plan analyze* commands to display same messages as */plan qinspect* & */plan qanalyze*
Data.ChatListener | 3.4.2 | boolean | true | Enables Chat listener
Data.GatherKillData | 3.4.2 | boolean | true | Enables Death listener

21
documentation/Localization.md
View File

@ -2,30 +2,27 @@
# Localization
This article will tell you how you can change the messages seen in the plugin.
(Introduced in version 2.5.0)
(Introduced in version 2.5.0 & Revamped in 3.6.2)
By Default Plan uses internal Locale found inside Phrase.java & Html.java (Config setting: default)
- [Phrase](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/java/com/djrapitops/plan/Phrase.java)
- [Html](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/java/com/djrapitops/plan/ui/Html.java)
By Default Plan uses internal Locale found inside Locale.java (Config setting: default)
- [Locale](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/java/com/djrapitops/plan/locale/Locale.java)
## Config setting
In the config, there is a setting for Locale.
Setting this to, for example EN, will attempt to fetch locale from Github to be used with the plugin.
Unfortunately when this setting is used, the Color customization setting for commands is not used. This can be circumvented by copying the existing locale from Github to `/plugins/Plan/locale.txt` and changing the colors in the file.
Setting this to, for example FI, (Finnish) will attempt to use locale from inside the plugin jar.
Inside the plugin there are multiple locale files.
If you want to use your own locale, just copy contents of this file on github to `/plugins/Plan/locale.txt`
Now you can customize all in game messages!
You can generate a new locale (default values) by setting the config setting **WriteNewLocaleFileOnStart** to true.
This will generate a locale.txt to the plugin's folder & that will be used when present.
To change the messages, only change the parts on the right, left ones are identifiers.
Some messages in the html pages are not loaded from the text file, and need to be changed seperately.
This can be done by copying the html files from the .jar to the plugin folder and editing them.
- [Available Locales](https://github.com/Rsl1122/Plan-PlayerAnalytics/tree/master/Plan/localization)
## Known caveats:
- The 'äåö'-letters etc do not work on the webpage, this will hopefully be fixed in a future update.
## End
If you want to help me out with localizing the plugin to your language, you can translate the locale file to your language and send the contents to me in one way:
- Do a pull request