From 49f1d3ff244d047d79955405317ebe7fc57a459c Mon Sep 17 00:00:00 2001 From: Kas-tle <26531652+Kas-tle@users.noreply.github.com> Date: Thu, 26 May 2022 03:14:24 +0000 Subject: [PATCH] Update readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e48864d..08eaf6a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ ## Usage + +### Local + To run, simply: ``` ./converter.sh MyResourcePack.zip @@ -17,10 +20,14 @@ For example: ``` ./converter.sh MyResourcePack.zip -w "false" -m "MyBedrock.mcpack" -a "entity_alphatest_one_sided" -b "alpha_test" -f "null" -v "1.18.2" ``` +### Github Actions + +You may also run the converter through Github Actions in this repository by creating an issue with the [Pack Conversion](https://github.com/Kas-tle/java2bedrock.sh/issues/new?assignees=&labels=conversion&template=pack-conversion.yml&title=%5BPack%5D%3A+) template. You are only required to enter the link to the Java pack, though the options described above may also be configured. Your pack will then be queued for conversion by Github Actions. After conversion is complete, the Github Actions bot will reply to your issue with a link to download your converted pack and associated mappings file. Included in the bundle is a behavior pack and addon to view the models in single player, as well as a configuration file containing the oaths to the models converted from the Java resource pack and their corresponding identifiers in the Bedrock resource pack. + +## About **NOTICE:** Due to [MCPE-152191](https://bugs.mojang.com/browse/MCPE-152191), a [resource pack](https://bugs.mojang.com/secure/attachment/473588/473588_BlockGeoFi.mcpack) with a a marketplace uuid that has been whitlisted to use the old block rendering engine must be applied above the resource pack containing the block models in order for them to render properly. This is only required to preview the models in game with an inventory icon. Geyser does not currently support the use of block models, so this script will simply use the icon of the vanilla item. -## About The script has been updated to handle parent models and 2D items. It will generate a single sprite sheet for all textures used in 3D models, and copy over textures for 2D items individually. Your script and resource pack zip file must be in the same directory. Ensure that this zip file is properly setup. It should not have a root directory. Your resource pack must also be formatted correctly, to vanilla specifications. By default, this script will download the default assets in order to generate texture atlases in cases in which you have utilized those. If you wish to use different default assets, you may specify this at the beginning. The default pack will then be downloaded after your specified assets, with your specified assets taking precedence. As long as you provide valid JSON, the script should output something you can use.