Skip to content

Commit

Permalink
Mention gender-specific string detection in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ExcaliburZero committed Nov 12, 2023
1 parent 6cdd532 commit b811a54
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/source/other_scripts/extract_translation_strings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,24 @@ You also need to provide it a text file that lists all of the ids of the in-game
id,de_DE,en,eo,es_ES,es_MX,fr_FR,it_IT,ja_JP,ko_KR,pt_BR,zh_CN
MAGIKRAB_NAME,Magikrabbe,Magikrab,[!!! Máágííkŕááb !!!],Magikangrejo,Magikangrejo,Magicrabe,Magistaceo,マギカツギ,마법게,Magikaranguejo,魔术蟹
SPRINGHEEL_NAME,Sprungfeder,Springheel,[!!! Spŕííñgh̀ééééł !!!],Botajack,Botajack,Ressortalon,Saltatore,ピョンジャック,폴짝깨비,Saltamola,弹簧腿
HOPSKIN_NAME,Hoppskin,Hopskin,[!!! Hôôpškííñ !!!],Brincagarra,Brincagarras,Sautepeau,Balzospello,ホップスキン,홉스킨,Pulagarra,蝠普金斯
HOPSKIN_NAME,Hoppskin,Hopskin,[!!! Hôôpškííñ !!!],Brincagarra,Brincagarras,Sautepeau,Balzospello,ホップスキン,홉스킨,Pulagarra,蝠普金斯
Gender-specific strings
-----------------------
Some in-game strings are able to have different variants based on the player character's pronouns. For example, `AA_CUBE_POST_BATTLE_MEREDITH3` has three variants:

* `AA_CUBE_POST_BATTLE_MEREDITH3.f` (if player has she/her pronouns)
* `AA_CUBE_POST_BATTLE_MEREDITH3.m` (if player has he/him pronouns)
* `AA_CUBE_POST_BATTLE_MEREDITH3.n` (if player has they/them pronouns)

This script is able to automatically detect strings that have gender-variants, and will include all three versions of the string in the output csv.

.. code-block:: bash
$ cat strings.txt
AA_CUBE_POST_BATTLE_MEREDITH3
$ cat translated_strings.csv
id, ...
AA_CUBE_POST_BATTLE_MEREDITH3.f, ...
AA_CUBE_POST_BATTLE_MEREDITH3.m, ...
AA_CUBE_POST_BATTLE_MEREDITH3.n, ...

0 comments on commit b811a54

Please sign in to comment.