Update Installation authored by Ashijin's avatar Ashijin
...@@ -2,35 +2,46 @@ Installation ...@@ -2,35 +2,46 @@ Installation
------------ ------------
### Plugin ### Plugin
To install MCCosmetics, simply drop it in your Spigot/Paper `plugins` folder and restart your server! MythicCosmetics is specifically an add-on for Mythic and requires the latest version of MythicMobs to function. Aside from that, simply drop it in your Spigot/Paper `plugins` folder and restart your server!
### Resource Pack ### Resource Pack
MCCosmetics comes with a resource pack that includes core shaders files. Using these is required for the Emotes feature to work. **This may disrupt the use of Player Heads on your server at this time.** MythicCosmetics has a basic resource pack with a custom GUI and icons, as well as the base cosmetics. However, it is highly recommended to use a resource pack generator to make your life easier, such as MythicCrucible or Nexo.
### Premium Cosmetic Pack Crucible is recommended as the plugin is designed to work seamlessly with it, and the pack files are generated in a way where Crucible will automatically generate it for you.
MCCosmetics Premium comes with extra resource pack files that includes numerous cosmetics and a fancy menu GUI!
For regular resource pack files, you can simply merge these files into your own resource pack if your server already has one. For any ModelEngine Accessory files, you can simply drop them in the ModelEngine blueprints folder. Resource Pack files are generated (and can be modified) in 2 places:
- `MythicMobs/packs/.internal/assets` - Pack files for the GUI and internal plugin parts.
- `MythicMobs/packs/ExamplePack_Cosmetics/assets` - Pack for the example cosmetics
*If you need to change the item or CustomModelData values when merging resource packs, you will need to edit the MCCosmetics cosmetic and menu files with the appropriate values so that the GUI and icons appear correctly!* If you have Premium, any additional cosmetics will be generated in the same `ExamplePack_Cosmetics` pack folder.
### Manual Resource Pack Handling
#### Items:
- `.json` and `texture` files can be copied from the pack asset folders into your own resource pack as you like
- Any item `.bbmodel` files included in the plugin can be opened with BlockBench and exported for use as you'd like.
- For ModelEngine cosmetic files included in `assets/modelengine`, these will be loaded by ModelEngine normally and do not need to be touched.
- Sprays are sent as map data and do not need to be included in your Resource Pack
Dependencies Dependencies
------------ ------------
- **Core Shaders** - MCCosmetics requires the usage of Core Shaders for the **Emotes** feature, and the emotes may not work with any other resource packs, mods, or plugins that disrupt core shaders. - **MythicMobs** - MythicCosmetics is an add-on for Mythic and requires MythicMobs to function.
- **ModelEngine** - Required for the **accessories** and **emotes** cosmetic types, and highly recommended for **mounts** and **pets**.
- **MythicCrucible** - Not required but highly recommended for easy pack generation.
Installing Cosmetic Packs Installing Cosmetic Packs
------------------------- -------------------------
MCCosmetics is set up to support packs of cosmetics that people can easily organize or distribute. These are placed in the `packs` folder in the MCCosmetics plugin directory. MythicCosmetics is set up to support packs of cosmetics that people can easily organize or distribute. These are placed inside the Mythic `packs` folder in the `MythicMobs` plugin directory, as this is an add-on for Mythic.
Inside the `packs` folder, each pack can have its own directory, and inside of that should be a folder for each cosmetic type. Inside the `packs` folder, each pack can have its own directory, and inside of that should be a `cosmetics` folder with a sub-folder for each cosmetic type.
For example, If you wanted to make or install a pack named `My_Cool_Pack` it would be located in the Packs folder with a folder structure like this: For example, If you wanted to make or install a pack named `My_Cool_Pack` it would be located in the Packs folder with a folder structure like this:
* `/plugins/MCCosmetics/packs/My_Cool_Pack/` * `/plugins/MythicMobs/packs/My_Cool_Pack/`
* `/plugins/MCCosmetics/Packs/My_Cool_Pack/accessories` * `/plugins/MythicMobs/packs/My_Cool_Pack/cosmetics/accessories`
* `/plugins/MCCosmetics/Packs/My_Cool_Pack/backs` * `/plugins/MythicMobs/packs/My_Cool_Pack/cosmetics/backs`
* `/plugins/MCCosmetics/Packs/My_Cool_Pack/gestures` * `/plugins/MythicMobs/packs/My_Cool_Pack/cosmetics/gestures`
* `/plugins/MCCosmetics/packs/My_Cool_Pack/hats` * `/plugins/MythicMobs/packs/My_Cool_Pack/cosmetics/hats`
* `/plugins/MCCosmetics/Packs/My_Cool_Pack/offhands` * `/plugins/MythicMobs/packs/My_Cool_Pack/cosmetics/offhands`
* `/plugins/MCCosmetics/packs/My_Cool_Pack/sprays` * `/plugins/MythicMobs/packs/My_Cool_Pack/cosmetics/sprays`
Each cosmetic type folder would then have the configuration files for that specific type of cosmetic in it. Each cosmetic type folder should contain the configuration files for that specific type of cosmetic in it.
\ No newline at end of file \ No newline at end of file