Merge pull request #4 from TATyKeFei/master

add english wiki

README.md

@@ -2,6 +2,8 @@
 
 > GitHub仓库：https://github.com/zimzaza4/GeyserModelEngine
 
+[English](README_EN.md) | [简体中文](README.md)
+
 # 这是个什么玩意
 
 能让你Geyser服务器支持MEG4
@@ -16,27 +18,27 @@
 
 [LibsDisguises](https://www.spigotmc.org/resources/libs-disguises-free.81/)
 
-下载完后，将GeyserModelEngine放入插件文件夹
+下载完后，将`GeyserModelEngine``LibsDisguises`放入插件文件夹
 
-把geyserutils-spigot/velocity/bungeecord放入插件文件夹
+根据服务端版本把`geyserutils-spigot`/`velocity`/`bungeecord`放入插件文件夹
 
-将geyserutils-geyser放入geyser的扩展文件夹，这时就安装好了
+将`geyserutils-geyser`放入geyser的扩展文件夹，这时就安装好了
 
 当然，先别急着用，现在你还得接着读下去
 
 # 转换模型
 
-打开你的bbmodel模型文件，将模型转换为基岩版模型
+打开你的bbmodel模型工程文件，将模型转换为基岩版模型
 
-打开刚转换完的模型，把这个多余的hitbox删了
+打开刚转换完的模型，把这个多余的hitbox删了（如果没有就不用管）
 
 <img src="docimg/hitbox.png" width="500">
 
-不然基岩版看会变成这样
+不然BE玩家看会看到这个hixbox碰撞箱
 
 <img src="docimg/hitbox1.jpg" width="500">
 
-然后记得保存模型纹理
+然后记得导出模型的纹理
 
 # 安装模型
 
@@ -44,12 +46,15 @@
 
 这时我们再创建一个文件夹名为你模型的id。比如我使用的测试模型的id是`parry_knight`，就创建`parry_knight`文件夹
 
+创建完后你的文件路径应该是这样 `plugins/Geyser-Spigot/extensions/geyserutils/skins/模型id/`
+
 最后将模型和纹理贴图放进去
 
+tips: 每个模型都要有独立的模型文件夹
+
 <img src="docimg/example.jpg" width="500">
 
-
+这时候重启服务器生成MEG4模型，你的BE玩家应该能正常看到模型了
-这时候重启服务器你的BE玩家应该能正常看到模型了。
 
 接下来就是有关模型动画的部分了!
 
@@ -57,7 +62,7 @@
 
 将模型的动画导出json格式
 
-将动画文件名称修改为"animation.模型ID.json"
+将动画文件名称修改为`animation.模型ID.json`
 
 之后放入你的资源包
 
@@ -65,17 +70,17 @@
 
 现在我们打开动画文件开始修改动画文件里的动画id
 
-原本所有的动作id基本都是idle、walk这样的，现在你得给他加个前缀
+原本所有的`动作id`基本都是`idle`、`walk`这样的，现在你得给他加个前缀
 
-例如：idle
+例如：`idle`
 
-改为：animation.模型ID.idle
+改为：`animation.模型ID.idle`
 
-示例：animation.parry_knight.idle
+示例：`animation.parry_knight.idle`
 
 改完后修改资源包版本号或者uuid，打包资源包
 
-重载Geyser或者重启服务器
+最后一步，重载Geyser或者重启服务器
 
 # 完结
 
@@ -87,4 +92,7 @@
 
 # 常见问题
 
-同上
+### 为什么生成模型后会变成史蒂夫?
+
+你没好好读怎么安装模型
+

README_EN.md

@@ -0,0 +1,99 @@
+# GeyserModelEngine
+
+> GitHub：https://github.com/zimzaza4/GeyserModelEngine
+
+[English](README_EN.md) | [简体中文](README.md)
+
+# About
+
+it can let your Geyser server support  on MEG4
+
+# How to install？
+
+download this plugin
+
+[GeyserUtils](https://github.com/zimzaza4/GeyserUtils)
+
+[GeyserModelEngine](https://github.com/zimzaza4/GeyserModelEngine)
+
+[LibsDisguises](https://www.spigotmc.org/resources/libs-disguises-free.81/)
+
+After downloading, place GeyserModelEngine in the plugins folder
+
+The `geyserutils-spigot`/`velocity`/`bungeecord` into the plugins folder
+
+Put `geyserutils-geyser` into geyser extensions folder, and the installation is complete
+
+# convert model
+
+Open your bbmodel project file and convert the model to bedrock model
+
+Open the newly converted model and delete the extra hitbox (if not, leave it alone)
+
+<img src="docimg/hitbox.png" width="500">
+
+Otherwise BE players will see this hixbox
+
+<img src="docimg/hitbox1.jpg" width="500">
+
+Then save to export the texture of the model
+
+# install model
+
+Open Geyser's extensions folder and create a folder called `geyserutils`, and then create a folder inside called `skins`
+
+Now let's create a folder called the id of your model.  For example, if the id of the test model I use is `parry_knight`, I create a `parry_knight` folder
+
+Your file path should look like this: 
+
+`plugins/Geyser-Spigot/extensions/geyserutils/skins/modelid/`
+
+Finally put the model and texture map in
+
+<img src="docimg/example.jpg" width="500">
+
+now restart your server to generated MEG4 model , your BE player should be able to see the model normally.
+
+restart you server,summon model.We should be able to see the model normally
+
+after that , it's about model's animation's part :
+
+# model animation
+
+let model's animation export to json format
+
+named the animation file by `animation.modelID.json`
+
+then put it into your resource pack
+
+<img src="docimg/example1.jpg" width="500">
+
+now let us open the animation file to starting change the animaiton ID
+
+originally , all the `animationID` were basic named like  `idle` , `walk` , but now you should add a prefix
+
+such as :
+
+`idle` to `animation.modelID.idle`
+
+example : `animation.parry_knight.idle`
+
+after changed the resource pack 's version or uuid , pack the resource pack.
+
+finally , restart the Geyser or server
+
+# END
+
+Congratulations ! now you exactly know how to use , if you still can't finish yet
+
+well , maybe that's my problem = D
+
+# restrictions
+
+,,,,,a lot
+
+# problems
+
+### why I have generrated the model , but I got a steve ?
+
+I guess that you have not wholly read this file..