How to use custom models?

Overview

Custom models provide a powerful way to enhance your projects, allowing the integration of user-defined models. This guide covers two methods of incorporating custom models: Vanilla Models (1.14.4+) and Model Engine (1.16.5+).

Options

1. Vanilla Models (1.14.4+)

   • Static representations without model animations.

2. Model Engine (1.16.5+)

   • Supports dynamic animations.

   • Free version with limitations (up to 6/12 models).

   • Paid version available.

Main Steps

1. Model Availability for your Java Client

   • Ensure all custom models are available and working on your Client.

2. Configure crates on your server

3. Server Resource Pack

   • Place the custom models in the server resource pack to allow other clients to see them.

4. Bedrock Integration (Optional)

   • If using Bedrock, ensure the models are working on Java, so you can move to this step.

Important Note for ItemsAdder and Oraxen Users

If you are using ItemsAdder or Oraxen on your server, it's crucial to follow their respective documentation for proper integration. Both plugins have specific guidelines on how to handle vanilla resource packs or integrate with Model Engine.

ItemsAdder Integration

For ItemsAdder, the integration process is often more automatic. Ensure that you consult the ItemsAdder documentation for any specific instructions related to custom models and resource packs.

ItemsAdder with ModelEngine integration: https://itemsadder.devs.beer/compatibility-with-other-plugins/compatible/modelengine

Oraxen Integration

If you are using Oraxen, refer to the Oraxen documentation for detailed steps on how to handle custom models. Make sure to follow their guidelines for integrating vanilla resource packs or working with Model Engine.

Oraxen with ModelEngine integration: https://docs.oraxen.com/compatibility/modelengine-custom-mobs

Step-by-Step Guide

Step 1: Model Availability for Your Java Client

Before integrating custom models into your project, you need to ensure that your Java clients can access these models. This involves making the models available through resource packs.

Vanilla Models (1.14.4+)

If you are using Vanilla Models, follow these steps:

1. Check for a Java Resource Pack: If you are using one of our packs, verify if a Java resource pack for Vanilla Models is provided. This resource pack should contain the necessary files for your custom models.

2. Client Resource Packs (Settings > Resource Packs): Place the resource pack zip file into the resource packs folder on your Java client. You can access this folder through the "Resource Packs" section in the client settings.

Model Engine (1.16.5+)

For Model Engine, follow these steps to ensure that your clients can access the models:

1. Install Model Engine on Your Server: After successfully installing Model Engine on your server, you should see a "ModelEngine" folder within the "plugins" folder.

2. Locate the Blueprints Folder: Inside the "ModelEngine" folder, locate the "blueprints" folder.

3. Place .bbmodel Files: Put the ".bbmodel" files of your custom models into the "blueprints" folder. If you are using one of our packs, you might find these files under the "modelengine_files" directory.

   • Example:

     /plugins/ModelEngine/blueprints/your_custom_model.bbmodel

4. Reload Model Engine: After placing the "*.bbmodel" files in the "blueprints" folder, execute the command /meg reload on your server to reload Model Engine and apply the changes.

Step 2: Configure Crates on Your Server

Now that you have ensured the availability of custom models for your clients, the next step is to configure crates on your server. This involves creating crates and specifying the engine option, whether it's Model Engine or Vanilla Model.

Automatic Setup (For Our Packs)

If you are using one of our packs, check the product page for setup commands that automate the configuration process. These commands streamline the setup and eliminate the need for manual configuration.

Not using our packs or you want to customize it further:

1. Create Crates: Use your server's plugin commands or administrative interface to create crates. Ensure that you define the crates' properties, such as rewards, chances, and names.

2. Specify Engine Option: When creating or editing crates, look for the "Engine" option. Set this option to either "Model Engine" or "Vanilla Model," depending on your chosen method for custom models.

3. Edit Engine Options (Manual Configuration): If you prefer manual configuration, you can edit the engine options directly. For Model Engine, ensure that the "*.bbmodel" files are correctly referenced.

4. Engine Switching in Menu: In some setups, you can use the menu system to switch engines. Left-click to swap between Model Engine and Vanilla Model, and right-click to edit the engine.