Yes Steve Model

https://ysm.cfpa.team/
Admin
Yes Steve Model is a Minecraft mod that enables custom player models and animations using Bedrock...
Tokens:122,207
Snippets:654
Trust Score:6.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### q.position() example

Source: https://ysm.cfpa.team/wiki/molang/misc

Gets the specified component (0-2 for X, Y, Z) of the entity's position. The example gets the Y coordinate and returns 1003.23.

```molang
q.position(1)
```

--------------------------------

### ysm.mod_version() example

Source: https://ysm.cfpa.team/wiki/molang/misc

Gets the version of the specified mod (by mod id) installed on the client. Returns the version string if installed, otherwise null. The example returns '0.3.10.5'.

```molang
ysm.mod_version('tac')
```

--------------------------------

### ysm.weather example

Source: https://ysm.cfpa.team/wiki/molang/misc

Gets the current weather: 0 for clear, 1 for rain or snow, 2 for thunderstorm or blizzard. The example returns 1.

```molang
ysm.weather
```

--------------------------------

### ysm.texture_name examples

Source: https://ysm.cfpa.team/wiki/molang/misc

Gets the player's texture name as a string with extension. The first example returns 'blue.png'. The second example checks if the texture is 'blue.png' and returns true.

```molang
ysm.texture_name
```

```molang
ysm.texture_name == 'blue.png'
```

--------------------------------

### 服务器配置文件 serverconfig/yes_steve_model-server.toml

Source: https://ysm.cfpa.team/wiki/config

服务器配置文件，位于 存档目录/serverconfig/yes_steve_model-server.toml，2.3.0 才有此文件。2.2.2 及之前时此处配置在 config/yes_steve_model-common.toml 里。无需重启，自动热重载。

```toml
#玩家首次进入游戏时的默认模型 ID
DefaultModelId = "default"
#玩家首次进入游戏时的默认模型材质名称
DefaultModelTexture = "default"
#玩家是否能自由切换模型
CanSwitchModel = true
#客户端选择界面不会显示的模型，用于隐藏不想显示的默认模型（2.3.0 新增）
#示例：["default", "misc_3_default_boy", "misc_1_alex", "misc_2_steve", "wine_fox_1_taisho_maid", "wine_fox_7_jk"]
ClientNotDisplayModels = []

[server_scheduler]
	#处理模型的线程数，设置为 0 表示由程序自动决定
	#范围：0 ~ 你的服务器 CPU 核心数
	ThreadCount = 0
	#服务端分发模型时，每个玩家分配的带宽（单位：Mbps）
	#范围：1 ~ 999
	BandwidthLimit = 5
	#玩家响应同步的超时时间。值小于 10 时表示由程序自动决定。（单位为秒）
	#范围：0 ~ 120
	PlayerSyncTimeout = 0
	#抑制部分功能的网络同步以降低带宽占用
	#仅在大规模玩家场景下生效
	LowBandwidthUsage = false
	#跳过音效处理以降低服务器带宽占用及客户端内存占用
	#0: 接收所有音效（默认值）
	#1: 仅接收短音效（时长小于 4 秒且文件体积小于 40 KB）
	#2: 拒绝所有音效（不推荐）
	# 注意：该选项需重新加载模型后生效。提高此选项值不会触发模型重新同步，降低此值则会触发。
	# 取值范围：0 ~ 2
	AcceptSoundFX = 0
```

--------------------------------

### ysm.relative_block_name() example

Source: https://ysm.cfpa.team/wiki/molang/misc

Gets the block id at the given relative position around the player. The example gets the block below the player and returns 'minecraft:sand'.

```molang
ysm.relative_block_name(0, -1, 0)
```

--------------------------------

### 客户端配置文件 config/yes_steve_model-common.toml

Source: https://ysm.cfpa.team/wiki/config

客户端配置文件，位于 config/yes_steve_model-common.toml。2.2.2 之前和 2.3.0 之后该文件内容有所不同。包含通用设置、额外玩家渲染和加载状态界面等选项。

```toml
[general]
	#是否显示声明界面
	DisclaimerShow = false
	#是否在聊天框打印轮盘动画播放信息
	PrintAnimationRouletteMsg = false
	#是否禁用自身的 YSM 模型渲染
	DisableSelfModel = false
	#是否禁用其他玩家的 YSM 模型渲染
	DisableOtherModel = false
	#是否禁用自己的第一人称 YSM 手臂渲染
	DisableSelfHands = false
	#是否禁用 YSM 箭模型替换渲染
	DisableArrowsModel = false
	#当玩家首次进入服务器时，默认给予玩家的模型 ID
	DefaultModelId = "default"
	#当玩家首次进入服务器时，默认给予玩家的模型材质
	DefaultModelTexture = "default"
	#当与 Optifine 同时使用时，如果遇到了渲染问题，
	UseCompatibilityRenderer = false
	#动画里声音播放时，全局音量大小（2.3.0 有此配置）
	#范围：0.0 ~ 100.0
	SoundVolume = 100.0
	#是否禁用 YSM 弹射物模型替换渲染
	DisableProjectileModel = false
	#是否禁用 YSM 载具模型替换渲染
	DisableVehicleModel = false
	#模型选择界面是否优先显示模型 ID，而不是模型作者设置的模型名称
	ShowModelIdFirst = false

[extra_player_render]
	#是否禁用额外玩家渲染
	DisablePlayerRender = false
	#额外玩家渲染位置 X 坐标
	#范围：> 0
	PlayerPosX = 10
	#额外玩家渲染位置 Y 坐标
	#范围：> 0
	PlayerPosY = 10
	#玩家模型展示大小
	#范围：8.0 ~ 360.0
	PlayerScale = 40.0
	#玩家模型旋转角度偏移量
	#范围：4.9E-324 ~ 1.7976931348623157E308
	PlayerYawOffset = 5.0

[loading_state_screen]
	# 是否禁用加载状态界面
	DisableLoadingStateScreen = false
	# 加载状态界面显示位置
	# 允许值：TOP_LEFT（左上）、TOP_CENTER（中上）、TOP_RIGHT（右上）、BOTTOM_LEFT（左下）、BOTTOM_CENTER（中下）、BOTTOM_RIGHT（右下）
	LoadingStatePosition = "TOP_CENTE
```

--------------------------------

### ysm.equipped_enchantment_level() example

Source: https://ysm.cfpa.team/wiki/molang/misc

Gets the enchantment level of the specified enchantment on the equipped item. Returns an integer, or 0 if the enchantment is not present. The example gets the mending level from the mainhand.

```molang
ysm.equipped_enchantment_level('Mainhand', 'minecraft:mending')
```

--------------------------------

### 在 ysm.json 中添加 gui_foreground 和 gui_background 字段

Source: https://ysm.cfpa.team/wiki/foreground-and-background

在 ysm.json 的 properties 字段中添加 gui_foreground 和 gui_background 字段，分别指定前景图和背景图的路径。示例中路径为 textures/gui/foreground.png 和 textures/gui/background.png。推荐图片比例为 52x90。

```json
{
  // ...
  "properties": {
    // ...
    "extra_animation_classify": [],
    "preview_animation": "gui",
    "disable_preview_rotation": true,
    "gui_no_lighting": false,
    "gui_foreground": "textures/gui/foreground.png",    // 这里是前景图路径
    "gui_background": "textures/gui/background.png",    // 这里是背景图路径
    "default_texture": "default",
    "render_layers_first": false,
    "free": true
  }
  // ...
}
```

--------------------------------

### ysm.dimension_name example

Source: https://ysm.cfpa.team/wiki/molang/misc

Gets the current dimension id as a string. The example returns 'twilightforest:twilightforest' (Twilight Forest).

```molang
ysm.dimension_name
```

--------------------------------

### math.min_angle() example

Source: https://ysm.cfpa.team/wiki/molang/misc

Calculates the equivalent angle within [-180, 180). The example returns 60.

```molang
math.min_angle(780)
```

--------------------------------

### Model preview and rendering settings

Source: https://ysm.cfpa.team/wiki/struct

Global settings for model preview behavior, lighting, and rendering layers.

```json
"preview_animation": "idle",
"default_texture": "default",
"free": false,
"render_layers_first": false,
"disable_preview_rotation": false,
"gui_no_lighting": false,
"gui_foreground": "textures/gui/foreground.png",
"gui_background": "textures/gui/background.png",
"all_cutout": false
```

--------------------------------

### q.position_delta() examples

Source: https://ysm.cfpa.team/wiki/molang/misc

Gets the position delta component (0-2 for X, Y, Z). The first example returns -0.076. The second example calculates the speed from position deltas and returns 19.03.

```molang
q.position_delta(0)
```

```molang
v.time0 > 0 && q.life_time - v.time0 > 0 ? (v.speed_x = (q.position_delta(0) - v.x0) / (q.life_time - v.time0)); v.x0 = q.position_delta(0); v.time0 = q.life_time; return v.speed_x;
```
Tokens:
Raw