|
| 1 | +<!--Readme.md v2.0.0.0 --> |
| 2 | +<!--Localization project --> |
| 3 | +<!--created: --> |
| 4 | +<!--updated: 30 Aug 2021 --> |
| 5 | + |
| 6 | +<!--from: @HebruSan (thank you)  --> |
| 7 | + |
| 8 | +# Translating to your language |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | +The 1.3 release of KSP introduces localization, which allows in-game text to be translated to other languages. This allows more people to enjoy the game in their preferred language and enlarges the community. However, it does not happen automatically for mods; by default, a mod will appear in English regardless of the language of the base game. In order to have both the base game and mods available in the same non-English languages, some additional work must be done by the modder. |
| 13 | + |
| 14 | +Unfortunately, I only speak English, and I maintain this mod for free. This means I cannot create my own translations, and I cannot pay a professional translation service to produce high quality translations. The best I can do on my own is to use Google Translate, which is of dubious value for the terse, idiomatic strings needed in a KSP mod's UI. Instead, I must rely on the expertise of you, the multilingual KSP mod user, to tell me what good translations look like for your language. If you would like to help in this effort, please keep reading to learn how the mod's language files are structured and how to submit translations for use by others. |
| 15 | + |
| 16 | +Note: Even though you will appear to be editing the project's files, don't worry about making mistakes. Github will keep your changes separate from the main files until I have verified that they are OK to use. It is even possible for me to ask questions or request changes before your work is committed to the main files. |
| 17 | + |
| 18 | +## Languages Supported by Kerbal Space Program as of 1.12.2 |
| 19 | +- [ ] [![American English][EN]][EN] [American English][EN] <en-us.cfg> |
| 20 | +- [ ] [![Brasil ][BR]][BR] [Brazilian ][BR] <pt-br.cfg> |
| 21 | +- [ ] [![中文][CN]][CN] [Chinese (中文)][CN] <zh-cn.cfg> |
| 22 | +- [ ] [![Deutsch][DE]][DE] [German (Deutsch)][DE] |
| 23 | +- [ ] [![Español][ES]][ES] [Spanish (Español)][ES] |
| 24 | +- [ ] [![Français][FR]][FR] [French (Français)][FR] <fr-fr.cfg> |
| 25 | +- [ ] [![Italiano][IT]][IT] [Italian (Italiano)][IT] <it-it.cfg> |
| 26 | +- [ ] [![日本語][JA]][JA] [Japanese(日本語)][JA] <ja.cfg> |
| 27 | +- [ ] [![한국어][KO]][KO] [Korean (한국어)][KO] <ko.cfg> |
| 28 | +- [ ] [![Mexicano][ME]][ME] [Mexican (Mexicano)][ME] <es-mx.cfg> |
| 29 | +- [ ] [![Dutch][NL]][NL] [Dutch][NL] <nl-nl.cfg> |
| 30 | +- [ ] [![Norsk][NO]][NO] [Norwegian (Norsk)][NO] <no-no.cfg> |
| 31 | +- [ ] [![Polski ][PO]][PO] [Polish (Polski) ][PO] <pl.cfg> |
| 32 | +- [ ] [![Русский][RU]][RU] [Russian (Русский)][RU] <ru.cfg> |
| 33 | +- [ ] [![Svenska][SW]][SW] [Swedish (Svenska)][SW] <sw-sw.cfg> |
| 34 | +- [ ] [![国语][TW]][TW] [Taiwanese (国语)][TW] <zh-tw.cfg> |
| 35 | + |
| 36 | +## Creating or editing a translation |
| 37 | + |
| 38 | +It is recommended to make your changes on your own computer at first so you can test them before uploading, especially if you are creating a new translation from scratch. |
| 39 | + |
| 40 | +1. Install the current release of xxx mod if you have not already |
| 41 | +2. Open your `Kerbal Space Program/GameData/xxxMod/Localization` folder on your local disk |
| 42 | +3. Look for a file called *lang*.cfg, where *lang* is KSP's name for your locale; as of KSP 1.3, this includes: |
| 43 | + - en-us (English) |
| 44 | + - es-es (Spanish) |
| 45 | + - ja (Japanese) |
| 46 | + - ru (Russian) |
| 47 | + - zh-cn (Chinese) |
| 48 | + |
| 49 | +The remaining steps are different depending on whether the file already exists: |
| 50 | + |
| 51 | +### If the file exists |
| 52 | + |
| 53 | +Follow these steps to make improvements to an existing translation: |
| 54 | + |
| 55 | +4. Edit the file for your language in your favorite text editor |
| 56 | +5. Make the changes you wish to see in-game (see the [File format section](#file-format) below for details) |
| 57 | +6. Save your changes |
| 58 | +7. Remember to [test your changes](#testing)! |
| 59 | + |
| 60 | +### If the file does not exist |
| 61 | + |
| 62 | +Follow these steps to start your own translation from scratch: |
| 63 | + |
| 64 | +4. Make a copy of `en-us.cfg` in the `Localization` folder |
| 65 | +5. Rename the file according to the list of languages above |
| 66 | +6. Edit the file for your language in your favorite text editor |
| 67 | +7. Change the third line from `en-us` to the string for your language |
| 68 | +8. Translate each string from English to your language (see the [File format section](#file-format) below for details) |
| 69 | +9. Save your changes |
| 70 | +10. Remember to [test your changes](#testing)! |
| 71 | + |
| 72 | +### File format |
| 73 | + |
| 74 | +The middle part of the `cfg` file contains the strings to translate. The format is `name = translation`, where the name is a special string defined by the mod. For example: |
| 75 | + |
| 76 | + #launchSubtitle = Transfers from <<1>>\n(Launch ~<<2>>) |
| 77 | + |
| 78 | +Do **not** change the part to the left of the equals sign ("=")! These names must be the same in every language file. |
| 79 | + |
| 80 | +The part to the right of the equals sign is the string to be used in-game. Most of the text will be shown as-is, but it can contain a few special strings as shown in the [Lingoona grammar module demo](http://lingoona.com/cgi-bin/grammar#l=en&oh=1): |
| 81 | + |
| 82 | +| String | Purpose | |
| 83 | +| --- | --- | |
| 84 | +| \n | Line break; try to preserve these based on the original strings to make sure the strings will fit | |
| 85 | +| <<1>> | The first substitutable token in the string, will be replaced by a number, name of a planet, etc., depending on the string | |
| 86 | +| <<2>> | Second token, and so on | |
| 87 | +| <<A:1>> | The first token, but substituted with a proper article | |
| 88 | + |
| 89 | +For example, this is a possible translation of the above line into Spanish, courtesy of Google Translate: |
| 90 | + |
| 91 | + #launchSubtitle = Transferencias desde <<1>>\n(Lanzamiento ~<<2>>) |
| 92 | + |
| 93 | +### Testing |
| 94 | + |
| 95 | +It's important to make sure that your changes work correctly. If you use Steam: |
| 96 | + |
| 97 | +1. [Select the language to use in Steam](https://www.youtube.com/watch?v=iBwYCvQxfeI) |
| 98 | +2. Wait for the language pack download to complete |
| 99 | +3. Run KSP |
| 100 | +4. Use the xxxMod ingame and make sure your changes appear as you intended |
| 101 | + |
| 102 | +If you do not use Steam, I don't know the steps to choose a language. Contact SQUAD if you can't figure it out. |
| 103 | + |
| 104 | +## Contributing your translation for others to use |
| 105 | + |
| 106 | +After you have prepared a `cfg` file for your language and confirmed that it works as you intend, if you are willing to contribute it for redistribution under the xxxModd's license, follow these steps to upload it for inclusion in the main mod distribution: |
| 107 | + |
| 108 | +1. Log in to [Github](https://github.com); you may need to register an account if you do not already have one |
| 109 | +2. Navigate to the xxxMod's Localization folder |
| 110 | +3. Look for the file you edited |
| 111 | + |
| 112 | +The remaining steps are different depending on whether the file already exists: |
| 113 | + |
| 114 | +### If the file exists |
| 115 | + |
| 116 | +4. Click the file's name to view it |
| 117 | +5. Click the [pencil icon](https://help.github.com/assets/images/help/repository/edit-file-edit-button.png) to edit |
| 118 | +6. Replace the text with the pasted contents of the file you edited locally |
| 119 | +7. **Important**: At the bottom of the page, under Propose file change, type an English description of the changes you have made and the reason you think they should be made. This will help me to confirm that your changes are appropriate. Remember, I do not speak the language in the `cfg` file, so I need you to tell me why your way is better! |
| 120 | +6. Click `Propose file change` at the bottom when done |
| 121 | + |
| 122 | +### If the file does not exist |
| 123 | + |
| 124 | +4. Click [Create new file](https://help.github.com/assets/images/help/repository/create_new_file.png) to create it |
| 125 | +5. Enter the correct file name in the box at the top |
| 126 | +6. Paste the contents of the file you edited locally into the big box in the middle |
| 127 | +8. Click `Propose new file` at the bottom when done |
| 128 | + |
| 129 | +### Review |
| 130 | + |
| 131 | +Once you finish your changes, Github will send me a notification that a pull request has been submitted. I will take a look at it within a day or two and attempt to verify that the changes make sense by: |
| 132 | + |
| 133 | +- Confirming that the file name and the third line of the file match one of the supported locale names |
| 134 | +- Viewing each changed string in-game |
| 135 | +- Checking Google Translate |
| 136 | +- Asking individual human experts |
| 137 | +- Requesting help on the KSP forum |
| 138 | + |
| 139 | +If I have any questions about specific changes you've made, I will add them to the pull request, which should trigger a notification to you. Please try to respond to these in as timely a manner as you can manage. Your pull request may be closed without merging if you do not reply for a long time. |
| 140 | + |
| 141 | +Once all the questions and comments are resolved to my satisfaction, your changes will be merged into the main files and included in the next release. I will also add your Github name to the Acknowledgements section of the README file. |
| 142 | + |
| 143 | + |
| 144 | + |
| 145 | +[EN]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/American-flag-sm.png "American English" |
| 146 | +[BR]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Brazilian-flag-sm.png "Brasil" |
| 147 | +[CN]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Chinese-flag-sm.png "中文" |
| 148 | +[DE]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/German-flag-sm.png "Deutsch" |
| 149 | +[ES]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Spanish-flag-sm.png "Español" |
| 150 | +[FR]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/French-flag-sm.png "Français" |
| 151 | +[IT]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Italian-flag-sm.png "Italiano" |
| 152 | +[JA]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Japanese-flag-sm.png "日本語" |
| 153 | +[KO]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/South-Korean-flag-sm.png "한국어" |
| 154 | +[ME]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Mexican-flag-sm.png "Mexicano" |
| 155 | +[NL]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Dutch-flag-sm.png "Dutch" |
| 156 | +[NO]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Norwegian-flag-sm.png "Norsk" |
| 157 | +[PO]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Polish-flag-sm.png "Polski" |
| 158 | +[RU]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Russian-flag-sm.png "Русский" |
| 159 | +[SW]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Swedish-flag-sm.png "Svenska" |
| 160 | +[TW]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Taiwanese-flag-sm.png "国语" |
| 161 | +[HA]: https://raw.githubusercontent.com/zer0Kerbal/zer0Kerbal/zed'K/Localization/img/Hawaii-flag-sm.png "ʻŌlelo Pākē" |
| 162 | + |
| 163 | +<!-- CC BY-ND-3.0 unported --> |
| 164 | +<!-- zer0Kerbal --> |
0 commit comments