> For the complete documentation index, see [llms.txt](https://flare-studios.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://flare-studios.gitbook.io/docs/miniyoutilities.md).

# MiniYouTilities

Make everyone MINI!

A plugin to autogenerate Mini You assets from Mini You packs made by Nog’s Menagerie.

Join the plugin support discord and open a ticket to verify your purchase, so you get access to the plugin related channels, like change log, help and suggestions!

***

## Installation

1. Download the plugin package from your past orders overview on mcmodels.
2. Place the .jar file into /plugins and restart the server.
3. You can now add content, like the Mini You Astronaut Plushie that comes bundled with the plugin, check the "Adding Content" section below!

{% hint style="info" %}
Make sure that Nexo or ItemsAdder are loading fine, else the plugin will be disabled until vanilla resource pack generation was added!
{% endhint %}

***

## Additional Plugin Requirements

Generating Mini You assets may require additional plugins. See the table below for an overview.

| Asset Type  | Requires                                                                                             |
| ----------- | ---------------------------------------------------------------------------------------------------- |
| Plushies    | Nexo or ItemsAdder                                                                                   |
| Figures     | Nexo or ItemsAdder                                                                                   |
| Pets        | <p>Nexo or ItemsAdder +<br>MythicMobs Free Version +<br>ModelEngine 4 Free Version\* +<br>MCPets</p> |
| Bobbleheads | <p>Nexo or ItemsAdder +<br>ModelEngine 4 Free Version\*</p>                                          |

{% hint style="info" %}
\* You will need the premium version of ModelEngine 4 if you have more than 12 custom models.
{% endhint %}

***

## Adding Content

1. After the plugin has successfully enabled, go to the downloaded Mini You pack you want to add and drag and drop the “MiniYouTilities” folder into /plugins to let it merge with the existing one, you don't need any of the other folders.
2. Reload the plugin with `/miniyou reload`.
3. Now you can start using this Mini You pack to generate the assets.

{% hint style="info" %}
You may reorganize the models inside the MiniYouTilities/blueprints/models directory.

The respective type (“plushie”, “figure”, “card”, “pet” or “bobblehead”) has to be kept anywhere in the path, e.g.:

MiniYouTilities/blueprints/models/plushie/astronaut.json can also be put into MiniYouTilities/blueprints/models/cool/astronaut\_plushie.json

Nonetheless, it is recommended to keep the provided structure as it is.
{% endhint %}

{% hint style="info" %}
You may rename the blueprint textures.

If you change the default texture file names, you also need to change it in the respective model.json.
{% endhint %}

{% hint style="info" %}
The required MiniYouTilities blueprint files are in the downloaded .zip file in the various Mini You packs. Get a fresh download of them, if yours is missing these files!

The default item (plushie/figure/bobblehead) configurations are stored in the plugin and are loaded on startup into the plugin directory. You can use them to make your own config templates.

The Mini You packs are made by Nog’s Menagerie, available for purchase on mcmodels.net. At the bottom of the page you will find links to all Mini You packs.
{% endhint %}

***

## Commands&#x20;

{% hint style="info" %}
The plugin is considered an admin tool, the commands have to be executed with operator permissions (via another plugin or operator players), from the console or trusted players with the following permissions:

`miniyoutilities.miniyou` -> Allows players to access the `/miniyou` command.

`miniyoutilities.reload` -> Together with the miniyou permission it gives players access to the `/miniyou reload` command.

`miniyoutilities.create` -> Together with the miniyou permission it gives players access to all `/miniyou create` commands.
{% endhint %}

{% hint style="info" %}
If the command alias `/miniyou` is already taken by another plugin, use `/miniyoutilities:miniyou`
{% endhint %}

### Reload

#### /miniyou reload

Reloads the config and builds create commands after adding content.

### Create

#### /miniyou create …

{% hint style="info" %}
Currently only Mini You Plushies, Pets, Figures and Bobbleheads are implemented!

Cards follow shortly!
{% endhint %}

{% hint style="info" %}
The plugin generates the commands to create assets based on the names of found models in MiniYouTilities/blueprints/models.\
To use the create commands, you need to have added the blueprint files according to the ‘Adding Content’ section in this wiki.
{% endhint %}

<details>

<summary>Plushies</summary>

**`/miniyou create plushie <model> <skin> <template> <name>`**&#x20;

`<model>` = suggests plushie model file in MiniYouTilities/blueprints/models

`<skin>` = suggests a texture file in MiniYouTilities/skins and accepts a player name to load the respective player skin from Mojang servers if not present

`<template>` = suggests plushie templates in MiniYouTilities/templates

`<name>` = optional, accepts a string to set a customized item name (name displayed in player inventory)

</details>

<details>

<summary>Figures</summary>

**Generate boxed or both figures:**

**`/miniyou create figure_boxed <model> <box> <eyes> <logo> <skin> <template> <name>`**&#x20;

or

**`/miniyou create figure <model> <box> <eyes> <logo> <skin> <template> <name>`**&#x20;

`<model>` = suggests figure model file in MiniYouTilities/blueprints/models

`<box>` = suggests a texture file for the figure box in MiniYouTilities/blueprints/textures/figures

`<eyes>` = suggests a texture file for the figure eyes in MiniYouTilities/blueprints/textures/figures

`<logo>` = suggests a texture file for the figure box logo in MiniYouTilities/blueprints/textures/figures

`<skin>` = suggests a texture file in MiniYouTilities/skins and accepts a player name to load the respective player skin from Mojang servers if not present

`<template>` = suggests figure templates in MiniYouTilities/templates

`<name>` = optional, accepts a string to set a customized item name (name displayed in player inventory)

**Generate unboxed figures:**

**`/miniyou create figure_unboxed <model> <eyes> <skin> <template> <name>`**&#x20;

`<model>` = suggests figure model file in MiniYouTilities/blueprints/models

`<eyes>` = suggests a texture file for the figure eyes in MiniYouTilities/blueprints/textures/figures

`<logo>` = suggests a texture file for the figure box logo in MiniYouTilities/blueprints/textures/figures

`<skin>` = suggests a texture file in MiniYouTilities/skins and accepts a player name to load the respective player skin from Mojang servers if not present

`<template>` = suggests figure templates in MiniYouTilities/templates

`<name>` = optional, accepts a string to set a customized item name (name displayed in player inventory)

</details>

<details>

<summary>Pets</summary>

**`/miniyou create pet <model> <skin> <template> <name>`**&#x20;

`<model>` = suggests pet model file in MiniYouTilities/blueprints/models

`<skin>` = suggests a texture file in MiniYouTilities/skins and accepts a player name to load the respective player skin from Mojang servers if not present

`<template>` = suggests pet templates in MiniYouTilities/templates

`<name>` = optional, accepts a string to set a customized pet name (name displayed in MCPets inventory)

</details>

<details>

<summary>Bobbleheads</summary>

**`/miniyou create bobblehead <model> <skin> <template> <name>`**&#x20;

`<model>` = suggests bobblehead bbmodel file in MiniYouTilities/blueprints/models

`<skin>` = suggests a texture file in MiniYouTilities/skins and accepts a player name to load the respective player skin from Mojang servers if not present

`<template>` = suggests bobblehead templates in MiniYouTilities/templates

`<name>` = optional, accepts a string to set a customized item name (name displayed in player inventory)

</details>

***

## Frequently asked questions (FAQ)

<details>

<summary>The plugin does not start, why?</summary>

To successfully start the plugin you need:

1. Paper 1.21.4-1.21.10
2. Nexo or ItemsAdder installed

</details>

<details>

<summary>Why was the generation of my plushie/figure/etc. cancelled?</summary>

The generation will be cancelled if the plugin runs into issues with the models, textures, configs, etc. Watch the generation of the asset and check the errors, with the `General.Debug` option in the config.yml set to `debug`.

</details>

***

## Default config.yml

The plugin config allows some customisations but the default settings should be good for most users.

If you encounter issues/errors when the plugin starts, there might be missing entries or placeholders instead of correct paths. Fix the issues if they are on your end (see FAQ section) and delete the config.yml to let it regenerate.

This displayed config is just for informational purpose. You should let the plugin handling the generation itself.&#x20;

{% code title="config.yml (using Nexo default paths)" overflow="wrap" %}

```yaml
General:
  # Enable debug messages
  # debug = Get all debug messages.
  # normal = Get "Generating" and "Finished" messages.
  # none = No feedback at all. Just function, no clutter.
  Debug: debug
  # Method used to create mini you assets.
  # Is detected automatically on startup.
  Method: Nexo

Skins:
  # If a downloaded skin is not compatible, it can be saved regardless, although it can't
  # be used, or it can be deleted automatically after detecting that it is incompatible.
  # Skins require to have:
  # 1. 64x64 pixels (width x height)
  # 2. a fully transparent (empty) pixel in the top left corner (coordinates 0/0 in the .png). See the 'Skins.Fix' setting for a fix.
  # # Default: 'RemoveInvalidDownloads: true'
  RemoveInvalidDownloads: true
  # Where to save the skins in the resource pack.
  # To regenerate the default path for Nexo or ItemsAdder, set 'Method: ""' in the General section.
  Directory: plugins/Nexo/pack/external_packs/MiniYouTilities/assets/mini_you/textures/skins
  # If set to false, it prevents existing skins in the destination from being overwritten.
  Overwrite: false
  # If set to true, the plugin will automatically set the top left pixel of the skin to be empty.
  # This should not have an impact on actual skin appearances as that pixel is not used by skins.
  Fix: true

Plushies:
  # Content Output
  # Default paths are set when detecting Nexo or ItemsAdder or if you switch from either to the other.
  # Paths can be customised, but is not recommend due to much room for errors.
  # Be sure to double-check if the paths and also the resulting namespace are correct!
  ConfigOutput: plugins/Nexo/items/mini_you/plushies
  ModelOutput: plugins/Nexo/pack/external_packs/MiniYouTilities/assets/mini_you/models/plushies
  TextureOutput: plugins/Nexo/pack/external_packs/MiniYouTilities/assets/mini_you/textures/plushies
  # Default namespace "mini_you".
  # Only change if you manually change the output paths above!
  NameSpace: mini_you
  # Here you can customise how the new files should be named.
  # NewModelName is the name of the new plushie model, with placeholders.
  # NewConfigName is the name of the new plushie item config, with placeholders.
  # NewItemName is the name of the new plushie as displayed in an inventory, with placeholders.
  # {model} will be the full name of the chosen model, without the file ending.
  # {skin} will be the full name of the chosen skin, without the file ending.
  # {template} will be the name of the chosen template, without "plushie_" and file ending.
  # {name} will resolve to either the name from the player from whom the skin was taken, or the skin name itself, if it is not a valid player name.
  NewModelName: plushie_{model}_{skin}
  NewConfigName: plushie_{model}_{skin}_{template}
  NewItemName: '{name} Plushie ({model})'
  # If set to false, it prevents existing plushie configs, models and textures in the destination from being overwritten.
  Overwrite: true
  # You can enable to store created plushies in a single file per model or skin.
  # The 'Bundle.Use' key can be either 'model' or 'skin'.
  # 'model' will be the full name of the chosen model, without the file ending.
  # 'skin' will be the full name of the chosen skin, without the file ending.
  # The 'Bundle.FileName' key is the name of the resulting bundle file.
  # Default settings:
  #'Use: model'
  #'FileName: "plushie_{Use}_bundle"'
  # All plushies that are made with the 'original' model are bundled in plushie_original_bundle.yml, etc.
  Bundle:
    Enabled: false
    Use: model
    FileName: "plushie_{Use}_bundle"

Figures:
  # Content Output
  # Default paths are set when detecting Nexo or ItemsAdder or if you switch from either to the other.
  # Paths can be customised, but is not recommend due to much room for errors.
  # Be sure to double-check if the paths and also the resulting namespace are correct!
  ConfigOutput: plugins/Nexo/items/mini_you/figures
  ModelOutput: plugins/Nexo/pack/external_packs/MiniYouTilities/assets/mini_you/models/figures
  TextureOutput: plugins/Nexo/pack/external_packs/MiniYouTilities/assets/mini_you/textures/figures
  # Default namespace "mini_you".
  # Only change if you manually change the output paths above!
  NameSpace: mini_you
  # Here you can customise how the new files should be named.
  # NewModelName is the name of the new figure model, with placeholders.
  # NewConfigName is the name of the new figure item config, with placeholders.
  # NewItemName is the name of the new figure as displayed in an inventory, with placeholders.
  # {model} will be the full name of the chosen model, without the file ending.
  # {skin} will be the full name of the chosen skin, without the file ending.
  # {template} will be the name of the chosen template, without "plushie_" and file ending.
  # {name} will resolve to either the name from the player from whom the skin was taken, or the skin name itself, if it is not a valid player name.
  # {box_state} will resolve to "unboxed" and "boxed" or "Unboxed" and "Boxed", depending on the context (internal names, display names).
  NewModelName: figure_{model}_{skin}_{box_state}
  NewConfigName: figure_{model}_{skin}_{template}_{box_state}
  NewItemName: '{name} Figure ({model}, {box_state})'
  # If set to false, it prevents existing figure configs in the destination from being overwritten.
  Overwrite: true
  # You can enable to store created figures in a single file per model or skin.
  # The 'Bundle.Use' key can be either 'model' or 'skin'.
  # 'model' will be the full name of the chosen model, without _boxed or _unboxed and the file ending.
  # 'skin' will be the full name of the chosen skin, without the file ending.
  # The 'Bundle.FileName' key is the name of the resulting bundle file.
  # Default settings:
  #'Use: model'
  #'FileName: "figure_{Use}_bundle"'
  # All figures that are made with the 'original' model are bundled in figure_original_bundle.yml, etc.
  Bundle:
    Enabled: false
    Use: model
    FileName: "figure_{Use}_bundle"

Pets:
  # Content Output
  # Default paths are set when detecting Nexo or ItemsAdder or if you switch from either to the other.
  # Paths can be customised, but is not recommend due to much room for errors.
  # Be sure to double-check if the paths are correct!
  ModelOutput: plugins/ModelEngine/blueprints/mini_you/pets
  MobConfigOutput: plugins/MythicMobs/packs/mini_you_pets/mobs
  MobSkillsOutput: plugins/MythicMobs/packs/mini_you_pets/skills
  PetConfigOutput: plugins/MCPets/Pets/mini_you
  # Here you can customise how the new files should be named.
  # NewModelName is the name of the new pet bbmodel, with placeholders.
  # NewConfigName sets the names of the new MythicMobs mob and MCPets configs, with placeholders.
  # NewPetName is the name of the new pet as displayed in an inventory or summoned, with placeholders.
  # {model} will be the full name of the chosen model, without the file ending.
  # {skin} will be the full name of the chosen skin, without the file ending.
  # {template} will be the name of the chosen template, without suffix and file ending, or "default", if it has the same name as the model.
  # {name} will resolve to either the name from the player from whom the skin was taken, or the skin name itself, if it is not a valid player name.
  NewModelName: pet_{model}_{skin}
  NewConfigName: pet_{model}_{skin}_{template}
  NewPetName: '{name} Pet ({model})'
  # If set to false, it prevents existing pet files in the destination from being overwritten.
  Overwrite: true

Bobbleheads:
  # Content Output
  # Default paths are set when detecting Nexo and ModelEngine.
  # Paths can be customised, but is not recommend due to much room for errors.
  # Be sure to double-check if the paths and also the resulting namespace are correct!
  BBModelOutput: plugins/ModelEngine/blueprints/mini_you/bobbleheads
  JsonModelOutput: plugins/Nexo/pack/external_packs/MiniYouTilities/assets/mini_you/models/bobbleheads
  TextureOutput: plugins/Nexo/pack/external_packs/MiniYouTilities/assets/mini_you/textures/bobbleheads
  ConfigOutput: plugins/Nexo/items/mini_you/bobbleheads
  # Default namespace "mini_you".
  # Only change if you manually change the output paths above!
  NameSpace: mini_you
  # Here you can customise how the new files should be named.
  # NewModelName is the name of the new bobblehead models, with placeholders.
  # NewConfigName is the name of the new bobblehead item config, with placeholders.
  # NewItemName is the name of the new bobblehead as displayed in an inventory, with placeholders.
  # {model} will be the full name of the chosen model, without the file ending.
  # {skin} will be the full name of the chosen skin, without the file ending.
  # {template} will be the name of the chosen template, without "bobblehead_" and file ending.
  # {name} will resolve to either the name from the player from whom the skin was taken, or the skin name itself, if it is not a valid player name.
  NewModelName: bobblehead_{model}_{skin}
  NewConfigName: bobblehead_{model}_{skin}_{template}
  NewItemName: '{name} Bobblehead ({model})'
  # If set to false, it prevents existing bobblehead configs, models and textures in the destination from being overwritten.
  Overwrite: true
  # You can enable to store created bobbleheads in a single file per model or skin.
  # The 'Bundle.Use' key can be either 'model' or 'skin'.
  # 'model' will be the full name of the chosen model, without the file ending.
  # 'skin' will be the full name of the chosen skin, without the file ending.
  # The 'Bundle.FileName' key is the name of the resulting bundle file.
  # Default settings:
  #'Use: model'
  #'FileName: "bobblehead_{Use}_bundle"'
  # All bobbleheads that are made with the 'original' model are bundled in bobblehead_original_bundle.yml, etc.
  Bundle:
    Enabled: false
    Use: model
    FileName: "bobblehead_{Use}_bundle"
```

{% endcode %}

## Mini You pack links

{% embed url="<https://mcmodels.net/products/8936/nogs-mini-you-pets-plushies>" %}

{% embed url="<https://mcmodels.net/products/11773/nogs-mini-you-pride-plushies>" %}

{% embed url="<https://mcmodels.net/products/12516/nogs-mini-you-halloween-pets-plushies>" %}

{% embed url="<https://mcmodels.net/products/12695/nogs-mini-you-christmas-pets-plushies>" %}

{% embed url="<https://mcmodels.net/products/13931/nogs-mini-you-may-4th-pets-plushies>" %}

{% embed url="<https://mcmodels.net/products/13338/nogs-mini-you-valentines-pets-plushies>" %}

{% embed url="<https://mcmodels.net/products/11621/nogs-mini-you-heroes>" %}

{% embed url="<https://mcmodels.net/products/11915/nogs-mini-you-figures>" %}

{% embed url="<https://mcmodels.net/products/13712/nogs-mini-you-bobbleheads>" %}

{% embed url="<https://mcmodels.net/products/12168/nogs-mini-you-trading-cards>" %}