Skip to content
This repository has been archived by the owner on Jan 16, 2024. It is now read-only.

How To Add Bedrock Compatibility

Jump to bottom
thefourCraft edited this page Dec 23, 2022 · 1 revision

Warning
This is meant to explain the basics of using Java resource pack predicates with Geyser, which currently include custom model data, damage, and unbreaking status.

Introduction

Using a resource pack with Geyser can be challenging, mainly if it includes more complex features such as block models, block states, armor, sounds, emoji, custom bows, eating animations, inventory for 3D models, and item frame displays. While support for these features may be added in the future, currently you may have to rely on your own knowledge and resources when trying to implement them. Please note that the developers and contributors to this project may not have extensive knowledge of the resource pack systems used in Bedrock and Java Edition, so you may be directed to other resources or communities when seeking help with more complex use cases. We will do our best to assist you, but please do not be offended if we are unable to offer in-depth support for these advanced features.

Example Walkthrough for Pack Conversion (2D/3D Damage and Custom Model Data Items)

Caveats:

This guide will only work for 2D and 3D models added via custom model data and damage predicates. If you have built your resource pack with something like ItemsAdder and are unfamiliar with these terms, it is highly advised that you familiarize yourself with these concepts before attempting to do so. See the "Helpful Links" section at the end of this post. [AWARNING]The converter used in this guide will NOT generate inventory icons for 3D-modeled items.[/AWARNING] This means that on bedrock, any 3D-modeled items will appear in the inventory as the icon of the vanilla item they modify. Suppose you need icons for these items because they are obtainable by players. In that case, you must generate your own icon images, add them to a bedrock resource pack, provider a mappings file for the converter with the location of these texture files in the bedrock pack, and provide this bedrock pack to the converter. Detailed instructions for the format of these mappings are provided in the README of the converter

  1. Obtain a direct download link to your pack. A direct download link means that the link directly leads to a file download when clicked without any further action. The pack must be a valid resource pack, meaning that the assets and pack.mcmeta file MUST be in the root of the zip file, NOT an enclosing folder.

  2. Open a conversion request here. using the direct download link (note that this requires a GitHub account).

  3. Wait for the conversion process to finish. When done, a bot will reply to the issue with a link to the conversion run summary. The files you will need are linked as a zip file called Pack Files at the bottom of the page. Download this zip file.

  4. Unzip the Pack Files zip file.

  5. Ensure that you are using the latest version of Geyser available for download here

  6. After starting the Geyser once, it should create a folder called "custom_mappings". Place the file geyser_mappings.json from the Pack Files zip in this folder.

  7. Place the pack geyser_resources.mcpack from the Pack Files zip in Geyser's packs folder.

  8. If you have not already, ensure GeyserOptionalPack.mcpack is in the packs folder of Geyser, which can be downloaded here

  9. Restart your server.

Helpful Links

Configuring Mappings for Java Resource Pack Predicates with Geyser
Example Packs and Extension
Automated Conversion of Java Resource Packs with Custom Model Data
DISCLAIMER: This converter is not under the Geyser organization and is in no way endorsed by Geyser.

General Help with Bedrock Packs:

https://wiki.bedrock.dev/
Introduction to Java Resource Packs:
See the sections on Understanding JSON, Pack Structure, and Predicates
https://wiki.mcjava.dev/docs/basics/understanding-json
https://wiki.mcjava.dev/docs/basics/pack-structure
https://wiki.mcjava.dev/docs/basics/predicates

How To Bedrockfie IA

  1. Install Itesmadder

  2. Create the itemsaddder resource pack /iazip

  3. Navigate to plugins\ItemsAdder\data\resource_pack

  4. Download the Converter

  5. Run the converter, and follow the README.MD Instructions

  6. After you have found you should get custom_mappings file and a resource pack

    [AWARNING]Pay attention to is custom_mapping and ResoucePack ignore Addon[/AWARNING]

  7. Drag and drop to the folder geyser-spigot

Limitations

  1. which model is 2D The icon of the item in the inventory will be displayed automatically. 3D must learn more about item_texture (If I'm free, I will teach.)

  2. For better model performance, you need a resource pack addon put in the pack in the folder geyser-spigot

This isn't perfect. You will need to learn about resource packs mcbedrock more

Special Thanks

Kastle#4801 - for putting this guide 🤩
ProjectZero#4694 - for creating and explaining How To Bedrockfie IA & Providing Useful info
CitizenPrayer#7777 - For Providing Useful info
Stefano#7366 - For Providing Useful info
Беаст#9140 - For Providing Useful info
DinoBoss#6985 - For Providing Useful info
StuxieDev#6969 - For Providing Useful info

Clone this wiki locally