Tips for contributors

Contributing localizations

If you're fluent in a language other than English, you can contribute translations to the mod without knowing how to code. Please do not use Google Translate.

1. Find the 'ingame locale code' for your language (listed here: https://minecraft.fandom.com/wiki/Language). Ex. Russian is ru_ru.
2. Look in the lang folder for the latest MC version (ex. MC1.19 is https://github.com/Crossroads-Development/Crossroads/tree/1.19/src/main/resources/assets/crossroads/lang). If there's already a language file for your language, modify that one. Otherwise, create a new text file called .json (ex. ru_ru.json). You can edit it with any basic text editor (like Notepad).
3. Open the English language file (en_us.json) in another tab. This has all the things that need to be translated.
4. Copy the format in en_us.json when writing your language file, and replace the English text with translations. Ex. in the English file, there is "item.crossroads.gem_ruby": "Ruby",, while in the ru_ru.json file is the translation, "item.crossroads.gem_ruby": "Рубин",. Do not translate the text on the left of the :, only on the right. Anything you choose not to translate, just don't include a line for it. Do not leave in a 'dummy' translation for untranslated text- the game will automatically default to English for anything that hasn't been translated.
5. When you're finished writing translations, make a PR to add your language file into the lang folder, or post the lang file on the Crossroads Discord and a maintainer can take care of the PR for you. Please let us know if you want your name added to the mod credits.

Contributing textures/sounds/etc

If you're only interested in contributing improved textures/sounds/etc (also called 'assets'), and aren't interested in committing code, you can either make a PR as normal, or post your new assets in the Crossroads Discord and one of the maintainers can manage PR-ing them for you. Please let us know if you want your name added to the mod credits.

Checklist for PRs

Recommended checklist for new PRs to make sure it's more likely to work and be accepted:

• Did you test it ingame?
• Did you update the documentation (the guidebook) for any new/changed features?
• Did you use the required code format? There's a premade editor settings file: https://gist.github.com/Da-Technomancer/b9a5ab70985712e0d91961fb1af0e5a0
• Do you have the rights to all assets? (If it includes textures/sounds/etc, we have to respect IP and not use anything we don't have the right to release under the MIT license)