Adding translations (multi-language) to a YSM model
Since version 2.5.0, Yes Steve Model (YSM) supports multi-language localization through simple JSON language files. This guide walks you through setting up a language folder and writing translation keys for your model's metadata, animations, textures, and configuration menus so players worldwide can understand your model.
Setting Up the Language Folder and Files
Before writing any translations, you need to know the standard Minecraft language code for your target language. For example, English (US) uses en_us and Simplified Chinese uses zh_cn.
By default, YSM looks for a folder named lang inside the root directory of your model pack. Inside this folder, you create a JSON file named after each language code you want to support (such as en_us.json or zh_cn.json).
If you prefer to use a different folder name instead of lang, you can define a custom path using the language_path key under the files object in your ysm.json file.
- Open your model pack's root folder (where ysm.json is located).
- Create a new folder named lang.
- Inside the lang folder, create a file named en_us.json (or another valid Minecraft language code).
- Open the file in a code editor like VSCode and add an empty JSON object: {}.
Model_Folder/
├── animations/
│ ├── main.animation.json
│ └── arm.animation.json
├── models/
│ ├── main.json
│ └── arm.json
├── lang/
│ ├── en_us.json
│ └── zh_cn.json
└── ysm.json{
"files": {
"player": {
"animation": {
"main": "animations/main.json",
"arm": "animations/arm.json",
"extra": "animations/extra.json",
"tac": "animations/tac.json",
"carryon": "animations/carryon.json",
"swem": "animations/swem.json",
"parcool": "animations/parcool.json",
"tlm": "animations/tlm.json"
},
"animation_controllers": [
"controller/main_controller.json",
"controller/parallel_controller.json"
]
},
"language_path": "custom_lang_folder"
}
}Translating Model Metadata and Authors
Every language file is a flat JSON object consisting of key-value pairs where the key points to a specific field in ysm.json and the value is the translated string.
To translate the basic model info shown in the YSM selection screen, use metadata.name for the model's title and metadata.tips for its description.
For author credits, use metadata.authors.<index>.name, metadata.authors.<index>.role, and metadata.authors.<index>.comment. Because arrays are zero-indexed, the first author in your list is 0, the second is 1, and so on.
// Original metadata in ysm.json
{
"spec": 2,
"metadata": {
"name": "K螺诺亚",
"tips": "某AI公司因违法被关停解散...",
"authors": [
{
"name": "Sangjam",
"role": "原设画师",
"comment": "热爱自己的生活,分享自己的快乐"
},
{
"name": "nona",
"role": "模型"
},
{
"name": "星屑海螺",
"role": "动画/收留者",
"comment": "漂泊于群星之中"
}
]
}
}// Translated metadata in lang/en_us.json
{
"metadata.name": "KLUO-0217",
"metadata.tips": "An AI company was shut down and dissolved due to illegal practices...",
"metadata.authors.0.name": "Sangjam",
"metadata.authors.0.role": "OC Designer",
"metadata.authors.0.comment": "Love your own life and share your happiness.",
"metadata.authors.1.name": "nona",
"metadata.authors.1.role": "Model",
"metadata.authors.2.name": "lucia2048",
"metadata.authors.2.role": "Animator",
"metadata.authors.2.comment": "Wandering among the stars"
}Translating Extra (Wheel) Animations
When players open the in-game animation wheel, YSM displays the keys defined under properties.extra_animation in ysm.json. Translating these makes your emotes and toggles accessible to players who do not read the model's original language.
Use properties.extra_animation.<animation_key> to translate the title on the wheel, and append .desc to add or translate a description tooltip for that wheel slot.
// Original extra_animation in ysm.json
{
"properties": {
"extra_animation": {
"config": "#config",
"car_config": "#car_config",
"谢谢": "招手",
"赞成": "赞成",
"反对": "反对",
"鼓掌": "鼓掌",
"请求支援": "请求支援"
}
}
}// Translated wheel names in lang/en_us.json
{
"properties.extra_animation.config": "Model Setting",
"properties.extra_animation.car_config": "Car",
"properties.extra_animation.谢谢": "Thanks",
"properties.extra_animation.赞成": "Agree",
"properties.extra_animation.反对": "Oppose",
"properties.extra_animation.鼓掌": "Clap",
"properties.extra_animation.请求支援": "Help!"
}Translating Wheel Configuration Menus
Custom configuration screens defined in properties.extra_animation_buttons (such as sliders, checkboxes, and radio buttons) are translated by referencing the button's id and the zero-based index of each item in its config_forms array.
Use .title and .description on a form index to translate its heading and tooltip. For radio button menus, use .labels.<option_index> (starting from 0 in the order the labels appear in ysm.json) to translate each selectable choice.
// Original extra_animation_buttons in ysm.json
{
"properties": {
"extra_animation_buttons": [
{
"id": "config",
"name": "模型设置",
"config_forms": [
{
"type": "range",
"title": "随地大小变",
"description": "改变模型大小",
"value": "v.player_scale",
"min": 0.1,
"max": 5,
"step": 0.1
},
{
"type": "radio",
"title": "表情",
"description": "改变面部表情",
"value": "v.roaming.emotion",
"labels": {
"正常": "v.roaming.emotion=0;",
"疑惑": "v.roaming.emotion=1;",
"干什么!": "v.roaming.emotion=2;"
}
}
]
},
{
"id": "car_config",
"name": "车车",
"config_forms": [
{
"type": "checkbox",
"title": "开车",
"description": "",
"value": "v.roaming.car"
},
{
"type": "checkbox",
"title": "关闭随机鸣笛",
"description": "",
"value": "v.roaming.car_can_horn"
},
{
"type": "checkbox",
"title": "关闭按键鸣笛",
"description": "按Tab键鸣笛",
"value": "v.roaming.car_can_horn1"
}
]
}
]
}
}// Translated config forms in lang/en_us.json
{
"properties.extra_animation_buttons.config.config_forms.0.title": "Player Scale",
"properties.extra_animation_buttons.config.config_forms.0.description": "Change the size of the player",
"properties.extra_animation_buttons.config.config_forms.1.title": "Emotion",
"properties.extra_animation_buttons.config.config_forms.1.description": "Change the facial emotion",
"properties.extra_animation_buttons.config.config_forms.1.labels.0": "Normal",
"properties.extra_animation_buttons.config.config_forms.1.labels.1": "Confused",
"properties.extra_animation_buttons.config.config_forms.1.labels.2": "Alert",
"properties.extra_animation_buttons.car_config.config_forms.0.title": "Show Car",
"properties.extra_animation_buttons.car_config.config_forms.1.title": "Disable Random Horn",
"properties.extra_animation_buttons.car_config.config_forms.2.title": "Disable Press Horn",
"properties.extra_animation_buttons.car_config.config_forms.2.description": "Press Tab key to horn"
}Complete Reference of YSM Translation Keys
Below is the complete list of translation keys supported by YSM (since 2.5.0), including texture name localization via files.player.texture.<texture_file_name>. Replace bracketed placeholders with your actual author index, animation name, config ID, or texture filename.
metadata.name -> Model name
metadata.tips -> Model description
metadata.authors.<author_index>.name -> Model author name (0-indexed)
metadata.authors.<author_index>.role -> Model author role (0-indexed)
metadata.authors.<author_index>.comment -> Model author comment (0-indexed)
properties.extra_animation.<wheel_anim_name> -> Wheel animation display name
properties.extra_animation.<wheel_anim_name>.desc -> Wheel animation description
properties.extra_animation_buttons.<config_id>.config_forms.<form_index>.title -> Config item title (0-indexed)
properties.extra_animation_buttons.<config_id>.config_forms.<form_index>.description -> Config item description (0-indexed)
properties.extra_animation_buttons.<config_id>.config_forms.<form_index>.labels.<option_index> -> Radio option label (0-indexed)
files.player.texture.<texture_file_name> -> Model texture display nameQuestions
Which version of YSM is required for multi-language translation files?
Multi-language support was introduced in YSM version 2.5.0. Older versions of the mod will ignore the lang folder and display the raw text inside ysm.json.
What happens if a player uses a game language that I did not translate?
YSM first checks for a JSON file matching the player's current Minecraft language. If that file or key does not exist, it defaults to English (en_us.json). If en_us.json is also missing the key, it falls back to the original text in ysm.json.
Why are my author or config translations showing up on the wrong item?
All numbered lists in YSM translation keys (such as authors, config_forms, and labels) start counting at 0, not 1. Make sure metadata.authors.0.name corresponds to the very first author object in your ysm.json.
How do I translate the title of a config button on the animation wheel?
When a wheel slot opens a config screen (for example, "config": "#config" inside extra_animation), translate its wheel button title using properties.extra_animation.config.