Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #766

Closed
wants to merge 10 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# nebulous-translations

## Purpose
The sole purpose of this repository is to allow Nebulous players to collectively improve the translated text used in Nebulous.io [[Android](https://play.google.com/store/apps/details?id=software.simplicial.nebulous)][[iOS](https://apps.apple.com/us/app/nebulous-io/id1069691018)]. Include your Nebulous ID in your PR (Pull Request) comments and you may be granted the translator tag in the game and discord after your PR is approved and merged. **Low quality translations (those receiving a high number of comments compared to the number of translations done), will not receive a tag.**
The sole purpose of this repository is to allow Nebulous players to collectively improve the translated text used in Nebulous.io [[Android](https://play.google.com/store/apps/details?id=software.simplicial.nebulous)][[iOS](https://apps.apple.com/us/app/nebulous-io/id1069691018)]. Include your Nebulous ID in your PR (Pull Request) comments and you may be granted the translator tag in the game and discord after your PR is approved and merged. **Low quality translations (those receiving a high number of comments compared to the number of translations done), will have their PR closed and will not receive a tag.**

## Instructions
If you have general questions or a suggestion, create an [issue](https://github.com/simplicialsoftware/nebulous-translations/issues). You can also submit a [suggestion](https://discord.com/channels/941543004026572811/941680724963123200) in the discord.
Expand All @@ -20,6 +20,10 @@ Open the `res` folder to see all of the supported languages. `res/values` contai
- Try not to change the *length* of a string too much from the length in the English version. The app UI layout is tested with those string lengths.
- **Do not** submit auto translations (Google Translate, Chat GPT, etc). This is not helpful.
- Adding comments to your PR that explains why subtle changes were made can help. If you are revising something that is already translated, an explanation is **required**.
- Only edit files if you see something wrong with the translations. You must check in-game first if there's a typo, missing punctuation, term used on invalid context or any similar mistake, so you can look for the string line that belongs to that/those specific text(s) to be corrected for your language.
- The Translator tag cannot be distributed "for free" by making small, random or inconsistent changes on the file, therefore, doing it just for the tag is not worth it. It's mandatory that you have at least knowledge on the English language and make sure you have a good writing on your native language or **any** other language you are about to change. The game translation algorithm must always be taken very seriously.
- While analyzing a language file, avoid using web-translators provided by browsers like Chrome, Edge, Firefox, Opera, Safari etc., it may result in a confusion between the original value because of the bottom lines `_` and the translation. The GitHub website currently only supports English language.
- In case you still feel in need of an assistance, go to [ticket](https://discord.com/channels/941543004026572811/942039671687479336), open in category "Other" and a collaborator from this repository may assist you in all the steps.

### Languages
`res/values`: English<br>
Expand Down Expand Up @@ -109,9 +113,9 @@ You can always message @critikangel on Discord for help, advice, or support.
Submit an [issue](https://github.com/simplicialsoftware/nebulous-translations/issues). Include a screenshot of the text and any relevant actions you performed.

#### Why don't all languages have the same strings?
If a language is missing a line of text, see if it's in values (English). If it is, and it has the `translatable=false` tag, you can:
If a language is missing a line of text, see if it's in values (English). If it is, and it has the `translatable="false"` tag, you can:
1. Add it to another language file in the same order as the English file
2. Change the tag to `translateable=true`
2. Change the tag to `translatable="true"`
3. Translate it.

## License
Expand Down