mirror of
https://github.com/xSquishyLiam/mc-GeyserModelEngine-plugin.git
synced 2025-12-19 14:59:19 +00:00
74 lines
3.6 KiB
Markdown
74 lines
3.6 KiB
Markdown
# GeyserModelEngine
|
|
# About
|
|
|
|
Thanks to [Willem](https://github.com/OmeWillem) for adding the following features:
|
|
- Part Visibility
|
|
- Color support
|
|
- Scaling support
|
|
- & more
|
|
|
|
# How To Install
|
|
|
|
Download the following plugins according to what server software you use.
|
|
|
|
| plugins | Link | effect |
|
|
| :--- | :---- | :--- |
|
|
| GeyserUtils | [Github](https://github.com/GeyserExtensionists/GeyserUtils) | Get your Geyser to support calling some BE stuff |
|
|
| GeyserModelEngine | [Github](https://github.com/GeyserExtensionists/GeyserModelEngine) | Make your bedrock support MEG4 |
|
|
| GeyserModelEnginePackGenerator | [Github](https://github.com/GeyserExtensionists/GeyserModelEnginePackGenerator) | Help you automatically transform the model to generate resource packs |
|
|
|
|
- Put `GeyserModelEngine` in the plugins folder (only Spigot or forks of Spigot supported)
|
|
- Put either `geyserutils-spigot` in your plugins folder aswell (`geyserutils-velocity`/`geyserutils-bungeecord` in your Velocity/Bungeecord plugins folder if you use it)
|
|
- Put `GeyserModelEnginePackGenerator` and `geyserutils-geyser` into `plugins/[Geyser-Folder]/extensions`
|
|
|
|
Start the server to generate the relevant configuration files, and then shut down the server to convert any models.
|
|
|
|
# Convert Models
|
|
This is old method to convert model:
|
|
|
|
`GeyserModelEnginePackGenerator` is capable of generating models all by itself. After generating it will also apply this pack automatically.
|
|
|
|
- First go to `plugins/[Geyser-Folder]/extensions/geysermodelenginepackgenerator/input/`
|
|
- Create a folder in this directory with the ID of the model. (this is the same name as your model within ModelEngine 4.)
|
|
|
|
<img src="docsimg/example.jpg" width="500">
|
|
|
|
> Each model should have a separate model folder
|
|
> Subfolders are supported if you want to categorize them
|
|
|
|
- Now use BlockBench and convert your model to a Bedrock Entity, this will allow you to export the Bedrock Geometry and Animations.
|
|
- Put the geometry, animations and texture file in this folder you've made.
|
|
|
|
<img src="docsimg/example1.jpg" width="500">
|
|
|
|
- Restart the server or reload geyser to start generating the resource pack.
|
|
- Go to `plugins/[Geyser-Folder]/extensions/geysermodelenginepackgenerator`, and you should see your pack generated!
|
|
|
|
<img src="docsimg/example2.jpg" width="500">
|
|
|
|
- Final step, reload Geyser or restart the server to load the resource pack.
|
|
- Congratulations, you've completed this tutorial!
|
|
|
|
# Model Packer
|
|
|
|
This is new way to convert model
|
|
- Firstly, install [packer plugin](https://github.com/GeyserExtensionists/GeyserModelEngineBlockbenchPacker) for your blockbench.
|
|
- Then, open your bbmodel, go `File -> Export -> Export GeyserModelEngine Model`, you will get a zip, just unzip it to `input` folder.
|
|
|
|
# Tips
|
|
|
|
* Pay attention! The pack only regenerates when the number of models changes, you can technically speaking remove the generated_pack folder to force a reload aswell.
|
|
* You do not have to manually put the pack into the packs folder of Geyser, the extension is capable of loading the pack itself.
|
|
* Choose a right texture when use the packer.
|
|
|
|
# Current issues
|
|
|
|
* Multi-textures and Animated textures need use [a blockbench plugin](https://github.com/GeyserExtensionists/GeyserModelEngineBlockbenchPacker) to export
|
|
|
|
* Please report any bugs
|
|
|
|
# FAQ
|
|
|
|
### Where can I contact you?
|
|
You can contact us on our Discord: https://discord.gg/NNNaUdAbpP
|