diff --git a/README.md b/README.md index 56e8241..148e7d3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ [![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](https://discord.gg/geysermc) Rainbow is a client-side Minecraft mod for the Fabric modloader to generate Geyser item mappings and bedrock resourcepacks -for use with Geyser's [custom item API (v2)](https://github.com/geyserMC/geyser/pull/5189). +for use with Geyser's [custom item API (v2)](https://github.com/geyserMC/geyser/pull/5189). Rainbow is available +for Minecraft 1.21.6, 1.21.7 and 1.21.8. Rainbow is currently experimental and capable of the following: @@ -35,4 +36,14 @@ you use them as follows: - `/rainbow auto inventory` - scans all inventory menus and containers you open for custom items, and maps all that are found. This is handy for plugins that offer an inventory menu listing all custom items. Use `/rainbow auto stop` to stop the mapping of custom items. 3. Once you have mapped all of your custom items, use `/rainbow finish` to finish the pack. Rainbow will then export the resourcepack and item mappings it has created. +When you've finished your pack, navigate to the `.minecraft/rainbow/` folder. You can also click on the "Wrote pack to disk" in chat to open this folder. +In this folder, you'll find 3 important files: + +- `geyser_mappings.json`: you need to put this file in the `custom_mappings` folder in Geyser's config folder. +- `pack.zip`: you need to put this file in the `packs` folder in Geyser's config folder. +- `report.txt`: you don't need to do anything with this file, but it contains information about generated assets and possible problems that occurred. + +Once you have taken these steps, restart your server. Bedrock players should then download the generated pack upon joining, +and if everything went well, they should be able to see custom items! + If you have any questions or run into any problems, please do feel free to ask for support in the Geyser Discord! diff --git a/build.gradle b/build.gradle index 103d063..a8d7bb3 100644 --- a/build.gradle +++ b/build.gradle @@ -31,13 +31,13 @@ dependencies { processResources { inputs.property "version", project.version - inputs.property "minecraft_version", project.minecraft_version + inputs.property "supported_versions", project.supported_versions inputs.property "loader_version", project.loader_version filteringCharset "UTF-8" filesMatching("fabric.mod.json") { expand "version": project.version, - "minecraft_version": project.minecraft_version, + "supported_versions": project.supported_versions, "loader_version": project.loader_version } } diff --git a/gradle.properties b/gradle.properties index c04bfed..982eae9 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,14 +1,15 @@ org.gradle.jvmargs=-Xmx1G # Fabric Properties -minecraft_version=1.21.7 +minecraft_version=1.21.8 parchment_version=1.21.6:2025.06.29 loader_version=0.16.14 # Mod Properties -mod_version=0.0.1-1.21.7 +mod_version=0.1.0-1.21.8 +supported_versions=>=1.21.6 <=1.21.8 maven_group=org.geysermc archives_base_name=rainbow # Dependencies -fabric_version=0.129.0+1.21.7 +fabric_version=0.129.0+1.21.8 diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json index 5cc4161..a3e78ce 100644 --- a/src/main/resources/fabric.mod.json +++ b/src/main/resources/fabric.mod.json @@ -26,7 +26,7 @@ "depends": { "fabricloader": ">=${loader_version}", "fabric-api": "*", - "minecraft": "${minecraft_version}" + "minecraft": "${supported_versions}" }, "custom": { "modmenu": {