Update crowdin.yml

crowdin.yml

@@ -1,45 +1,62 @@
-project_id_env: '${{ vars.CROWDIN_ID }}'
-api_token_env: '${{ secrets.CROWDIN_TOKEN }}'
-base_url: 'https://api.crowdin.com'
-base_path: ./kubejs/assets
-pull_request_title: New Crowdin updates
-pull_request_labels:
-  - 'Pull request: Translation'
-commit_message: '[translation] New translations {fileName} ({languageName})'
-preserve_hierarchy: 1
+base_url: "https://api.crowdin.com"
+base_path: "."
+
+# For interacting with Crowdin locally (via CLI), set these environment variables to their proper values
+project_id_env: "CROWDIN_ID"
+api_token_env: "CROWDIN_TOKEN"
+
+pull_request_title: "New Crowdin updates"
+
+# Automatically label PRs made by Crowdin
+pull_request_labels: [ "Pull request: Translation" ]
+commit_message: "[translation] New translations"
+
+# Preserve directory structure (required by the use of the 'dest' field below)
+preserve_hierarchy: true
+
 files:
-  - source: /*/lang/en_us.json
-    translation: /%original_path%/%locale_with_underscore%.json
-    update_option: update_without_changes
+  - source: "/kubejs/assets/*/lang/en_us.json"
+    # Unfortunately, Crowdin doesn't have a placeholder which matches Minecraft's expected naming scheme: underscores
+    # with lowercase letters (since resource location are required to be fully lowercase).
+    #
+    # To make up for this unfortunate defect, **in the Crowdin interface**, we specify custom language mappings for
+    # the "%locale_with_underscore%" placeholder, converting the uppercase to lowercase in the original value.
+    #
+    # If you are adding a new language to the Crowdin project,
+    # ** MAKE SURE YOU ADD THE APPROPRIATE CUSTOM LANGUAGE MAPPING FOR THE PLACEHOLDER. **
+    translation: "/%original_path%/%locale_with_underscore%.%file_extension%"
+    update_option: "update_without_changes"
+    dest: "/messages.%file_extension%"
+    
     languages_mapping:
       locale_with_underscore:
-        en-US: en_us
-        en-GB: en_gb
-        zh-CN: zh_cn
-        zh-TW: zh_tw
-        es-ES: es_es
-        pt-BR: pt_br
-        pt-PT: pt_pt
-        sv-SE: sv_se
-        en: en_us
-        ru: ru_ru
-        uk: uk_ua
-        ja: ja_jp
-        de: de_de
-        fr: fr_fr
-        it: it_it
-        ar: ar_sa
-        hu: hu_hu
-        fi: fi_fi
-        ro: ro_ro
-        ca: ca_es
-        da: da_dk
-        el: el_gr
-        cs: cs_cz
-        he: he_il
-        ko: ko_kr
-        nl: nl_nl
-        pl: pl_pl
-        sr: sr_sp
-        tr: tr_tr
-        vi: vi_vn
+        en-US: "en_us"
+        en-GB: "en_gb"
+        zh-CN: "zh_cn"
+        zh-TW: "zh_tw"
+        es-ES: "es_es"
+        pt-BR: "pt_br"
+        pt-PT: "pt_pt"
+        sv-SE: "sv_se"
+        en: "en_us"
+        ru: "ru_ru"
+        uk: "uk_ua"
+        ja: "ja_jp"
+        de: "de_de"
+        fr: "fr_fr"
+        it: "it_it"
+        ar: "ar_sa"
+        hu: "hu_hu"
+        fi: "fi_fi"
+        ro: "ro_ro"
+        ca: "ca_es"
+        da: "da_dk"
+        el: "el_gr"
+        cs: "cs_cz"
+        he: "he_il"
+        ko: "ko_kr"
+        nl: "nl_nl"
+        pl: "pl_pl"
+        sr: "sr_sp"
+        tr: "tr_tr"
+        vi: "vi_vn"