Skip to content
Brandon edited this page Jan 23, 2022 · 4 revisions

Guide for translators

Introduction

First of all, thank you very much for willing to translate the Stop Mod Reposts plugins! With modders coming from all across the globe, it's important that our plugins are available in as many languages as possible. However, the plugin developer doesn't speak all of the world's languages, so we need your help translating! This guide will tell you which files you need to edit and what changes need to be done in order for the translation into your language to go live. Please make sure you read through the entire guide before you start translating in order to avoid problems that will delay the inclusion of your translation into the plugins. You must be highly skilled in the language you are translating to, or (preferably) be a native speaker of that language, to be considered.

Where to translate

All translations should be submitted through this Crowdin project. If your language is not listed, please open an issue on the issue tracker here or tag project maintainer mectag#7884 on the Discord server.

messages.json

This file contains the strings used in the extensions themselves. Sometimes, the message contains a word enclosed in dollar signs $ and has an accompanying placeholders block. The dollar-enclosed word must not be translated as it is a placeholder that will be replaced with something else in the extension. Here's an example of such an entry:

Rating for $site$

In the above example, $site$ is a placeholder. In this case, $site$ will be replaced with a domain name when displayed, and an example has been given on the Crowdin page. That means when you translate, you would translate message as it would be if you assume $site$ means "example.com".

storedesc.txt

This file contains the description of the Stop Mod Reposts extension as it appears when opening it in the extension store. It is quite long, but chances are you will only ever have to translate it once. The entire file must be translated.

What you shouldn't translate

  • Names
    In both files, you will find references to Stop Mod Reposts, Minecraft and other entities. It is very important that you do not translate any of these names, including "Stop Mod Reposts" as it is the name of the campaign. You will also find references to the IRC channel #stopmodreposts, and references to various Twitter accounts. Take care to avoid translating these names.

  • Links and domains
    There will be references to StopModReposts.org in the extension's files, and links to this GitHub repository. Do not translate these.

  • Email addresses
    There will be reference to at least one email address in obfuscated form: "marius (at) varden (dot) info". This string should not generally be translated as it falls under the names and domains sections above. However, if you in your language pronounce email addresses with something other than "at" and "dot", these must be reflected in the translation. Important: Do not deobfuscate the address, i.e. do not use the actual @ and . signs in the translation. It is done that way to prevent spam.

Submitting translations

Strings must be approved by project maintainers before they will be uploaded to the web stores. Strings may be rejected on the following grounds:

  • The files are machine-translated (e.g. with Google Translate), or
  • The translation does not convey the same message as the original English translation

We will check every submitted translation to ensure that they adhere to these rules.

Please be aware that any contribution to this repository, including translations, are covered under the contributor license agreement and you may not contribute translations if you do not accept the terms outlined in that agreement.

Thank you for contributing, and happy translation!