Language Contributions - ahmadmuhsen/ogame-acs-split GitHub Wiki

Introduction

The system currently supports the following languages:

  • English
  • Balkan
  • Danish
  • French

If you wish to contribute in improving language support in the system, whether by adding a new language or editing the text of an existing one, please read this section for instructions.

Ways to contribute

If you are familiar with how github and JSON files work, you can create a new pull request and directly edit the language folder. This is the recommended way to do it since your name will appear as a contributor to this project. After you're done, you can push the changes and the team will review and merge them to the develop branch after approval, which will eventually be included in the next release.

If you are not familiar with pull requests and you wish to contribute directly on github, you can follow the below instructions:

  1. Login to your github account or create a new one.
  2. Open the language folder on github.
  3. Open a language file, you will find the edit icon, this will allow you to fork the project and edit the language file as you wish without affecting the original file.
  4. Do the modifications as you wish.
  5. Click on Propose Changes after writing a title and an extended description to what you've modified.
  6. When you're done, click on Create Pull Request. If you follow these steps, we will be able to review the changes and merge it.

You can also read more about creating pull requests here.

In the case the you are not familiar with github and do not wish to use it to contribute, you can go to this google drive folder that contain spreadsheets of all the current available languages. Read the instructions in the sections below for more information.

Editing the Text of an Existing Language

If you wish to fix mistakes(grammar or spelling) or to translate words and sentences not yet translated, the easiest way to do so is by editing the language file in the language folder directly after creating a new pull request. The file is in JSON format, so it is important to maintain the integrity of the file format. The file is built in the following manner:

{
    "translation": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
}

You will only be editing the value part of the key-value object. Choose the language you want to edit according to the code in place of the placeholder language_code.

In case you don't want to contribute via github, go to the languages google drive folder and download the language spreadsheet you want. The spreadsheet will have two columns, key and value. You will only be editing the value column. After the modifications are done, you can send the file to the contact information listed at the end of this page and the team will review and apply the modifications.

Adding New Languages

If you're familiar with JSON files, then adding a new language would require you add a new language file in the language folder. Adding a new language would look like this:

{
    "translation": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
}

You can copy one of the existing language files, rename it to the new language and translate the values of each key. After creating the pull request, our team will review the addition and add the new language to the system.

In case you don't want to contribute via github, go to the languages google drive folder and download the "New Language Template" spreadsheet. The spreadsheet will have three columns: key, english_value, new_value. You will be translating the english_value column and filling it in new_value. After the translations are done, you can send the file to the contact information listed at the end of this page and the team will review and add the language.

Contact Information

If you chose to contribute by using the spreadsheets instead of pull requests, you can send the spreadsheet to the following email: [email protected].

Contributors

Balkan

Danish

French