From 68e7b708f2993ee762c73eac78760283b2efff88 Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Fri, 1 Nov 2024 13:38:30 -0500 Subject: [PATCH] add md --- translations.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 translations.md diff --git a/translations.md b/translations.md new file mode 100644 index 0000000..1dec760 --- /dev/null +++ b/translations.md @@ -0,0 +1,20 @@ +# Translations +Currently Jank Client is only in english, though I've added support for other languages in the codebase now, if you or someone else wishes to try and help us create these translations it should be rather simple. +the translations are stored in `/src/webpage/translations` if you want to help translate a pre-existing translations, you would modify the JSON files there, if you wish to add a new translation that should also be somewhat straight forward +Firstly, modify `en.json` to include your languages file like for example for russian it'd be `"ru": "/translations/ru.json"` so jank client knows where the translation is, then you'd create the file and make sure to include a `"@metadata"` thing at the top to credit yourself, then in the file you'll want to create a property of the object corisponding to the language you're trying to add, for example +```json +{ + "@metadata": { + "authors": [ + ], + "last-updated": "XXXX/XX/XX", + "locale": "ru", + "comment":"" + }, + "ru":{ + } +} +``` +Then to add the actual translations, just take the english version and in the same structure add your language, you must keep the left side, as that's what jank needs to know what the translation is. + +Thank you so much for contributing another lanuage, or even just parts, as jank will fall back to the english translation if your translation has gaps in it, so it's not all or nothing