![\"a](\"https:\/\/github.com\/diacritics-owo\/dynamic-skins\/raw\/main\/assets\/gradient-skin.gif\")
<\/p>\n# Dynamic Skins<\/p>\n
Set your skin dynamically based on conditions (client-only for now)<\/p>\n
## Getting Started<\/p>\n
After installing the mod and launching the game once, a file called `dynamic-skins.js` will be written to the configuration folder (if you don’t know where that is, Dynamic Skins will helpfully tell you the file path in the logs on the first launch).<\/p>\n
Dynamic Skins exposes a very simple JavaScript API that allows you to replace player skins based on conditions that you define. **Note that the skin replacement only takes place on _your_ client. Only you will see the modified skins.** Also note that this only changes skins in-game, so skin selector mods or the tab list\/social interactions screen will not be affected.<\/p>\n
Example configuration:<\/p>\n
“`javascript
\nif (
\n data.target.player.profile.username === data.client.player.profile.username && \/\/ Only replace your own skin – without this, you’ll see that everyone’s skin changes when you swim
\n data.client.player.isTouchingWater &&
\n data.client.player.isSwimming
\n) {
\n skin.set(“minecraft:textures\/entity\/zombie\/drowned_outer_layer.png”);
\n}
\n“`<\/p>\n
Another:<\/p>\n
“`javascript
\n\/\/ When anyone holds a trident, their skin will be changed
\nif (data.target.player.equipment.mainhand === “minecraft:trident”) {
\n skin.set(“minecraft:textures\/entity\/zombie\/drowned_outer_layer.png”);
\n}
\n“`<\/p>\n
This configuration will be run once per player rendered per frame.<\/p>\n
## Configuration Cache<\/p>\n
The configuration is read once on mod initialisation and cached in memory, and updates to it will not be read unless you run `\/dynamic-skins cache reload`. Alternatively, you can open the Mod Menu configuration page for Dynamic Skins and click “Reload configuration”. Every time you update the configuration, you must reload it for it to apply.<\/p>\n
## Errors<\/p>\n
If an error is encountered when Dynamic Skins executes the configuration, the error and a message stating that Dynamic Skins has stopped will be logged. You can run the command `\/dynamic-skins error` to display the error. To start it again, you must either run `\/dynamic-skins error reset` or open the Mod Menu page (reopen if it was already open) and click the “Restart” button that should now be visible. Note that restarting will reload the configuration.<\/p>\n
## Custom Skins<\/p>\n
For now, Dynamic Skins only allows you to set a skin via a resource location (of the form `namespace:path\/to\/image.png`). To use custom skins, you can create a resource pack.<\/p>\n
Example resource pack structure:<\/p>\n
“`
\n|- pack.mcmeta
\n|- pack.png
\n|- assets
\n |- skins
\n |- my_skin.png
\n“`<\/p>\n
You could then use `skin.set(‘skins:my_skin.png’)`.<\/p>\n
## Advanced Usage<\/p>\n
Dynamic Skins allows you to set a state that persists across both players and frames. This allows you to make animated skins by cycling through different frames. Please note that framerates drop significantly with long cycles.<\/p>\n
Example:<\/p>\n
“`javascript
\nif (
\n data.target.player.profile.username === data.client.player.profile.username
\n) {
\n state.set(
\n “cycle”,
\n ((state.get(“cycle”) === null ? 0 : state.get(“cycle”)) % 32) + 1
\n );<\/p>\n
const s = state.get(“cycle”).toString();<\/p>\n
skin.set(`skins:skin${“0”.repeat(2 – s.length)}${s}.png`);
\n}
\n“`<\/p>\n
The above example will cycle your skin continuously from `skins:01.png` through `skins:32.png`<\/p>\n
It is possible to cycle skins without state by using `skin.value`, but it will be much more tedious and will still have a performance impact.<\/p>\n
<\/p>\n
## API<\/p>\n
### `Skin`<\/p>\n
#### `value: string`<\/p>\n
#### `set(value: string): void`<\/p>\n
—<\/p>\n
### `Data`<\/p>\n
#### `client: ClientData`<\/p>\n
#### `target: TargetData`<\/p>\n
—<\/p>\n
### `ClientData`<\/p>\n
#### `player: PlayerData`<\/p>\n
—<\/p>\n
### `TargetData`<\/p>\n
#### `player: PlayerData`<\/p>\n
—<\/p>\n
### `PlayerData`<\/p>\n
#### `profile: ProfileData`<\/p>\n
#### `equipment: EquipmentData`<\/p>\n
#### `isTouchingWater: boolean`<\/p>\n
#### `isClimbing: boolean`<\/p>\n
#### `isSwimming: boolean`<\/p>\n
#### `isSneaking: boolean`<\/p>\n
#### `isOnFire: boolean`<\/p>\n
#### `isInLava: boolean`<\/p>\n
#### `isSprinting: boolean`<\/p>\n
—<\/p>\n
### `ProfileData`<\/p>\n
#### `username: string`<\/p>\n
—<\/p>\n
### `EquipmentData`<\/p>\n
#### `head: string`<\/p>\n
#### `chest: string`<\/p>\n
#### `legs: string`<\/p>\n
#### `feet: string`<\/p>\n
#### `mainhand: string`<\/p>\n
#### `offhand: string`<\/p>\n
—<\/p>\n
### `State`<\/p>\n
#### `set(key: string, value: any): void`<\/p>\n
#### `get(key: string): any`<\/p>\n","protected":false},"excerpt":{"rendered":"
Set your skin dynamically based on conditions (client-only for now)<\/p>\n","protected":false},"featured_media":60309,"template":"","meta":{"_minecraft_slug":"dynamic-skins","_minecraft_project_id":"QnQKb9AM","_minecraft_author":"diacritics-owo","_minecraft_license":"MIT","_minecraft_downloads":841,"_minecraft_follows":23,"_minecraft_client_side":"required","_minecraft_server_side":"unsupported","_minecraft_storage_type":"zip","_minecraft_archive_name":"dynamic-skins.zip","_minecraft_size_bytes":6687389,"_minecraft_version_count":5,"_minecraft_updated_at":"2026-05-15T19:57:48.746040Z","_minecraft_date_created":"2024-07-29T01:09:11.334557Z","_minecraft_date_modified":"2024-08-06T10:20:38.118028Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/dynamic-skins","_minecraft_icon_attachment_id":60309,"_minecraft_imported_at":"2026-06-03T12:25:20+00:00","_minecraft_import_hash":"c88159d94e2b5321db06645554a7b105","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,98,92],"mod_loader":[99,100],"minecraft_version":[36],"class_list":["post-60308","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-quilt","mod_category-utility","mod_loader-fabric","mod_loader-quilt","minecraft_version-1-20-1"],"yoast_head":"\n