Compulsion Games reserves the right to remove any translations of We Happy Few it deems inappropriate, regardless of language of origin. If you are concerned that a translation should be reported for content, please email info at compulsiongames dot com with the words "Translation Violation" in the subject line, and include a link to the problem translation.

We thank you for your support and help.

- Compulsion Team

We Happy Few enables players to take localization (translating the game into a different language)
into their own hands, by allowing them to publish custom translations to Steam as Workshop items.
If any other player subscribes to this localization item, the new language will appear ingame under
the language options.

This README documents this process and the accompanying SteamWorkshopPublisher tool.

----------
QUICKSTART
----------

* To create a new localization:

1) first accept http://test-steamproxy.haloskins.io/sharedfiles/workshoplegalagreement
2) copy GlimseGame-native.po to GlimpseGame-mine.po
3) edit GlimpseGame-mine.po with https://poedit.net/
4) run the following command:

SteamWorkshopPublisher.exe -createLocalization -culture=<two letter language iso code>
-languageName="<name you want to show up in the language options ingame>"
-poFile="<full path to GlimpseGame-mine.po>" -nativePoFile="<full path to GlimpseGame-native.po>"
-title="<Steam Workshop item title>" -description="<Steam Workshop item description>"

5) write down the published file id the tool reports

* To update an existing localization:

1) make the necessary edits & updates
2) run the same command but with -updateLocalization in stead of -createLocalization
and add the parameter -publishedFileId=<the id you wrote down>

* To get a new language ingame:

1) go to We Happy Few's Steam Workshop in the steam client
2) subscribe to the localization item of your choice
3) new language should appear as a language option ingame


--------------------------------------------
Creating a new localization for We Happy Few
--------------------------------------------

Our localization files use the Portable Object or .po file format, an industry standard localization
format. To create a new localization, you will have to create a copy of GlimpseGame-native.po and
replace the English translations with translations in the language you want to add.

To edit .po files you can use PoEdit, which is available as a free download at https://poedit.net/

To publish this new translation to the Steam Workshop, we have provided a command line tool:
SteamWorkshopPublisher.exe . You need to provide this tool with several parameters:

- a command, which can be createLocalization or updateLocalization
- the culture iso code of the language you add
- the name of the language as it will show up ingame
- the full path of the original GlimpseGame-native.po file you used to create your translation
- the full path of your own edited localization, eg GlimpseGame-mydutchtranslation.po
- a title and description you want your item to have in the Steam Workshop

Example command:

SteamWorkshopPublisher.exe -createLocalization -culture=nl -languageName="Dutch"
-poFile="c:\temp\GlimpseGame-dutch.po>" -nativePoFile="c:\temp\GlimpseGame-native.po"
-title="Dutch Translation" -description="My translation of We Happy Few in Dutch"

The workshop item will automatically be published as a public item.

------------------
Publishing Remarks
------------------

1) In order for SteamWorkshopPublisher to work, your local Steam Client must be running & logged on

2) Anyone who wants to publish to the Steam Workshop needs to accept Valve's workshop legal agreement.
If you have not accepted this agreement yet, your published items will not be public until you have.
If that is the case, the tool should inform you of this, including a link to the agreement:
http://test-steamproxy.haloskins.io/sharedfiles/workshoplegalagreement

3) When you publish an item, the tool will give you the corresponding PublishedFileId. Write this down if
you want to be able to update your item.

---------------------------------
Updating an existing localization
---------------------------------

The process for updating an existing localisation is almost the same. Edit your localization, and then
run the same command as you used for creating the localization, only specifying -updateLocalization as
command in stead of -createLocalization, and adding the parameter -publishedFileId=xxxxx passing the
id you received when you created the item.

If you have lost this id, you can look it up by opening your workshop item in the Steam Workshop. The
url at the top will have this form: http://test-steamproxy.haloskins.io/sharedfiles/filedetails/?id=<your id>&searchtext=

-------------------------
Installing a localization
-------------------------

To get a new language, it suffices to subscribe to the workshop item in the Steam Workshop.

Once subscribed, when you next launch We Happy Few, the new language should appear as an option in the
language selection dropdown. There are some exceptions you should be aware of:

1) You cannot provide community localization for the languages We Happy Few ships with (English and French)
2) If the language still does not appear, something has gone wrong in the process