Introduce map selection localization support.

[Yuchenjimmy]

Description of the proposed changes

This PR introduces the ability to translate mission names, descriptions. Now the game will detect if a map has LOC entries for name and description, and it will have different outputs based on three conditions. Following are examples showing how it handles a mission name:

1. A map already has proper LOC support == return it normaly.
2. A Skirmish map without LOC support == return LOC('<LOC '..name..'_Name>'..str)
3. A FAF Coop map without LOC support == return LOC('<LOC FAF_Coop_'..name..'_Name>'..str)

Testing done on the proposed changes

1. Skirmish maps show translation correctly.

2. Campaign maps show translation correctly.

3. FAF Coop maps show translation correctly.

4. Maps without translation show original text as expected.

Additional context

Here are two corresponding pull requests:

1. Introduce the ability to translate mission objectives and descriptions: Add LOC entries for Coop Missions. faf-coop-maps#450
2. Corresponding localization strings: Add localization for faf campaign, and map scenario fa-coop#123

This pull request should have be created an years ago, lazy me.

Checklist

• Changes are annotated, including comments where useful
• Changes are documented in a changelog snippet according to the guidelines.
• Request 2-3 reviewers from the list of reviewers and their areas of knowledge.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d6ad5d50-05ce-4179-b061-f7d11542d85a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[speed2CZ]

its not a good idea to hardcode FAF_Coop_, it's a convention for custom missions, not a requirement.

[Yuchenjimmy]

Hi. FAF_Coop_ is not required in the mission name, folder, OPERATION_NAME, or OPERATION_DESCRIPTION. The function only checks whether the input already contains <LOC. If it does, it uses that value unchanged. If it does not, the function generates a LOC entry, and FAF_Coop_ is only part of that generated output.
For example, mission “Fort Clarke Assault” has original name OPERATION_NAME = 'Fort Clarke Assault', this function produces <LOC FAF_Coop_Fort_Clarke_Assault_Name>Fort Clarke Assault.
Therefore, FAF_Coop_ is not used to identify or validate a custom mission. It is only added when constructing the output localization key.

[speed2CZ]

In what cases is this actually gonna help? Generating the LOC tag won't do anything if there are no translations anyway?

[Yuchenjimmy]

In what cases is this actually gonna help? Generating the LOC tag won't do anything if there are no translations anyway?

Indeed. Just as you said, it will not have any effect until someone decides to help translate it into their own language. This simply provides an opportunity for those who may want to contribute translations in the future. With that in mind, I also created another PR that adds Traditional Chinese translations: FAForever/fa-coop#123. It is not finished yet, so I have left it as a draft for now.

There is another PR that directly adds LOC keys for the SC and SCFA campaign maps, which is also linked in the Additional context section above.

[speed2CZ]

In the code you've changed, there was only one place where the string was not localized, other 2 already called LOC on it, so what is the tag generation for exactly?

On its own it has no purpose and you're just guessing what the tags in the maps will be. But if the maps include tags, then you dont need to generate them.

[Yuchenjimmy]

The existing LOC function calls do not localize plain strings by themselves. For example, LOC('Fort Clarke Assault') just returns the same English text because there is no localization key to look up.

Most of co-op maps, including Fort Clarke Assault, provide plain names and descriptions. Only a small number of them already include LOC keys, for example:

OPERATION_NAME = '<LOC FAF_Coop_Havens_Invasion_Name>Haven\'s Invasion'

The generated tags follow this existing format. If a map already provides a LOC tag, the function preserves it; otherwise, it generates one for the plain metadata.

[speed2CZ]

If there are any maps that dont have the loc tags in names and actually have localazation strings avaialble, the tags should be added to the maps. It should not be generated.

If the map doesnt have any localization, generating tags won't help anything.

[Yuchenjimmy]

If there are any maps that dont have the loc tags in names and actually have localazation strings avaialble, the tags should be added to the maps. It should not be generated.

99% maps don't have loc tags, that's a lot of work. On the other hand, currently it's not required to add loc tags when making a map, which means it needs someone manualy to add them everytime there's a new map. With this PR, translators can just edit strings.lua for every map, without touching the map repo.

If the map doesnt have any localization, generating tags won't help anything.

Sorry, I don’t understand the connection here. Tags and localization serve different purposes, so a map not being localized doesn’t necessarily mean tags are useless. I will update Traditional Chinese strings, and it just needs somebody else to update other languages.