Merge pull request #7 from TATyKeFei/master

wikiwikiwikiwikiwiki

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 zimzaza4
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,85 @@
+# GeyserModelEngine 自定义实体分支
+
+> GitHub仓库：[https://github.com/zimzaza4/GeyserModelEngine/tree/custom-entity](https://github.com/zimzaza4/GeyserModelEngine/tree/custom-entity)
+
+Language [English](README_EN.md) | [简体中文](README.md)
+
+# 这个跟主分支有什么区别
+
+这是个为[zimzaza4的Geyser自定义实体分支](https://github.com/zimzaza4/Geyser)做的版本，不支持原版的Geyser。
+
+跟主分支不同的是，这个是真正的自定义实体
+
+主分支是生成个steve发送4d皮肤给be玩家，支持原版Geyser。
+
+只需要往资源包里赛动画文件即可，可以有效防止你的模型被白嫖，但似乎限制也挺多
+
+总之两者各有各优势，根据各服务器情况选择
+
+# 如何安装
+
+根据服务端版本下载以下插件
+
+[GeyserUtils](https://github.com/zimzaza4/GeyserUtils)
+
+[GeyserModelEngine](https://github.com/zimzaza4/GeyserModelEngine)
+
+[zimzaza4的Geyser自定义实体分支](https://github.com/zimzaza4/Geyser)
+
+[GeyserModelEnginePackGenerator](https://github.com/zimzaza4/GeyserModelEnginePackGenerator)
+
+下载完后，将`GeyserModelEngine` `Geyser自定义实体分支`放入插件文件夹
+
+根据服务端版本把`geyserutils-spigot`/`velocity`/`bungeecord`放入插件文件夹
+
+`GeyserModelEnginePackGenerator` `geyserutils-geyser`放入geyser的扩展文件夹
+
+先启动服务器生成相关配置文件，之后关闭服务器就安装好了
+
+当然，先别急着用，现在你还得接着读下去
+
+# 转换模型
+
+现在`GeyserModelEnginePackGenerator`长大了已经学会自己转换模型打包资源包了
+
+我们打开以下路径 `plugins/Geyser-Spigot/extensions/geysermodelenginepackgenerator/input/`
+
+在此目录创建一个文件夹名为模型的ID，比如我有个模型id为`parry_knight`，那就命名为`parry_knight`
+
+<img src="docsimg/example.jpg" width="500">
+
+> 每个模型都要有独立的模型文件夹
+
+我们将模型、动画和纹理全部原封不动丢进这个文件夹
+
+<img src="docsimg/example1.jpg" width="500">
+
+重启服务器或者重载geyser让他开始生成资源包
+
+来到`plugins/Geyser-Spigot/extensions/geysermodelenginepackgenerator`目录
+
+<img src="docsimg/example2.jpg" width="500">
+
+将`geysermodelenginepackgenerator`生成的`generated_pack.zip`丢进`Geyser-Spigot/packs`目录就安装好了
+
+最后一步，重载Geyser或者重启服务器加载资源包
+
+注意! 他是检测模型的数量来打包的，如果数量没有变更不会执行。
+
+想重新打包建议先删掉`generated_pack.zip`然后改uuid或者版本号
+
+# 完结
+
+恭喜你现在学会如何使用了，有BUG请发Issues
+
+# 当前限制
+
+* 不支持多贴图
+* 待挖掘
+
+# 常见问题
+
+### 为什么召唤模型后会变成史蒂夫?
+
+如果你确定你根据上面的教程一步一步做了，可能是这个模型的问题?
+

README_EN.md

@@ -0,0 +1,79 @@
+# GeyserModelEngine CustomEntity Fork
+
+> GitHub：[https://github.com/zimzaza4/GeyserModelEngine/tree/custom-entity](https://github.com/zimzaza4/GeyserModelEngine/tree/custom-entity)
+
+[English (working)](README_EN.md) | [简体中文](README.md)
+
+# 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
+
+[GeyserUtils](https://github.com/zimzaza4/GeyserUtils)
+
+[GeyserModelEngine](https://github.com/zimzaza4/GeyserModelEngine)
+
+[zimzaza4's GeyserCustomEntity Fork](https://github.com/zimzaza4/Geyser)
+
+[GeyserModelEnginePackGenerator](https://github.com/zimzaza4/GeyserModelEnginePackGenerator)
+
+place `GeyserModelEngine` `GeyserCustomEntityFork` in the plugins folder
+
+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
+
+We drop the model, animations, and textures into this folder intact
+
+<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">
+
+Will `geysermodelenginepackgenerator` generated `generated_pack.zip` put into the `GeyserSpigot/packs` directory is installed
+
+As a final step, reload Geyser or restart the server to load the resource pack
+
+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
+
+# 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?
+