Skip to content
Let's make Firewatch accessible to people around the world!
Branch: master
Clone or download
hoverbird Merge pull request #16 from yayannabelle/master
en_gb / British English localisation
Latest commit 0306035 Oct 13, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
br Updating br localization Apr 12, 2016
ca_es Updating ca_es localization Apr 12, 2016
cs_cz Updating cs_cz localization Apr 12, 2016
da_dk Updating da_dk localization Apr 12, 2016
en_gb Updated en_gb localisation Oct 2, 2016
en_us Removing empty string key which breaks Transifex import. Apr 1, 2016
es_419 Updating es_419 localization Apr 12, 2016
es_es
fr_fr Updating fr_fr localization Apr 12, 2016
gl_es
hu_hu Adding a new, complete Hungarian localization made by Brechler Zsolt May 2, 2016
hu_hu_in_progress Move 30% complete Hungarian project into a separately named directory… May 2, 2016
it_it Updating it_it localization Apr 14, 2016
nl_nl Complete dutch translation by Tim Hengeveld Jul 11, 2016
pl
pt_br Updating pt_br localization Apr 14, 2016
pt_pt Updating pt_pt localization Apr 12, 2016
sv_se Updating sv_se localization Apr 12, 2016
tr_tr Updating tr_tr localization Apr 12, 2016
vg_mt
README.markdown Update README to note that wehave work-in-progress fan localizations … Apr 14, 2016
SupportedLanguages.loc 160924 localisation updates for the day Sep 24, 2016

README.markdown

Firewatch Community Localization

Hello! This is Patrick from Campo Santo. At present, Firewatch has been professionally translated in five languages: Spanish, French, Russian, German and Simplified Chinese. We love seeing non-english speakers play our game, but as a small team we have limited resources and aren't able to localize it for everyone.

That's why we've posted our full text-string database here: localization by and for fans. If you love Firewatch and want to make it more accessible to others, feel free to download the data, test it out, and contribute your translations back to this repository for others to download and use.

Firewatch is currently subtitled in English and Russian on Steam. Our professional localizations in German, Spanish, French and Simplified Chinese are coming soon for Steam and PS4. We'll update this README as this patch arrives, as well as if we add any more official localizations.

Worth noting: a community-run Firewatch project has also sprung up on Transifex, using the data found here. We are sharing the in-progress translations fans have worked on in this site in this repo, as well. If you're interested in contributing, take a look! Huge thanks go out to @ner0 for organizing this effort.

Important note: at present, Firewatch's included fonts and layouts do not support characters outside the ISO Latin-1 set and the basic Cyrillic set. We apologize for this limitation and hope that we will be able to add further support at some point.

All English game content provided here is Copyright 2016, Campo Santo. All rights reserved.

Where to find the data

Here on our Github page, under the en_us folder, you’ll find complete text dumps of every string in the game—from menu choices, to spoken dialog captions, to UI and note text. You'll also find our demo localization in vg_mt, and various work-in-progress fan localizations. You can download the entire repository as a Zip file or as a full Git repo.

The Zip file contains everything you need and is the simpletst for most people. Git is somewhat complicated to learn, but makes it possible to track your changes and merge in updated versions of our English source strings. If you're serious about doing a full fan loc, we recommend making a Github account and learning how to pull down a git repo.

Project organization

Each language is in its own top-level directory, named by the language code. We include two languages for you to base yours off of: en_us (English) and vg_mt (Mëtal). Mëtal is a fake language we made up to test our localization system; it mimics English but uses random Unicode characters to make it clear what parts of the UI are being localized properly.

At the top level of the project, open the file SupportLanguages.loc. Inside you'll see the languages contained in our repo and their short language codes. When copied into the proper directory on your computer, this file tells the Firewatch app which language options to display in the Settings menu.

Also note the file localization.en_us, which is by far the largest in the project. This contains every string in the game that's NOT a conversation between Henry and Delilah, which leaves a lot of strings, including in-game notes, menus and all other UI text.

Now open the vg_mt folder. All the strings in the game are here as a series of files. The filename is a "section", which is a bunch of lines organized around concept or a conversation topic. The files are in JSON format using Unicode (UTF-8) encoding. We recommend using a text editor that understands Unicode automatically and can use JSON syntax highlighting, such as Sublime Text.

Playing Firewatch with fan localizations

First, find your Localization folder inside your computer's "persistant data path". This path is located on different places according to your OS.

Ubuntu: ~/.config/unity3d/CampoSanto/Firewatch/Localization

Mac: /Users/<YourUserName>/Library/Application\ Support/CampoSanto/Firewatch/Localization

Windows: C:\Users\<YourUserName>\AppData\LocalLow\CampoSanto\Firewatch\Localization

Download this repo onto your computer. Then, copy the contents of all of the localization folders into the path above. Not the folders themselves, just the contents. When you're done, all of the language files, plus the SupportedLanguages.loc file, should all be in one directory together.

Start Firewatch and you should now see a language dropdown with all these new language options included.

JSON syntax

Each file is structued as a "JSON Object", which is a series of key:value pairs.

These pairs have the original English string on the left and the localized string on the right, with a ":" or "colon" in between. Each pair will be on its own line, and lines are separated with a comma.

For example, here is a very short example file, selected from About Brian Goodwin - General - Dialog.vg_mt:

{
  "Couldn't handle your charms?": "Çóùldñ't häñdlë ÿóùr çhärms?¿?",
  "Not many can.": "Ñót máñÿ çáñ.",
  "Unsurprising.": "Üñsúrprîsîñg.",
  "Huh.": "Hùh."
}

We have an English string on the left, and then our fake "Mëtal" language string on the right. The strings are enclosed in "straight quotes" and separated by a colon, and at the end of each line except for the last one, we have a comma. Also notice that the entire file is enclosed in curly braces, starting with { and ending with }, each on a line by itself.

The entire file must be valid JSON in order to work in the game. There are great online tools available for validating / formatting your JSON. Here is one you can cut and paste your text into to test it: https://jsonformatter.curiousconcept.com

The example above is very simple and doesn't include some issues you will encounter, like the need to escape newlines and other special characters within your strings. If you have any questions don't hesitate to open a Github issue for help. There's more info on JSON format here: http://www.w3schools.com/json/json_syntax.asp

Also, remember to save your file as UTF-8 so that non-western characters will be displayed properly.

Creating your own localization

Your localization should have a unique file extension at the end of every file. Country codes work great for this—for example .en_uk specifies "English, United Kingdom"—and you are welcome to mirror that style for your own locale. Make sure every file has this unique extension and that you organize your files into a subdirectory the same way.

To test your localization locally, first make sure that every file in it is valid JSON (see the section on JSON syntax). Then, add a new line to the SupportedLanguages.loc file at the root of this project; fill out that line with the name of your language followed by a pipe character (|) and the file extension you used. See the next section for how to move these files into a place where Firewatch can use them.

Before you test your own, let's first test Mëtal, our psuedolanguage we at Campo Santo use to test loc. Copy all of the files inside of the vg_mt directory into the Localization folder found above, along with SupportedLanguages.loc. Restart Firewatch and you should now see a languages dropdown in the settings menu; changing the language to Metal should immediately translate all menus into our weird fake language.

Now try doing the same with your own localization. Make sure SupportedLanguages.loc is updated with your new info, and then copy it and the contents of your localization's subdirectory into the persistent data path's Localization directory. When you're done, that directory should contain the Mëtal files AND your own loc files, all in the same folder. Restart Firewatch and see if your language works!

When Firewatch can't find a localized version of a string in the selected language, it will always fall back to English and display that. If you're seeing English strings which you think you've translated, several things might be wrong. Before you open a Github issue and write to us, first test that same string, in game, in Mëtal. If it works in that localization, but not in your own, something is wrong with your files! Some things to check for: filename typos, missing strings, unclosed or unescaped quotation marks, or other issues that would invalidate your JSON.

If you're still stuck, try opening a Github issue so that we or another member of the localization community can help.

Contributing back to the community

You may find in-progress localizations to contribute to over at Transifex. This is a community-run project (unaffiliated with Campo Santo) but it's the most active fan localization community at present.

If you have a complete localization of your own you'd like to share, contribute it back to this repository so others can benefit from it. To do so, the best way is to fork the repo and send us a pull request: https://help.github.com/articles/fork-a-repo/

If this is too complicated, no worries! I'm happy to help. Just create a new archive or zipfile of your project structure and email patrick@camposanto.com. I'll add your work (with proper credit) to this repository so others can find it more easily.

Licensing

All English text content provided in this repository is Copyright 2016, Campo Santo, all rights reserved.

However, you are permitted a use these strings as a reference for creating a "community localization", meaning a complete, line-for-line translation of the English text to another language, as specified below.

Community localization licensing

We ask that, in creating a localization, you contribute it back to the community. If you do so, we ask that you send a copy to us (see below) and release it with the following license text included in the repository:

All Firewatch community-contributed localizations are licensed under the Creative Commons "BY-NC 4.0" License, visible here: http://creativecommons.org/licenses/by-nc/4.0/

Others players are free to access, play, and remix your localization strings so long as they, too, contribute them back to this repository free of charge. In this way, people will be able to improve upon the work of others and offer the widest variety of high-quality translations of this game.

You can’t perform that action at this time.