Custom Player Model

Requires Player Model lib

 

Allows for player to have custom player model. Such model is placed in a special folder inside ModConfig folder, and then it becomes available to the player that has it. Alternatively you can download mods with custom player models made for this mod. And every other player can see it, despite not having it on their side.

Model can have custom shape, one custom texture and one custom voice sound. They all are synced between all players, but are not saved, so other players cannot easily access it.

Config with white lists for player and models will come later.

 

Example of adding custom player model via mod: Custom Player Models: Undertale

 

Alternatively, custom model should be placed in ModConfig/custom-player-models folder as folder that contains (final path should look like: C:\Users\<user>\AppData\Roaming\VintagestoryData\ModConfig\custom-player-models\<model-name>\<files>):

- config.json - config file (supports most of the features from regular custom player models)
- custom-shape.json - model shape file
- custom-texture.png - custom texture used in shape file, should be referred as custom-texture in shape file
- custom-voice.ogg - voice sound file

Folder name should contain only lower case character, hyphens or digits

Example: https://github.com/maltiez2/vsmod_customplayermodel/tree/7211b07becbfab0683e8c520540a8aeb31d2a856/examples

 

You can turn on white list in mod config (when Config lib is installed). White list is stored in ModConfig folder. There are separate white lists for players and for models. Models white list is actually three white lists for model shape, texture and sound. When you add a model to whitelist it is added to these three, and any model that have texture, shape and sound from white list will be allowed. Any change to any of these three files will result in them not matching the white list. You can also turn on white list only for texture, shapes or sounds separately.

To add/remove player to/from whitelist use commands: /player <player name> cpmwa  and /player <player name> cpmwr

To add/remove model to/from whitelist use commands: /player <player name> cpmwam <model name> <flags:optional>  and /player <player name> cpmwrm <model name> <flags:optional>. You can use model name from character selection dialog. You can specify flags to only affect specific lists, for example: /player <player name> cpmwrm <model name> -to  will remove only texture and sound from the whitelist, but leave the shape. This command needs player as argument, to select only models that are loaded from this player (several players can have different models under the same name).
Existing flags:
 h - shape
 o - sound
 t - texture