Translations - Revision history

DeamonHunter: Redo edit, without deleting Github tutorial.

2018-01-31T11:45:35Z

Redo edit, without deleting Github tutorial.

Show changes

DeamonHunter: Undo revision 6440 by DeamonHunter (talk)

2018-01-31T11:41:49Z

Undo revision 6440 by DeamonHunter (talk)

Show changes

DeamonHunter: Remake the tutorial, to focus on letting people make their own mods.

2018-01-31T11:29:15Z

Remake the tutorial, to focus on letting people make their own mods.

Show changes

DeamonHunter: /* Creating your own language file */

2017-10-02T07:03:12Z

‎Creating your own language file

DeamonHunter: Numerous changes to make it easier to read .

2017-10-02T03:56:06Z

Numerous changes to make it easier to read .

Show changes

DeamonHunter: Added more content, as well as changed the original tutorial somewhat.

2017-09-27T13:08:59Z

Added more content, as well as changed the original tutorial somewhat.

DeamonHunter: Initial commit of the translations page. Still missing a couple things.

2017-09-26T06:46:18Z

Initial commit of the translations page. Still missing a couple things.

New page

[[Category:Modding]]

Staxel has been built to handle having multiple translations. It includes the ability to change all text being displayed with only a couple of exceptions to this rule. The following is a list of features you can change:

* Dialogue text. (i.e. Villager conversations)
* Menu text. (i.e. All menu's. Item/Block names and descriptions. In world Tags. etc)
* The font used. Japanese translation uses this to provide a better default font for Japanese characters.
* Other various instances of text.

With that however, there are a couple things Staxel cannot do. These include;
* Can't set a font for a specific set of characters.
* Staxel does not handle right to left text well. It can possible to fake it however but may require a lot of work.
* Gendering names or items. In most cases you either need to assume neutral (For cases such as the Player.) or as part of the statement. (For cases where an item will not change. Such as the Mug'o'sap in the Barkeep's dialogue.)

= Editing the Official Staxel Translations =
The Staxel team has chosen to have all of the translations publically avaliable for review and editing over at https://github.com/bartwe/StaxelTranslations. If you have knowledge of how to use git/github then the following tutorials will not be as necessary. In this case, you may still want to see [[#How to Check Translations Ingame]] and possibly [[#How to view the dialogue flow]].

== Editing a Single File on Github ==
This section is mainly for editing a single file on Github, although it can extend to editing multiple files quite easliy. (Though please don't do this method if you editing more than 5 files at once.)

First of all, head over to https://github.com/bartwe/StaxelTranslations. You will be greeted by a page that looks like;

[[File:Staxel Translation Github Page.png]]

Don't be alarmed by this page. The majority of the information on this page is not needed for beginner users. The main thing you should be worried about is getting to the language you want to edit. On this page you will see a bunch of lines that start with an icon that looks like a folder. This is the area you want to be in. After each of the folders is a four character name with a dash in the middle. This is known as a [https://en.wikipedia.org/wiki/Language_code Language Code]. In the simplest form, the first two letters are the language you want. For example, "en" is English, "fr" is French and "ja" is Japanese. The second set of characters refers to the region of which the language resides. For example, "GB" is Great Britian English, which has differences to "US" which is American English. With that knowledge, click on the folder with the language you want. (If your language is not listed here, then you will need to create it. This will not be handled in this tutorial.)

After that is done, you will be greeted with another page. This page contains a whole bunch of files, which represent each of the things you can change. The vast majority of the files here, are used to replace NPC dialogue though there are some files near the bottom that are used to replace other bits of pieces of text, such as item descriptions. Click on the file you want to change in this section. Once you have selected the file you to edit, there will be a edit button (Highlighted by red in the image below.) that you will need to press.

[[File:Github Edit Button.png]]

After doing that you will be arrive at a page that will look like;

[[File:Editting a File on Github.png]]

You can safely ignore the message that appears up at the top. This is just saying that Github has made a "local" (Not actually local but effectively it is) copy of all the files for you to edit.

The middle is now a text editor which allows you to edit the lines. However first a quick explanation of what each lines does and means;

At the start of the file, there first two lines, that are listed below, which are similar to the folder names and are just there to setup the file correctly. In most cases, you will not be changing these.
<pre>
language.code=ja-JP
language=日本語
</pre>

Below is the first type of translation you may see. This is how any translation that has already been done should appear. These lines have not been edited in English, and therefore ''shouldn't'' need to be edited, however incorrect translations can happen.
<pre>
//[Reference] 'Achievement unlocked: {0-achievement}!'
achievements.achievementUnlocked=アチーブメントがアンロックされました：{0-achievement}！
</pre>

The first line is what is known as a "comment" which is signalled by the "//" at the start of the line. Essentially this line does nothing but tell you what the English translation of this line contains.
The second line is the actual translation for the line. The first part, in this case <code>achievements.achievementUnlocked=</code> is the thing being translated, and the part after the equals is the translation. If you edit this, there should be no gap between the "=" and the actual translation, as this gap gets added to the translation.

Below is the second type of translation you may see. This is how any translation that have not been done before.
<pre>
//TODO Translate [Reference] 'Why am I not watching over the tavern you ask?'
staxel.village.dialogue.job.BarkeepWorkPlaceMissing.line:10000100=
</pre>

These two lines act the same as the first section. The comment this time has "TODO Translate" in there, signifying that this line needs to be done. If you wanted to translate this line, add the translation after the "=" symbol, with no space between the equals and the translation. Once it is done, remove the "TODO Translate" leaving it like <code>//[Reference] 'Why am I not watching over the tavern you ask?'</code>

And finally, below is the third type of translation you may see. This is how any translation that has been done before, but the English version has since changed, therefore possibly leaving the translation out of date.
<pre>
//[Validate] Delete this comment if or when the translation is accurate.
//[Reference] 'It's this way!'
staxel.village.dialogue.Tutorial.line:10003600=Par là !
</pre>

This line needs to be double checked to see if the translation still lines up with what is being asked for. If you do edit this, or confirm it is correct, remove the entire line containing <code>//Validate</code>.

With that, you should know what each line does. However there is one extra thing that may confuse you. If we go back to the lines;
<pre>
//[Reference] 'Achievement unlocked: {0-achievement}!'
achievements.achievementUnlocked=アチーブメントがアンロックされました：{0-achievement}！
</pre>

You'll notice the text <code>{0-achievement}</code>. This is known as a "Variable". This is a value that will add in some other text to the statement, turning the sentence into "Achievement Unlocked: Locked and Loaded!" for example. These should be included, unchanged, in the translation, as these passages are often translated elsewhere. However the location of this variable does not matter, and may make more sense at the start of a sentence rather than the end.

With that you should have enough knowledge to edit these files.

Once you have finished editing the file, scroll down to the bottom of the page. There will be a section that looks like;

[[File:Commiting changes.png]]

In the first box, you should put something like "Updated [Filename]'s English Translation" or something very similar. This names what you have changed, which is known as a "commit". The second box is where you add more details but this isn't necessary.

Once you have edited the first box, click "Propose file change". You'll be brought to a page similar to below;

[[File:Committed Changes.png]]

This page essentially shows you what you have changed, and you can look over it if you want to make sure what you have done. However the next step would be to click "Create pull request". This will create a new set of boxes where you clicked. This will take the name of the commit you did earlier, and also it's description. If you are happy with these just click on "Create pull request" once again. You will then go to a page that looks similar to;

[[File:Pull Request Page.png]]

At this point you are '''almost''' done. Once you see this page, please wait about 1 to 2 minutes and refresh the page. At this point a bot should have messaged that you need to sign a waver in order for your changes to be accept. Follow through with it's instructions.

When you have signed the waver, you are done. However in order to speed along the translations acceptance, it would be recommended to head to our Discord at https://discordapp.com/invite/Staxel and drop a message in #translations in order to say that you have done this.

← Older revision		Revision as of 07:03, 2 October 2017
Line 158:		Line 158:
	This section will detail how you will create your own translation files. This is mostly needed in order to make sure your Tiles, Items and other various things will get translations instead of the default choice the game will make.		This section will detail how you will create your own translation files. This is mostly needed in order to make sure your Tiles, Items and other various things will get translations instead of the default choice the game will make.

−	[~~Coming Soon~~]	+
		+	You first need to create a text file and name it something like "modname.lang" or "modname-en-GB.lang". (Replacing the ".txt" at the end of the filename as well.) Open this file in your favourite text editor and then copy the following lines;
		+
		+	<pre>
		+	language.code=en-GB
		+	language=English
		+	</pre>
		+	The first line is which translation this will be a part of. The second line is the localised name of this code. You can look at other files in <code>/PathToStaxel/gamedata/content/staxel/StaxelTranslations/</code> in order to find out the codes and languages we use.
		+
		+
		+	After that is done, it is time to add lines. This is largely dependent on what you want to translate, but the following is a list of all things that can be translated. One entry is needed per item needed that is to be translated.
		+
		+
		+	== Accessories/Achievements/Items/Plants/Recipes/Tiles ==
		+	All of these items will behave exactly the same in a language file. Add the following to the language file,
		+	<pre>
		+	[code of the object here].name=Name of Object
		+	[code of the object here].description=This is the long form description of the item that is used in the inventory screens.
		+	</pre>
		+
		+	The code of the object is signified by the "code" property in the respective files.
		+
		+	== Categories ==
		+	Each Category that is used in [[Tile\|Tiles]] and [[Items]] and other pieces can have its own translation. This might not be used in many cases however, mainly in searching for items. In this case, add the following to the language file,
		+	<pre>
		+	staxel.category.[Category]=Translated name of the category.
		+	</pre>
		+
		+	With Category being the exact string used in the "categories" property.
		+
		+	== Dialogue ==
		+	Dialogue is the most difficult section to deal with. The first thing to do is fully create your Dialogue file. When you have finished creating your Dialogue, open [[Content Builder]] at the path <code>/PathToStaxel/gamedata/bin/</code> and press the "Tag Dialogue and Generate Language file" button. Select the dialogue file you have just created. (i.e. Open the .dialogue file). This changes the .json file and also creates a .lang file. The translations for this is then good to go.
		+
		+	If you want to make the translations for a different language, either edit the file you have just created or create a copy of the file and change that.
		+
		+	== Villagers ==
		+	[[Villager NPCs\|Villager]] names themselves can be translated.
		+	<pre>
		+	staxel.villager.[Villager Name]=Translated name
		+	</pre>
		+
		+	With Villager Name being the exact string used in the "name" property.
		+
		+	== Other ==
		+	There are certain other strings that can be specified. For example, [[Tile#"interactVerb"]] or [[Weather#"nightTransitionFlavourLineCodes"]] are of this type. Both of these specify a translation line as a string in the file. You then add this exactly line to your .lang file and then use that to add a proper description.
		+
		+	For example if your [[Tile]] file has;
		+	<pre>
		+	"interactVerb": "mods.tile.I.Really.Want.A.Different.Verb"
		+	</pre>
		+
		+	You can then add the following to your lang file;
		+	<pre>
		+	mods.tile.I.Really.Want.A.Different.Verb=I really want to not have a different verb.
		+	</pre>
		+
		+	== After finishing ==
		+	When you have finished your language file, open [[Content Builder]] at the path <code>/PathToStaxel/gamedata/bin/</code> and press the "Validate" button. This will compile all the translations and then you can view them in Staxel. At this point, check them out in game and see if they came out right.

@@ Line 16: / Line 16: @@
 = Editing the Official Staxel Translations =
-The Staxel team has chosen to have all of the translations publically avaliable for review and editing over at https://github.com/bartwe/StaxelTranslations. If you have knowledge of how to use git/github then the following tutorials will not be as necessary. In this case, you may still want to see [[#How to Check Translations Ingame]] and possibly [[#How to view the dialogue flow]].
+The Staxel team has chosen to have all of the translations publically avaliable for review and editing over at https://github.com/bartwe/StaxelTranslations. If you have knowledge of how to use git/github then the following tutorials will not be as necessary. In this case, you may still want to see [[#How to Check Translations Ingame]] and possibly [[#How to View the Dialogue]].
-== Editing a Single File on Github ==
+== Editing Files on Github ==
-This section is mainly for editing a single file on Github, although it can extend to editing multiple files quite easliy. (Though please don't do this method if you editing more than 5 files at once.)
+This section is mainly for editing a files on Github. The method will be the same for one or more files.
@@ Line 101: / Line 101: @@
 [[File:Committed Changes.png]]
-This page essentially shows you what you have changed, and you can look over it if you want to make sure what you have done. However the next step would be to click "Create pull request". This will create a new set of boxes where you clicked. This will take the name of the commit you did earlier, and also it's description. If you are happy with these just click on "Create pull request" once again. You will then go to a page that looks similar to;
+This page essentially shows you what you have changed, and you can look over it if you want to make sure what you have done. From this point you have two decision;
 [[File:Pull Request Page.png]]
@@ Line 108: / Line 134: @@
 When you have signed the waver, you are done. However in order to speed along the translations acceptance, it would be recommended to head to our Discord at https://discordapp.com/invite/Staxel and drop a message in #translations in order to say that you have done this.