If you are interested in translating Miasmata into your language please get in touch!

There's some parts of the translation that you can get started with right away from the instructions on this page, but others need a bit of technical work which I can take care of.

If you get in touch I can also make sure people aren't duplicating effort translating into the same language.

Translator: Gooby
http://psteamcommunity.yuanyoumao.com/app/223510/discussions/0/540741859566627042/

https://psteamcommunity.yuanyoumao.com/app/223510/discussions/0/483368433106728776/

https://psteamcommunity.yuanyoumao.com/sharedfiles/filedetails/?id=686531105
https://psteamcommunity.yuanyoumao.com/sharedfiles/filedetails/?id=2642614367
Translator: Khalashnikovf
Status: Interest registered.

Possible Translator: Eternie
Status: Interest in helping out registered.

This is something you can start working on pretty easily without my help.

1. Download Miasmod v1.2 or later from here: http://psteamcommunity.yuanyoumao.com/app/223510/discussions/0/630800445647188169/
   
2. In Miasmod click 'New Mod' and give it an appropriate name (like 'french'). If you come back to edit it later you can double click it in the Environment Mods list.
   
3. Go through the list in Part 1A and find each item in the tree view. Edit the text for each one remembering to periodically save your changes.

• Whenever you save the mod, Miasmod will ask you if you want to synchonise alocalmod - you should do this so you can see the results in-game.
  
• Don't bother with the glance left/right key bindings - these aren't used in the game and the community patch removes them from the menu.
  
• The supported encoding is Windows-1252 (AKA Code page 1252), which supports latin characters including most accented characters. If you try to use any characters that are not supported by that encoding scheme Miasmod will give you a warning and will remove the unsupported characters. See the wikipedia article for a table of supported characters: https://en.wikipedia.org/wiki/Windows_1252 (note that this restriction does not apply in part 2 - there we are only limited by the characters that the fonts support, and we can always use other fonts if needed).
  
• When you see a word in curly brackets it will be replaced with the key(s) the user currently has bound to that action, so this word should not be translated. e.g. "Take it with {ACTIVATE}"
  
• The font size can be adjusted under menus→fonts→default→height if some of the translated text is too large. Try not to reduce this too much if you can avoid it - for the French translation we only reduced it by 1.
  
• Some of the text in the menus is hardcoded in the executable and can't be translated. This is mostly limited to the settings menus and is things like "low", "medium", "high", "full screen", "windowed", "inverted". Fortunately the descriptions of the settings can be translated and these all have sliders so users can probably guess what they are.

Bonus: In the French translation, Gooby and I added our names to the credits, by inserting new slides before page 8 under endgame→ENDING2 then re-ordering the later pages. This change also needs the corresponding textures made in part 2 below.

NOTE: I had to remove some of the English text due to the section character limit, particularly the "Press {HELP}..." messages, so don't rely on this as the canonical source!

This is where the bulk of the work lies and where you will probably want my help to generate the new textures and get them into the game.

While working on the French translation with Gooby I wrote some Python scripts to generate the new textures from text files, meaning that if you can send me the translated text I can quickly create the new textures from it.

My scripts expect UTF-8 encoded text files with unix style newlines, so if you can provide me with the translated text in that format it will save me some time. If you aren't sure how to encode a text file like that or it is too tedious to do it for every file don't worry - I can pretty easily convert them from whatever encoding and newline style your text editor defaults to. If you wanted to send me the text in a large pastebin dump instead of individual files that's fine too - just, please don't send them to me as a word document.

To get access to the English textures from the game there are a few options - Naturally you could discover them all yourself in the game, but that would be time consuming and error-prone. If you get in touch I can point you to a website where I have them hosted (I'm not going to post the URL here because it's full of spoilers), or you could extract them from the game yourself - to do this I would recommend using klightspeed's RS5-Extractor as it's much easier to use than my own tools:

http://psteamcommunity.yuanyoumao.com/app/223510/discussions/0/828925216426421301/#c846943082463048999

Start working through the lists below creating the text files mentioned with the translated text. Feel free to periodically send me an in-progress translation rather than waiting until everything is done - that way I can get some of the textures ready and sort out any issues ahead of time.

It's probably a good idea to prioritise coming up with translated names for the plants and drugs early since they get mentioned in a number of places and it can be a pain having to find and edit every reference. Also, send me the blackboard translations early since I do those by hand so they will take longer.

Where noted, you should add Pango markup to change the colour or formatting of particular words. This is only used when we needed to change the format on a specific word within a block of text - the scripts set the appropriate formatting on the entire block. The markup format is documented here:
https://developer.gnome.org/pango/unstable/PangoMarkupFormat.html

This section lists all of the notes in the journal index. It's also a good reference for looking up which note corresponds with which filename.

The filename of the corresponding notes uses the same number, but with "NOTE" instead of "LIST_Note".

This section lists all the journal index entries for plant discovery and research. It is also a good reference to look up which plant corresponds with which filename.

• The filename for the matching plant page in the journal will have the same number, but with "Plant" instead of "LIST" and no a/b suffix.
  
• The filename for the matching research page in the journal will also have the same number, but with "RESEARCH" instead of "LIST" and no a/b suffix.

This section lists the journal index entries for all of the drug research pages.

The filename for the corresponding journal entry uses the same letter, but has "Plant" (Yes, "Plant", not "Drug") instead of "LIST".

The three blackboards textures are the only textures that I do entirely by hand with my graphics tablet to maintain the hand-written aesthetic. Because of this it will likely take me longer to get around to doing them, so you should make sure you send me their translations early on to give me plenty of time.

This section lists all the text we need to completely translate the front page of the journal, including the status conditions, medicine tags, objectives and journal tabs.

• There's a pretty limited amount of space on the OBJNOTE images. My script will automatically reduce the font size until the text fits so you do have a little extra breathing room.
  
• The OBJNOTE images are links to particular notes or research entries. The note/plant they refer to can be determined by looking at the last part of the filename (except OBJNOTE_D_11 as noted).
  
• You should include the trailing comma in the OBJNOTE entries.

I'm not auto-wrapping the intro in the script (I do auto-wrap the ending), so insert a newline at an appropriate place for the longer text - I can tweak it if it overflows.


If you have extracted the game files yourself you can the ones I'm not spoiling under TEX\MENU, or I will have given you the URL to them. Or finish the game and take screenshots.

These three categories all work in roughly the same way - each of them has a "template.txt" with the text for the page title and headings, then individual text files for each page.

The English text for these can be found under TEX\J2 after extracting the game files, or at a URL I can provide if you get in touch.

Create a text file plants\template.txt and fill it in like this:
For each plant, create a text file plants\Plant_<NUMBER>.txt and place the name on the first line, the Genus on the second line (or leave a blank line if unknown) and the observations on the lines below that.

You should end up with these files (Refer to Part 2B to work out which filename is which plant):

plants\template.txt, plants\Plant_00.txt, plants\Plant_0.txt, plants\Plant_1.txt, plants\Plant_2.txt, plants\Plant_3.txt, plants\Plant_4.txt, plants\Plant_5.txt, plants\Plant_6.txt, plants\Plant_7.txt, plants\Plant_8.txt, plants\Plant_9.txt, plants\Plant_10.txt, plants\Plant_11.txt, plants\Plant_12.txt, plants\Plant_13.txt, plants\Plant_14.txt, plants\Plant_15.txt, plants\Plant_16.txt, plants\Plant_17.txt, plants\Plant_18.txt, plants\Plant_19.txt, plants\Plant_20.txt, plants\Plant_21.txt, plants\Plant_22.txt, plants\Plant_23.txt, plants\Plant_24.txt, plants\Plant_25.txt, plants\Plant_26.txt, plants\Plant_27.txt, plants\Plant_28.txt, plants\Plant_29.txt, plants\Plant_30.txt, plants\Plant_31.txt, plants\Plant_32.txt, plants\Plant_33.txt, plants\Plant_34.txt


Create a text file research\template.txt and fill it in like this:

The Prickly Pear cactus and right hand page of the cure doesn't fit the same pattern as the rest of the research entries, so create a text file research\RESEARCH_0.txt and fill it in with the translation of:

My tests on this plant have
revealed no medicinal value

Create a text file research\Research_K.txt (yes, different capitalisation on this one) and fill it in with the translation of this, using the same colour in the Pango markup to match the slightly darker red from the English version:

I have succesfully (sic) administered the Tricordrazine. <span color="#a50018">My plague has been cured!</span> All symptoms have subsided and my physical capacity has been fully restored.

For all the remaining research entries, create two text files research\RESEARCH_<NUMBER>.txt and research\RESEARCH_<NUMBER>_conclusion.txt

Fill the first in with the translation of the scientific method (i.e. the grey text). Leave blank lines between paragraphs, but don't worry about having to wrap the text around the diagrams - my script will do that automatically.

Fill the second in with the translation of the conclusion. Use Pango markup to highlight drug names and hints in red, like this:

If this fungus is <span color="#ff0000">combined with a Type-C Poison inhibitor</span>, I will be able to synthesize it into a <span color="#ff0000">Brain Emphasis Drug.</span>

You should end up with all these files (refer to Part 2B to work out which filename is which plant):

research\template.txt, research\RESEARCH_00_conclusion.txt, research\RESEARCH_00.txt, research\RESEARCH_0.txt, research\RESEARCH_1_conclusion.txt, research\RESEARCH_1.txt, research\RESEARCH_2_conclusion.txt, research\RESEARCH_2.txt, research\RESEARCH_3_conclusion.txt, research\RESEARCH_3.txt, research\RESEARCH_4_conclusion.txt, research\RESEARCH_4.txt, research\RESEARCH_5_conclusion.txt, research\RESEARCH_5.txt, research\RESEARCH_6_conclusion.txt, research\RESEARCH_6.txt, research\RESEARCH_7_conclusion.txt, research\RESEARCH_7.txt, research\RESEARCH_8_conclusion.txt, research\RESEARCH_8.txt, research\RESEARCH_9_conclusion.txt, research\RESEARCH_9.txt, research\RESEARCH_10_conclusion.txt, research\RESEARCH_10.txt, research\RESEARCH_11_conclusion.txt, research\RESEARCH_11.txt, research\RESEARCH_12_conclusion.txt, research\RESEARCH_12.txt, research\RESEARCH_13_conclusion.txt, research\RESEARCH_13.txt, research\RESEARCH_14_conclusion.txt, research\RESEARCH_14.txt, research\RESEARCH_15_conclusion.txt, research\RESEARCH_15.txt, research\RESEARCH_16_conclusion.txt, research\RESEARCH_16.txt, research\RESEARCH_17_conclusion.txt, research\RESEARCH_17.txt, research\RESEARCH_18_conclusion.txt, research\RESEARCH_18.txt, research\RESEARCH_19_conclusion.txt, research\RESEARCH_19.txt, research\RESEARCH_20_conclusion.txt, research\RESEARCH_20.txt, research\RESEARCH_21_conclusion.txt, research\RESEARCH_21.txt, research\RESEARCH_22_conclusion.txt, research\RESEARCH_22.txt, research\RESEARCH_23_conclusion.txt, research\RESEARCH_23.txt, research\RESEARCH_24_conclusion.txt, research\RESEARCH_24.txt, research\RESEARCH_25_conclusion.txt, research\RESEARCH_25.txt, research\RESEARCH_26_conclusion.txt, research\RESEARCH_26.txt, research\RESEARCH_27_conclusion.txt, research\RESEARCH_27.txt, research\RESEARCH_28_conclusion.txt, research\RESEARCH_28.txt, research\RESEARCH_29_conclusion.txt, research\RESEARCH_29.txt, research\RESEARCH_30_conclusion.txt, research\RESEARCH_30.txt, research\RESEARCH_31_conclusion.txt, research\RESEARCH_31.txt, research\RESEARCH_32_conclusion.txt, research\RESEARCH_32.txt, research\RESEARCH_33_conclusion.txt, research\RESEARCH_33.txt, research\RESEARCH_34_conclusion.txt, research\RESEARCH_34.txt, research\Research_K.txt

Create a text file drugs\template.txt and fill it in like this:
For each drug, create a text file drugs\Plant_<LETTER>.txt and place the name on the first line and the description on the lines below that. You can leave a blank line after the name if you wish - the script will ignore it. Blank lines within the body of the description are preserved.

You should end up with these files (refer to Part 2C to work out which filename is which drug):

drugs\template.txt, drugs\Plant_A.txt, drugs\Plant_B.txt, drugs\Plant_C.txt, drugs\Plant_D.txt, drugs\Plant_E.txt, drugs\Plant_F.txt, drugs\Plant_H.txt, drugs\Plant_I.txt, drugs\Plant_J.txt, drugs\Plant_K.txt, drugs\Plant_X.txt, drugs\Plant_Y.txt, drugs\Plant_Z.txt

Each of the notes have slightly different rules as to where they expect the translated text because they are all so different. Generally there is a separate text file for each distinct block of text, but check the descriptions below!

If you have extracted the game's files these are all under TEX\J2, if you are looking at my site they are all under notes.

I had to split this section in two because of the character limit. Some notes (simple single file ones) are in the previous section, as are some common files that are used by multiple notes.

This section includes the text that gets overlayed on the map if the corresponding map fragment has been found (however a few of these do not appear to be on any map fragments):

This section contains the textures that didn't fit anywhere else.

When we are getting ready to release a translation we need the patcher itself to be translated. To do this download Qt Linguist from here:

http://qt-apps.org/content/show.php/Qt+Linguist+Download?content=89360

Then grab a copy of the translation source file:

https://raw.githubusercontent.com/DarkStarSword/miasmata-fixes/master/miaspatch_i18n/miaspatch-template.ts

You will also need a version of the patcher that supports the translation to try it out. The patcher bundled with the community patch v1.2.1 contains the necessary bug fixes, so you can use that.

Use Qt Linguist to edit the translations in the .ts file. It's not necessary to translate absolutely everything in the patcher - the important bits are the parts of the UI that someone needs to read to understand what they are doing, while things like error messages and technical jargon are less important. In particular, you definitely will want to translate everything under "Dialog", "MiasPatch", "Mod Status", "PatchListModel", while under "RS5Patcher" you may want to translate the status messages but not bother with the error messages.

To try it out export it to a .qm file in the miaspatch_i18n folder of the patcher. You will need to edit the miaspatch.cfg file in the patcher and set the language to whatever you named the .qm file. The patcher will automatically find any .miasmod and .rs5mod files in it's directory and offer them as choices to install, so you will want to add those generated in parts 1 and 2.

This section is only for advanced users only. If you don't know how to run commands from the Linux command line, have never applied a patch and built a piece of software or think that Python is a kind of snake you should probably just let me take care of this part. I'm not going to hold your hand here - if you think you are capable of doing this yourself you should only need fairly minimal instructions.

My scripts are all on github - clone them with:

Download the source code for the GIMP, apply the patch attached to this bug report and build it:
https://bugzilla.gnome.org/show_bug.cgi?id=724101

Download and extract my "blank" (removed text) versions of all the textures in the game from here:
http://darkstarsword.net/files/miasmata/miasmata-blanks-2014-04.tar.xz

Purchase or otherwise obtain permission to use the fonts that are used in the game:

• Neu Phollick Alpha (This is the main font used throughout 90% of the game. From Typotheticals - http://www.myfonts.com/foundry/Typotheticals/ . I got in touch with the designer (Graham Meade, fontype <AT> hotmail D.T com) to get permission to use all the Typotheticals fonts in the game)
  
• Norlik (Typotheticals)
  
• Flute (Typotheticals)
  
• Wiki (Typotheticals)
  
• Worstveld Sling (Typotheticals. Free. Not to be confused with Worstveld Sting)
  
• FG Norah - http://www.myfonts.com/fonts/fontgarden/fg-norah/
  
• 23rd Street - http://www.myfonts.com/fonts/albatross/23rd-street/
  
• Architects Daughter (There are two versions of this font with different shapes, you want this one: http://www.fontsquirrel.com/fonts/architects-daughter)
  
• New Yorker - http://www.urbanfonts.com/fonts/New_Yorker.htm (This font is missing accented characters - I used fontforge to add the ones I needed)
  
• OldNewspaperTypes - http://www.dafont.com/oldnewspapertypes.font
  
• Candara (bundled with Windows 7 and above)

Generic looking fonts where I picked whatever I had on my system that looked close enough, but was not an exact match:

• Century Gothic
  
• Georgia
  
• URW Bookman L

Extract the texture headers with:
Optionally delete all extracted files named 02-DATA.dds since we are replacing that part.

Symlink all the .py scripts from miasmata-fixes/translations/scripts/*.py to ~/.gimp-2.8/plug-ins (or ~/.config/GIMP/2.9/plug-ins if running the current development version).

When everything is in place, run the various shell scripts under miasmata-fixes/translations/scripts to generate the translated textures. Some of these need to be told which textures to generate, others do everything in their category at once - if you're reading this you can surely figure out which is which. If you need to make manual tweaks to any of the produced .xcf files save them as xxx_tweaked.xcf and re-run the script (currently only works with miasmata-notes.sh).

Don't forget to manually do the blackboard images! I used Krita - there's some hints for how I did this in the commit message - https://github.com/DarkStarSword/miasmata-fixes/commit/ed7947539bb717ad582055defac1534b4192a29c

Edit the paths at the top of miasmata-fixes/translations/scripts/stage-translation.sh and run it, passing the mod name you want to use (e.g. "french") and a version number (which MiasPatch will display and use to determine if the mod needs to be upgraded).

Package the staging tree into an rs5mod archive with
You're done! Install the rs5mod with MiasMod or MiasPatch (which picks it up automatically if it's in the miaspatch directory).