Introduction and Contribution Guide

Hello, and thank you for your interest in contributing translations to COMP/CON and Lancer!

COMP/CON localization includes three components: COMP/CON UI, lancer-data (Compendium), and the PC-facing free SRD. As of this writing, only the COMP/CON UI has been prepared to accept translations, and the remaining two sections will open in future phases.

The currently-targeted languages are:

- العربية - Arabic (ar)
- Deutsch - German (de)
- Español - Spanish (es)
- Français - French (fr)
- हिन्दी - Hindi (hi)
- Italiano - Italian (it)
- 日本語 - Japanese (ja)
- 한국어 - Korean (ko)
- Português - Portuguese (pt)
- Русский - Russian (ru)
- 中文 - Chinese Simplified (zh_Hans)

Project Structure

All translation work is done in Weblate, who have graciously provided COMP/CON with free localization hosting under their Libre program. The Weblate project can be found here: https://hosted.weblate.org/projects/compcon/

The backing repository for the project can be found at https://github.com/massif-press/compcon-locales. No PRs should be made against this repository, Weblate will handle this automatically.

As COMP/CON is updated, the C/C repo will issue changes to compcon-locales, which will then propagate to the Weblate project. Strings will be added and (occasionally) changed. Translation progress can be seen in the Weblate project, the COMP/CON About panel, or the COMP/CON language selector.

Contributing Translations

Everyone is welcome to contribute translations! This can be done by creating a free Weblate account. Once logged in, proceed to the COMP/CON Project

From the Languages view, select your target language and proceed to the translation overview page:

From here, clicking the Browse (all strings) or Translate (strings requiring attention) buttons will take you to the Weblate translate interface:

Translations can be added here, as well as suggestions (which are not transmitted to COMP/CON and only remain in Weblate for other translators' evaluation). Once saved, the string is moved into compcon-locales at intervals, and is then moved into dev.compcon, and finally to the main compcon.app site

For more in-depth instructions on navigating and translating on weblate, please see Weblate's comprehensive guide, available in many languages.

Technical details about adding translations and working with COMP/CON string syntax can be found in the compcon-locales repo's CONTRIBUTOR.md

Reporting Errors

For translation errors, please open a new ticket in compcon-locales and select "Translation Error". These tickets will be automatically ordered into the Localization and Accessibility project for ease of tracking.

To challenge a translation or request clarification, please open a new discussion in the appropriate language category on the Massif Press discussion board at https://github.com/orgs/massif-press/discussions. It is strongly recommended to also post your question in the relevant thread in the #cc-localization channel of the Lancer Discord, especially if it is something that requires discussion or community agreement. Feel free to tag the cc-dev role to request clarification.

Reporting an error in the base strings, string templates, or UI handling of a translated string should be done in the compcon repo at https://github.com/massif-press/compcon/issues

Requesting New Languages

Because Weblate's Libre program is not unlimited and the translation surface for COMP/CON and Lancer is quite large, new language requests must be considered against program limits. A new language request can be made in compcon-locales and will be evaluated before acceptance/rejection. Languages without potential active translators or without a large and active Lancer community unfortunately cannot be considered at this time.

Other Concerns

For questions, comments, and ideas not tied to a specific language, please make a post in the "COMP/CON Localization - General" discussion channel and/or post in the COMP/CON and LANCER Localization thread in the Discord's #cc-localization channel