|
1 |
| -# Language Files |
| 1 | +# Supported Languages |
2 | 2 |
|
3 |
| -Language files are used in Essence to serve messages to players |
| 3 | +| Language | Code | Supported | Since | |
| 4 | +|----------------------|-------|--------------------------------------------------|-------| |
| 5 | +| Bengali | bn-BD | ❌ File exists but is not enabled, not translated | 1.6.0 | |
| 6 | +| British English | en-GB | ✅ Fully | 1.0.0 | |
| 7 | +| Chinese (Simplified) | zn-CN | ✅ Fully | 1.6.0 | |
| 8 | +| French | fr-FR | ⚠ Limited support | 1.6.0 | |
| 9 | +| German | de-DE | ❌ File exists but is not enabled, not translated | 1.6.0 | |
| 10 | +| Hindi | hi-IN | ❌ File exists but is not enabled, not translated | 1.6.0 | |
| 11 | +| Japanese | ja-JP | ❌ File exists but is not enabled, not translated | 1.6.0 | |
| 12 | +| Korean | ko-KR | ❌ File exists but is not enabled, not translated | 1.6.0 | |
| 13 | +| Portuguese | pt-PT | ❌ File exists but is not enabled, not translated | 1.6.0 | |
| 14 | +| Spanish | es-ES | ❌ File exists but is not enabled, not translated | 1.6.0 | |
| 15 | +| Turkish | tr-TR | ❌ File exists but is not enabled, not translated | 1.6.0 | |
| 16 | +| Vietnamese | vi-VN | ❌ File exists but is not enabled, not translated | 1.6.0 | |
4 | 17 |
|
5 |
| -These are automatically updated whenever you update your plugin. |
| 18 | +## Translate Essence |
| 19 | +We use Crowdin to provide translations for Essence, it automatically synchronises to our GitHub repository so any changes are automatically pushed with the next Essence update. |
| 20 | + |
| 21 | +Translate to Crowdin: [https://crowdin.com/project/lewmc-essence](https://crowdin.com/project/lewmc-essence) |
6 | 22 |
|
7 |
| -We currently only support en-gb, you can see a [template here](https://github.com/lewmilburn/Essence/blob/main/src/main/resources/language/en-gb.yml) if you'd like to create a translation. If you have created a translation and would like to add it to Essence please open an issue on our [GitHub](https://github.com/lewmc/essence), thank you. |
| 23 | +## Language Files |
8 | 24 |
|
9 |
| -## Creating a new language file. |
10 |
| -> Essence may require restarting after changing the file it uses to grab messages, if you're editing a file that is already set as active in config, no restart is required. |
| 25 | +Language files are used in Essence to serve messages to players |
| 26 | + |
| 27 | +These are automatically updated whenever you update your plugin. |
11 | 28 |
|
| 29 | +### Creating a new Language File |
| 30 | +> Please consider translating essence to [Crowdin](https://crowdin.com/project/lewmc-essence) so that others can use the language too! |
12 | 31 | 1. Create a new .yml file in the /plugins/essence/languages folder. You should give it a unique name such as custom.yml
|
13 |
| -2. Copy the contents of en-gb.yml to this file. |
| 32 | +2. Copy the contents of  to this file. |
14 | 33 | 3. Customise any messages you wish to.
|
15 | 34 | 4. Change the language option in config.yml to the name of your file without the yml ending (e.g. "custom").
|
0 commit comments