mirror of
https://github.com/GeyserExtensionists/GeyserModelEngine.git
synced 2026-01-06 15:42:05 +00:00
Update the english readme
This commit is contained in:
Willem
72
README.md
Normal file
72
README.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# GeyserModelEngine Fork
|
||||
|
||||
> GitHub：[https://github.com/zimzaza4/GeyserModelEngine/tree/custom-entity](https://github.com/OmeWillem/GeyserModelEngine/tree/custom-entity)
|
||||
|
||||
# About
|
||||
|
||||
This is a fork of the GeyserModelEngine made by [zimzaza4](https://github.com/zimzaza4/GeyserModelEngine/tree/custom-entity).
|
||||
This fork adds a bunch of stuff (alongside more recent bug fixes) like:
|
||||
- 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/OmeWillem/GeyserUtils) | Get your Geyser to support calling some BE stuff |
|
||||
| GeyserModelEngine | [Github](https://github.com/OmeWillem/GeyserModelEngine) | Make your bedrock support MEG4 |
|
||||
| GeyserModelEnginePackGenerator | [Github](https://github.com/OmeWillem/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` in your Velocity 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
|
||||
|
||||
`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
|
||||
|
||||
- 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.
|
||||
|
||||
> The new version of BlockBench exports the bedrock model format_version as `1.21.0`.
|
||||
> You need to change it to `1.12.0` manually.
|
||||
> Otherwise your client will NOT see the model.
|
||||
|
||||
<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!
|
||||
|
||||
# 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.
|
||||
|
||||
# Current issues
|
||||
|
||||
* Multi-textures are not supported
|
||||
* Please report any bugs (discord: willem.dev)
|
||||
|
||||
# FAQ
|
||||
|
||||
### Where can I contact you?
|
||||
You can contact me on discord under the name: willem.dev
|
||||
|
||||
83
README_EN.md
83
README_EN.md
@@ -1,83 +0,0 @@
|
||||
# GeyserModelEngine CustomEntity Fork
|
||||
|
||||
> GitHub：[https://github.com/zimzaza4/GeyserModelEngine/tree/custom-entity](https://github.com/zimzaza4/GeyserModelEngine/tree/custom-entity)
|
||||
|
||||
🌏 [[English](README_EN.md)] [[简体中文](README.md)] [Welcome to contribute more languages]
|
||||
|
||||
# About
|
||||
|
||||
this is for [GeyserCustomEntityFork](https://github.com/zimzaza4/Geyser)'s version，no support vanilla Geyser
|
||||
|
||||
Unlike the master, this one is truly a custom entity
|
||||
|
||||
# how to install
|
||||
|
||||
Download the following plugins according to the server core
|
||||
|
||||
| plugins | Link | effect |
|
||||
| :--- | :---- | :--- |
|
||||
| GeyserUtils | [Github](https://github.com/zimzaza4/GeyserUtils) | Get your Geyser to support calling some BE stuff |
|
||||
| GeyserModelEngine | [Github](https://github.com/zimzaza4/GeyserModelEngine) | Make your bedrock support MEG4 |
|
||||
| GeyserModelEnginePackGenerator | [Github](https://github.com/zimzaza4/GeyserModelEnginePackGenerator) | Help you automatically transform the model to generate resource packs |
|
||||
|
||||
replace your Geyser with that Geyser fork
|
||||
|
||||
put `GeyserModelEngine` in the plugins folder (only spigot)
|
||||
|
||||
and `geyserutils-spigot`/`velocity`/`bungeecord`
|
||||
|
||||
`GeyserModelEnginePackGenerator` `geyserutils-geyser` put into `plugins/geyser/extensions`
|
||||
|
||||
Start the server to generate the relevant configuration files, and then shut down the server to install
|
||||
|
||||
# convert model
|
||||
|
||||
`GeyserModelEnginePackGenerator` can generate resource packs himself
|
||||
|
||||
We came to `plugins/Geyser-Spigot/extensions/geysermodelenginepackgenerator/input/`
|
||||
|
||||
Create a folder in this directory called the ID of the model.
|
||||
|
||||
For example, if I have a model with the id `parry_knight`, name it `parry_knight`
|
||||
|
||||
<img src="docsimg/example.jpg" width="500">
|
||||
|
||||
> Each model should have a separate model folder
|
||||
|
||||
Then drop the model, animations, and textures into this folder intact
|
||||
|
||||
The new version of BlockBench exports the bedrock model format_version as `1.21.0`
|
||||
You need to change it to `1.12.0` manually
|
||||
Otherwise your client will not see the model
|
||||
|
||||
<img src="docsimg/example1.jpg" width="500">
|
||||
|
||||
Restart the server or reload geyser to start generating resource packs
|
||||
|
||||
go to `plugins/Geyser-Spigot/extensions/geysermodelenginepackgenerator`
|
||||
|
||||
<img src="docsimg/example2.jpg" width="500">
|
||||
|
||||
final step, reload Geyser or restart the server to load the resource pack
|
||||
|
||||
# tips
|
||||
|
||||
* Pay attention! It is packaged by detecting the number of models and will not execute if the number does not change.
|
||||
* To repackage it is recommended to delete `generated_pack.zip` and change the uuid or version
|
||||
* instead of dropping the package into the `geyser/packs` directory, it will load pack itself
|
||||
|
||||
# The end
|
||||
|
||||
Congratulations you now learn how to use, any bugs please send Issues
|
||||
|
||||
# limit
|
||||
|
||||
* Multi-textures are not supported
|
||||
* To be excavated
|
||||
|
||||
# FAQ
|
||||
|
||||
### Why does it turn into Steve after summoning a model?
|
||||
|
||||
If you're sure you did it step by step according to the tutorial above, there may be a problem with this model?
|
||||
|
||||
Reference in New Issue
Block a user