Translating - Revision history

Zashaya: /* Translating Wildermyth */

2023-07-31T10:14:12Z

Translating Wildermyth

← Older revision		Revision as of 10:14, 31 July 2023
Line 1:		Line 1:
	==Translating Wildermyth==		==Translating Wildermyth==
	Wildermyth is developed in US English and has an official ~~translation~~ for Simplified Chinese. It's possible we'll be able to provide additional official languages in the future, but it might be a while, so we are working on tools to support community translation into other languages.		Wildermyth is developed in US English and has official translations for Simplified Chinese, Brazilian Portuguese, Spanish (Latin America), German and French. It's possible we'll be able to provide additional official languages in the future, but it might be a while, so we are working on tools to support community translation into other languages.

	Let us know what would make your life easier as a translator!		Let us know what would make your life easier as a translator!

Pbelanger: /* Articles and Gender */ Adjusted display of where gender tags can be used, added monster names as use case

2022-03-09T17:42:33Z

Articles and Gender: Adjusted display of where gender tags can be used, added monster names as use case

← Older revision		Revision as of 17:42, 9 March 2022
Line 79:		Line 79:
	===Articles and Gender===		===Articles and Gender===
	For text like "Let's go to <site>" or "Give me the <item>", <site> and <item> may need different articles before them depending on whether the site/item name is masculine, feminine, neutral, plural, starts with a vowel, etc.		For text like "Let's go to <site>" or "Give me the <item>", <site> and <item> may need different articles before them depending on whether the site/item name is masculine, feminine, neutral, plural, starts with a vowel, etc.
	~~In name generation files like assets/data/generation/human.names (where all the item and site names are created) as well as in custom item or site names in dynamic.properties,~~ '''[m], [f], [p], and [n]''' can be used to designate a name as '''masculine, feminine, plural, and neutral'''.		<br>'''[m], [f], [p], and [n]''' can be used to designate a name as '''masculine, feminine, plural, and neutral''' in several places:

	For example, if you put the following in human.names:		* In name generation files like '''assets/data/generation/human.names''' (where all the item and site names are created). For example, if you put the following in human.names, then "Swampy Bog" would return masculine, and "Swampy Marshes" would return feminine plural.
	<pre>		<pre>
	"swampTile": ["Swampy <SwampWord>"],		"swampTile": ["Swampy <SwampWord>"],
	"swampWord": ["bog[m]", "marshes[f][p]"],		"swampWord": ["bog[m]", "marshes[f][p]"],
	</pre>		</pre>
	~~then "Swampy Bog" would return masculine~~, ~~and "Swampy Marshes" would return feminine plural. Or~~, in dynamic.properties~~, you could write~~ <~~code~~>item.antlerbow=Antler Bow[f]</~~code~~> ~~to make the Antler Bow feminine.~~
			* In custom '''item, monster, or site names''' in '''dynamic.properties'''. For example:
			<pre>
			item.antlerbow=Antler Bow[f]
			gorgon.name=Gorgon[f]
			vultureLord_graymountain=Graymountain[m]
			</pre>


	Once the genders of those names are set, they can be accessed using the following article split tags:		Once the genders of those names are set, they can be accessed using the following article split tags:

Pbelanger: Added testing section

2022-03-08T21:13:39Z

Added testing section

← Older revision		Revision as of 21:13, 8 March 2022
Line 61:		Line 61:

	When translating comics, you'll need to understand how tags work, particularly gender splits, since you may have to write your own depending on your language. The [[Writer's Guide]] and [[Tag Reference]] goes over how they work. The comic editor is highly recommended because it will give you feedback that your tags are correct, let you see the stories in context, and reroll parties to make sure all variations work. It will also let you adjust individual text box positions and sizes. These adjustments are saved to the .properties file of the event as ~TWEAK lines, you will see them in there. ONLY text boxes can be adjusted this way, actors or other comic details can not.		When translating comics, you'll need to understand how tags work, particularly gender splits, since you may have to write your own depending on your language. The [[Writer's Guide]] and [[Tag Reference]] goes over how they work. The comic editor is highly recommended because it will give you feedback that your tags are correct, let you see the stories in context, and reroll parties to make sure all variations work. It will also let you adjust individual text box positions and sizes. These adjustments are saved to the .properties file of the event as ~TWEAK lines, you will see them in there. ONLY text boxes can be adjusted this way, actors or other comic details can not.

			==Testing Translations==

			The easiest way to test translations for comics is via the comic editor. You can find more information about testing in the [[Comic_Editor_Reference#Testing_your_Event_in_the_Editor\|Comic Editor (Testing your Event in the Editor)]]. Specifically, the Reroll button and Auto-Match option are your friends here.

	==Delivering Translations==		==Delivering Translations==

Pbelanger: /* In Game Editors */ Added links to Data Format Overview and Comic Editor Reference

2022-03-08T20:56:23Z

In Game Editors: Added links to Data Format Overview and Comic Editor Reference

← Older revision		Revision as of 20:56, 8 March 2022
Line 38:		Line 38:
	The [[Comic Editor Reference\|Comic Editor]] is the best way to translate comics, because it offers side-by-side text, real time tag validation, and lets you tweak text box positions as needed. Use the button on the top bar to set your target language:		The [[Comic Editor Reference\|Comic Editor]] is the best way to translate comics, because it offers side-by-side text, real time tag validation, and lets you tweak text box positions as needed. Use the button on the top bar to set your target language:

	[[File:LanguageOptions.png\|~~frameless\|left~~\|Useful options when translating]]		[[File:LanguageOptions.png\|400px\|Useful options when translating]]

	Set the language to the language you're translating to. The dropdown uses the "knownLocales" file mentioned earlier. You can also change "translate mode" to be "from Source" or you can translate from another language, which might be helpful once we have more translations.		Set the language to the language you're translating to. The dropdown uses the "knownLocales" file mentioned earlier. You can also change "translate mode" to be "from Source" or you can translate from another language, which might be helpful once we have more translations.
Line 45:		Line 45:

	Finally, there are some buttons for making effect text bundles. This take all of the effect properties files and bundles them up into one file for translation, but right now I don't recommend using this - Wildermyth has tech to skip untranslated events, but that tech only works if no file exists in that language. Bundling effect text > translating some > unbundling will create files for all the effects, so the game won't know which ones are translated. I might change the button to skip effects with comic panels, and export a list of those, or something like that.		Finally, there are some buttons for making effect text bundles. This take all of the effect properties files and bundles them up into one file for translation, but right now I don't recommend using this - Wildermyth has tech to skip untranslated events, but that tech only works if no file exists in that language. Bundling effect text > translating some > unbundling will create files for all the effects, so the game won't know which ones are translated. I might change the button to skip effects with comic panels, and export a list of those, or something like that.


			In order to understand the structure of the data and tools, these links may also be helpful (which are also linked to on the editor landing page). While it's not strictly necessary to understand all of the underlying structure in order to translate the game, many of the things you'll be translating are events, abilities, and aspects (which are discussed in more detail in the Data Format Overview), and understanding how the comics are written and how splits and branches work and are shown in the comic editor will almost certainly be necessary.
			* [[Data Format Overview]] (A broad overview of the files in Wildermyth and how they work together)
			* [[Comic Editor Reference]] (How to create events, explanations of some of the editor tools)

	==Workflow==		==Workflow==

Pbelanger: Added some notes on translation tags

2022-03-08T17:32:28Z

Added some notes on translation tags

Show changes

Nate at 19:00, 8 October 2020

2020-10-08T19:00:43Z

← Older revision		Revision as of 19:00, 8 October 2020
Line 8:		Line 8:

	=File Structure=		=File Structure=
	~~All~~ the text in the game is stored in [https://en.wikipedia.org/wiki/.properties .properties files]. Properties files are very simple, it's one "string" (piece of text) to a line. The "key" is first, don't change that. Just change the text after the =		Nearly all the text in the game is stored in [https://en.wikipedia.org/wiki/.properties .properties files]. Properties files are very simple, it's one "string" (piece of text) to a line. The "key" is first, don't change that. Just change the text after the =

	The files are found in the /assets/text/ folder. There are many many files in here, 1 file for each "effect" (event or combat ability) and some very large files for interface, history lines, aspects, and other things. For mods (such as campaigns, for example Age of Ulstryx is a mod) the text is in the mod folder, so, mods/builtIn/villain_ulstryx/assets/text/...		The properties files are found in the /assets/text/ folder. There are many many files in here, 1 file for each "effect" (event or combat ability) and some very large files for interface, history lines, aspects, and other things. For mods (such as campaigns, for example Age of Ulstryx is a mod) the text is in the mod folder, so, mods/builtIn/villain_ulstryx/assets/text/...

	To translate the files, make a copy but put your locale code as the suffix, with underscores, like this:		To translate the files, make a copy but put your locale code as the suffix, with underscores, like this:
Line 28:		Line 28:

	Put the translated files right next to the source files. (You may want to make periodic backups of your translated files, too.)		Put the translated files right next to the source files. (You may want to make periodic backups of your translated files, too.)

			==Name Generator==
			If you want to create localized generated names, the name generator source data files are /assets/data/generation/group.names.json and /assets/data/generation/human.names.json

			You'll see how it works, it's pretty simple.

	=In Game Editors=		=In Game Editors=

Pbelanger: /* File Structure */ Typo: Changed interface_fr to interface_fr.properties

2020-10-08T18:53:56Z

File Structure: Typo: Changed interface_fr to interface_fr.properties

← Older revision		Revision as of 18:53, 8 October 2020
Line 21:		Line 21:
	\| interface_zh_CN.properties \|\| Simplified Chinese		\| interface_zh_CN.properties \|\| Simplified Chinese
	\|-		\|-
	\| interface_fr \|\| French		\| interface_fr.properties \|\| French
	\|}		\|}

Nate at 18:49, 8 October 2020

2020-10-08T18:49:49Z

← Older revision		Revision as of 18:49, 8 October 2020
Line 23:		Line 23:
	\| interface_fr \|\| French		\| interface_fr \|\| French
	\|}		\|}


	See the /assets/data/knownLocales.json file for a list of country codes that the game lets players pick. If you want additional ones, contact us and ask. See [https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html this list].		See the /assets/data/knownLocales.json file for a list of country codes that the game lets players pick. If you want additional ones, contact us and ask. See [https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html this list].
Line 30:		Line 31:
	=In Game Editors=		=In Game Editors=

	The [[Comic Editor Reference\|Comic Editor]] is the best way to translate comics, because it offers side-by-side text, real time tag validation, and lets you tweak text box positions as needed. Use the button on the top bar to set your target language,		The [[Comic Editor Reference\|Comic Editor]] is the best way to translate comics, because it offers side-by-side text, real time tag validation, and lets you tweak text box positions as needed. Use the button on the top bar to set your target language:

			[[File:LanguageOptions.png\|frameless\|left\|Useful options when translating]]

			Set the language to the language you're translating to. The dropdown uses the "knownLocales" file mentioned earlier. You can also change "translate mode" to be "from Source" or you can translate from another language, which might be helpful once we have more translations.

			The editor also lets you import/export a loc kit, which is just a copy of the game assets with only the text files for one language. This is helpful for collaboration or for exporting to a mod.

			Finally, there are some buttons for making effect text bundles. This take all of the effect properties files and bundles them up into one file for translation, but right now I don't recommend using this - Wildermyth has tech to skip untranslated events, but that tech only works if no file exists in that language. Bundling effect text > translating some > unbundling will create files for all the effects, so the game won't know which ones are translated. I might change the button to skip effects with comic panels, and export a list of those, or something like that.

	=Workflow=		=Workflow=

			We recommend starting with interface.properties. Get the interface showing up correctly. If your target language cannot be rendered in the game's font, please contact us and we'll work out a font set, and add it as an option for you to choose. You'll have to choose "Use Local Fonts" while translating.

			After the interface bundle, tackle dynamic, presentation, scenarios, errors, and aspects.

			"story" can largely be editing in the "History" tab of the editor and should be done there.
			"effects" including comics should be edited in the comic editor. The flow for non-comic events is not finished yet but might use the bundling/un-bundling option discussed above.

			When translating comics, you'll need to understand how tags work, particularly gender splits, since you may have to write your own depending on your language. The [[Writer's Guide]] and [[Tag Reference]] goes over how they work. The comic editor is highly recommended because it will give you feedback that your tags are correct, let you see the stories in context, and reroll parties to make sure all variations work. It will also let you adjust individual text box positions and sizes. These adjustments are saved to the .properties file of the event as ~TWEAK lines, you will see them in there. ONLY text boxes can be adjusted this way, actors or other comic details can not.

	=Delivering Translations=		=Delivering Translations=

			It's easiest to work "in place," in the game folder itself. When you want to share your work, export a loc kit. Another player can import that loc kit the same way. To import/export, the language must be set, and only those files will be copied. It's also possible to bundle your translations up in a mod. If you do that, take all translated text from the "mods" folders and just lump them together in your main assets folder. That whole thing becomes your mod and should work fine. The mod approach allows you to add support for a new langauge by including a "/assets/data/knownLocales.json" file. Th

	=Translating Mods=		=Translating Mods=

			To translate a mod, copy it to your install folder, e.g. /mods/user/[mod id or number] Then translate in place. When you're done, coordinate with the mod author to integrate your translations, or release them as your own mod.

Nate at 18:22, 8 October 2020

2020-10-08T18:22:54Z

← Older revision		Revision as of 18:22, 8 October 2020
Line 21:		Line 21:
	\| interface_zh_CN.properties \|\| Simplified Chinese		\| interface_zh_CN.properties \|\| Simplified Chinese
	\|-		\|-
	\| ~~interface_fr_FR~~ \|\| French		\| interface_fr \|\| French
	\|}		\|}

			See the /assets/data/knownLocales.json file for a list of country codes that the game lets players pick. If you want additional ones, contact us and ask. See [https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html this list].

	Put the translated files right next to the source files. (You may want to make periodic backups of your translated files, too.)		Put the translated files right next to the source files. (You may want to make periodic backups of your translated files, too.)
Line 30:		Line 32:
	The [[Comic Editor Reference\|Comic Editor]] is the best way to translate comics, because it offers side-by-side text, real time tag validation, and lets you tweak text box positions as needed. Use the button on the top bar to set your target language,		The [[Comic Editor Reference\|Comic Editor]] is the best way to translate comics, because it offers side-by-side text, real time tag validation, and lets you tweak text box positions as needed. Use the button on the top bar to set your target language,

	~~TODO picture, explain edit/translate modes~~

	=Workflow=		=Workflow=

Nate: /* In Game Editors */

2020-10-08T14:59:48Z

In Game Editors

← Older revision		Revision as of 14:59, 8 October 2020
Line 28:		Line 28:
	=In Game Editors=		=In Game Editors=

	The [[Comic Editor]] is the best way to translate comics, because it offers side-by-side text, real time tag validation, and lets you tweak text box positions as needed.		The [[Comic Editor Reference\|Comic Editor]] is the best way to translate comics, because it offers side-by-side text, real time tag validation, and lets you tweak text box positions as needed. Use the button on the top bar to set your target language,

			TODO picture, explain edit/translate modes

	=Workflow=		=Workflow=