Home - Gamepiaynmo/CustomModel GitHub Wiki

Custom Player Model

icon

Description

This mod allows you to customize your player model using JSON files while maintaining compatibility with vanilla Minecraft features as well as other mods. The combination of expressions, physics and the new particle system enables unbelievable customizability!

Installing

The fabric version needs fabric-api as dependency. Mod Menu is also recommended as it enables adjusting configurations using graphical interface.

After installation, put your JSON models in the folder named "custom-models" under ".minecraft" (for servers, it is under the same folder as server.jar). Each model entry can either be a subfolder or a zip archive file. When in game, use the command /custommodel select "model id" to choose a model for you, or you can assign a default model in the configuration.

Modeling

Each model entry is either a folder or a zip archive file. It must contain one main JSON file named "model.json". Supplement textures are all stored at the root, and must be stored in PNG format. More information about the JSON schema, please refer to the github wiki page and some examples can be found here.

Command

/custommodel is the only command that the mod added to the game. It has 4 sub-commands:

  • reload: Reload the model from disk files. When you modify the models on the disk, you can use this command to reload them.
  • refresh: Force the mod to refresh to model list when you add new models to the folder.
  • select xxx: Select the model with id xxx for the player.
  • list: List all models that the mod loaded. Then you can click on the message returned by the command to get the model selecting command.
  • clear: Clear the current model of the player.
  • npc xxx: This is for the compatibility with Custom Npcs. After you create a NPC with CPM Male or CPM Female model, use this command to select model for the nearest NPC.

FAQ

I want some new features / find some bugs!

You can rise new issues at github issue tracker. Or you can contact me at Custom Player Model Discord.

Is this mod client side or server side?

I would say both. You can have this only at client side so that only yourself can see custom models. Or you can have a modded server which enables every player with this mod to see the models.