Merge pull request #20 from LyaaaaaGames/Develop

Localization 2.0.0 release

Author: Lyaaaaaaaaaaaaaaa

.gitignore

@@ -0,0 +1 @@
+*.mo

CONTRIBUTING.md

@@ -8,23 +8,25 @@ Go in **issues**, then click on **new issue** and select **bug report**
 
 ## The translation file
 
-This translation is stored in a .cvs file with the following format.
+All the strings to translate are stored in a `.pot` file. AIdventure use the [GetText](https://en.wikipedia.org/wiki/Gettext) system.
 
-| id   | `<lang1>` | `<lang2>` | `<langN>` |
-|------|-----------|-----------|-----------|
-| KEY  | string    | string    | string    |
-| KEY2 | string    | string    | string    |
-| KEY3 | string    | string    | string    |
+Then, each language has its own `.po` file.
 
 **You can find the language codes [here](https://docs.godotengine.org/en/stable/tutorials/i18n/locales.html)**
 
 ## How to modify / add new languages
 
-1. Download the [project](https://github.com/LyaaaaaGames/AIdventure_Localization/archive/refs/heads/Develop.zip).
-2. Edit it with either [libreoffice](https://www.libreoffice.org/) or [Google sheet](https://www.google.com/sheets). **Avoid Microsoft Excel** as it use the wrong encoding.
+First, you will require a software to edit or create your own translation.
 
-**If you need to add a new language, simply add a new column with the language id** (e.g "es" for Spanish).
+Multiple softwares exists but I will suggest PoEdit because it's free and open source.
 
+1. Download [Poedit](https://poedit.net/)
+2. Download the [project](https://github.com/LyaaaaaGames/AIdventure_Localization/archive/refs/heads/Develop.zip).
+2. If there is no existing file for your language, open the `aidventure.pot` with **Poedit**
+  1. If a file already exist, open the corresponding file `e.g: fr.po` for French.
+3. Poedit will suggest you to create a new translation file, do it.
+4. You can now translate AIdventure :).
+5. When done, send me the `.po` file.
 
 ## How to propose your modifications?
 1. Fork my project
@@ -34,3 +36,5 @@ This translation is stored in a .cvs file with the following format.
 5. Discuss / edit your pull request with me if needed
 6. Get merged! :D
 7. Get credited. UwU
+
+If you don't know how to use github, you can send the `[LANGUAGE_CODE].po` file directly to me by email at lyaaaaa@lyaaaaagames.com

README.md

@@ -1,17 +1,11 @@
 # AIdventure_Localization
 the localization of AIdventure.
 
-## Supported languages
+# Supported languages
+
+- English
+- French
 
-| Language   | Code   |
-|------------|--------|
-| English    | en     |
-| French     | fr     |
-| German     | de     |
-| Portuguese | pt     |
-| Spanish    | es     |
-| Catalan    | ca     |
-| Polish     | pl     |
 
 ## If you want to help translate the game, see the following docs