Translation Files#

Available translation file types, their descriptions and properties. The majority of the time the key prefix for translation keys need to be included or they won’t work. While this is not always the case, it’s preferable to follow these guidelines to avoid issues with missing translations and to make it cleaner when referencing the translation keys in code or scripts.

The pattern properties are patterns that the translation keys must match in order to be valid, they are simply more specific rules than just the prefix if you are interested in knowing the details. Those were defined from the vanilla translation files for the most part and might be incomplete or too specific.

Attributes#

File Name

Attributes.json

Function

getText

Pattern Properties

^Attributes_Type_[A-Za-z_]+$, ^Attributes_ToosltipOverride_[A-Za-z_]+$

BodyParts#

File Name

BodyParts.json

Function

getText

Pattern Properties

^BODYPART_[A-Z_]+$

Challenge#

File Name

Challenge.json

Function

getText

Key Prefix

Challenge_

Pattern Properties

^Challenge_[A-Za-z0-9\s]+(_[A-Za-z0-9]+|InfoBox)$

ContextMenu#

Translations used in the context menus of the game.

File Name

ContextMenu.json

Function

getText

Key Prefix

ContextMenu_

Pattern Properties

^ContextMenu_[A-Za-z0-9_]+$

DynamicRadio#

Dynamic radio translations.

File Name

DynamicRadio.json

Function

getRadioText

Key Prefix

AEBS_

Pattern Properties

^AEBS_[A-Za-z0-9_]+$

Entity#

Translations for entity UIs.

File Name

Entity.json

Function

getText

Key Prefix

EC_

Pattern Properties

^EC_[A-Za-z_]+$

EvolvedRecipeName#

Translations for evolved recipe scripts.

File Name

EvolvedRecipeName.json

Function

Translator.getItemEvolvedRecipeName

Pattern Properties

^[A-Za-z0-9_]+\.[A-Za-z0-9_]+$

Farming#

Translations for farming menus.

File Name

Farming.json

Function

getText

Key Prefix

Farming_

Pattern Properties

^Farming_[A-Za-z0-9_\s-]+$

Fluids#

Translations for fluid related UI elements and fluid containers.

File Name

Fluids.json

Function

getText

Key Prefix

Fluid_

Pattern Properties

^Fluid_[A-Za-z0-9_]+$

GameSound#

Game sounds and categories translations.

File Name

GameSound.json

Function

getText

Key Prefix

GameSound_

Pattern Properties

^GameSound_[A-Za-z0-9_]+$

IG_UI#

Translations for in-game user interface elements.

File Name

IG_UI.json

Function

getText

Key Prefix

IGUI_

Pattern Properties

^IGUI_[A-Za-z0-9_\s:\.\/'!-]+$

ItemName#

Translations for item scripts. The key needs to be the full type of the item.

File Name

ItemName.json

Function

getItemNameFromFullType

Pattern Properties

^[A-Za-z0-9_]+\.[A-Za-z0-9_]+$

Location_Generic#

A translation file for the map. The filename needs to refer the file “map.info” in the mod’s media folder.

File Name

Location_Generic.json

Function

N/A

Keys

title, description, $schema

MakeUp#

Translations for make up.

File Name

MakeUp.json

Function

getText

Pattern Properties

^MakeUp(Category|Type)_[A-Za-z0-9]+$

MapLabel#

File Name

MapLabel.json

Function

getText

Key Prefix

MapLabel_

Pattern Properties

^MapLabel_[A-Za-z]+$

Mod#

Translations for the mod.info file. Possible keys are “name” and “description”.

File Name

Mod.json

Function

N/A

Keys

name, description, $schema

Moodles#

Moodles status and descriptions translations

File Name

Moodles.json

Function

getText

Key Prefix

Moodles_

Pattern Properties

^Moodles_[A-Za-z0-9_]+(_desc)?_lvl0-9$

Moveables#

Moveable tiles as items translations.

File Name

Moveables.json

Function

Translator.getMoveableDisplayName

Pattern Properties

^[A-Za-z0-9_!\s]+$

MultiStageBuild#

Translations for multi stage build.

File Name

MultiStageBuild.json

Function

Translator.getMultiStageBuild

Key Prefix

MultiStageBuild_

Pattern Properties

^MultiStageBuild_[A-Za-z0-9_]+$

Print_Text#

Raw text content for media items such as newspapers, describing their content.

File Name

Print_Text.json

Function

getText

Key Prefix

Print_Text_

Pattern Properties

^Print_Text_[A-Za-z0-9_]+$

RadioData#

Radio translations with the key being a GUID of the radio text.

File Name

RadioData.json

Function

getText

Key Prefix

RD_

Pattern Properties

^RD_[a-f0-9-]+$

RecipeGroups#

File Name

RecipeGroups.json

Function

Translator.getRecipeGroupName

Key Prefix

RecipeGroup_

Pattern Properties

^RecipeGroup_[A-Za-z]+$

Recipes#

Translations for the craftRecipe scripts. The key needs to be the ID of the craftRecipe block.

File Name

Recipes.json

Function

getRecipeDisplayName

Pattern Properties

^[A-Za-z0-9_\(\): -]+$

Recorded_Media#

Recorded media translations with the key being a GUID of the media text.

File Name

Recorded_Media.json

Function

getText

Key Prefix

RM_

Pattern Properties

^RM_[A-Za-z0-9_-]+$

Sandbox#

Sandbox options translations.

File Name

Sandbox.json

Function

getText

Key Prefix

Sandbox_

Pattern Properties

^Sandbox_[A-Za-z0-9_]+(_option[0-9]+|_tooltip)?$

Stash#

Survivor maps translations.

File Name

Stash.json

Function

getText

Key Prefix

Stash_

Pattern Properties

^Stash_[A-Za-z0-9_]+$

SurvivalGuide#

Survival guide translations.

File Name

SurvivalGuide.json

Function

getText

Key Prefix

SurvivalGuide_

Pattern Properties

^SurvivalGuide_[A-Za-z0-9_]+$

SurvivorNames#

All possible automatic character names. Used for random name generation of the player character or for zombies.

File Name

SurvivorNames.json

Function

getText

Pattern Properties

^Survivor(Name|Surname)_[A-Za-z0-9_\s\.'-]+$

Tooltip#

Tooltips used for UIs.

File Name

Tooltip.json

Function

getText

Key Prefix

Tooltip_

Pattern Properties

^Tooltip_[A-Za-z0-9_]+$

UI#

Translation file for user interface elements.

File Name

UI.json

Function

getText

Key Prefix

UI_

Pattern Properties

^UI_[A-Za-z0-9_\s/\-]+$