Some more updates

This commit is contained in:
Eclipse committed 2026-08-04 11:06:17 +00:00
1 parent 247718bb74
commit cd4b48ee45
5 files changed
+39 -3

No files matched your search

+18
View File
@@ -15,3 +15,21 @@ Geyser supports mapping various custom additions to the game via resource packs
Geyser does not convert resource packs from Java Edition automatically.
However, you can use automatic tools such as [Rainbow](/wiki/other/rainbow/) or [Thunder](/wiki/other/thunder) to make converting custom content simpler.
:::
## JSON mappings {#json-mappings}
Various custom additions to the game will require writing custom JSON mappings for Geyser. These mappings are placed
within the `custom_mappings` folder in Geyser's config directory. To enable the usage of custom JSON mappings, ensure
that `gameplay.enable-custom-content` is set to `true` in your `config.yml` file:
```yaml
# Whether to add any items and blocks which normally does not exist in Bedrock Edition.
# This should only need to be disabled if using a proxy that does not use the "transfer packet" style of server switching.
# If this is disabled, furnace minecart items will be mapped to hopper minecart items.
# Geyser's block, item, and skull mappings systems will also be disabled.
# This option requires a restart of Geyser in order to change its setting.
enable-custom-content: true
```
JSON mappings will always have a `format_version` key defined at the root object. Refer to the documentation of the
content you're mapping (items, blocks, etc.) to see what the current `format_version` is.
+2
View File
@@ -18,6 +18,8 @@ would normally require mods to be installed on the Java client.
To set up custom items in Geyser, you have to choose how you are going to register your items. The easiest is using a json mapping file,
but you can also use a Geyser extension which uses the [Geyser API](/wiki/geyser/api/). Further, a Bedrock edition resource pack must also be supplied to ensure Bedrock players can see custom items.
For setting up JSON mappings, please see the instructions [here](/wiki/geyser/custom-content#json-mappings).
:::warning
Geyser does not convert resource packs from Java Edition, and also does not generate custom item mappings automatically.
However, you can use automatic tools such as [Rainbow](/wiki/other/rainbow/) to make converting content simpler.
+7
View File
@@ -26,6 +26,11 @@ Whilst Geyser tries its best to convert custom skulls automatically, it does not
However, you can use automatic tools such as [Rainbow](/wiki/other/rainbow/) to make converting content simpler.
:::
:::info
Custom skulls used to be registered using a YAML file in Geyser's config directory, `custom-skulls.yml`. This file
is legacy and its contents will automatically be migrated to custom JSON mappings when Geyser starts.
:::
## Registering custom skulls
Custom skulls can be registered through 4 methods:
@@ -43,6 +48,8 @@ Custom skulls can be registered through 4 methods:
<Tabs groupId="custom-skull-implementation">
<TabItem value="json" label="JSON mappings">
For setting up JSON mappings, please see the instructions [here](/wiki/geyser/custom-content#json-mappings).
JSON mappings have to specify the `format_version` set to `1`, and list all custom skulls under the
`skulls` key. This key holds an object in which Java Edition usernames, user UUIDs, profile hashes or skin texture
hashes can be specified.
+2
View File
@@ -38,6 +38,8 @@ the same format as Java's custom waypoint styles and should feel very familiar.
<Tabs groupId="custom-waypoint-implementation">
<TabItem value="json" label="JSON-mappings">
For setting up JSON mappings, please see the instructions [here](/wiki/geyser/custom-content#json-mappings).
JSON mappings have to specify the `format_version` set to `1`, and list all custom waypoint styles under the
`waypoint_styles` key. This key holds an object in which keys are identifiers of waypoint styles, and each
value is the definition of that waypoint style.
+10 -3
View File
@@ -42,12 +42,11 @@ appears correctly on your Java client, then Rainbow is able to analyse it.
Generally, you use Rainbow as follows:
1. Set up a Java Edition 26.1 client, with Fabric installed, and ensure that Rainbow is present on your client.
1. Set up a Java Edition 26.2 client, with Fabric installed, and ensure that Rainbow is present on your client.
2. Join a world or server of choice and make sure all the necessary resource packs are loaded. Then, run `/rainbow create <pack name>`, with `<pack name>` replaced with the name of your resource pack on Bedrock Edition.
3. You can then start converting (or "mapping") custom content to be exported in your Bedrock resource pack. You can find a full list of ways to map custom content below.
4. Run `/rainbow finish` to finish your conversion. Rainbow will then output the generated resource pack and additional files to `.minecraft/rainbow/<pack name>`. You can click the `Wrote pack to disk` message in chat to open that folder.
5. In this folder, you'll find 5 important files/folders:
- `custom-skulls.yml`: put this in Geyser's config folder. These are the exported player skulls. The file may already exist in Geyser's config folder, be careful with overwriting it!
5. In this folder, you'll find 4 important files/folders:
- `custom_mappings`: you need to put the files in here in the `custom_mappings` folder in Geyser's config folder. These are the generated Geyser mappings.
- `pack.zip`: this is the generated resource pack for Bedrock Edition. You need to put this file in the `packs` folder in Geyser's config folder.
- `lang`: you need to put all files in this folder in the `locales/overrides` folder in Geyser's config folder.
@@ -122,6 +121,12 @@ Custom sounds may be mapped by using `/rainbow auto sounds`, which scans through
and maps all that are found. You may also use `/rainbow map sound <namespace>`, which maps all the custom sounds
of the given namespace. This can be useful when you only want to export custom sounds of a single resource pack.
### Mapping custom waypoint styles
Custom waypoint styles, also known as locator bar icons, may be mapped by using `/rainbow auto waypoints`, which scans
through all loaded resource packs for custom styles, and maps all that are found. You may also use
`/rainbow map waypoint <waypoint style>`, which maps a single waypoint style.
## Capabilities and limitations
Rainbow is currently capable of the following:
@@ -149,6 +154,8 @@ Rainbow is currently capable of the following:
- For the `display_context` property, the `gui` case is mapped, if present.
- Also includes detecting if an item should be displayed handheld by looking at the item's model.
- Also is able to detect and map items using the "legacy" `custom_model_data` range-dispatch style, and map them to Geyser's `legacy` item mappings.
- Generating Geyser skull mappings.
- Generating Geyser waypoint style mappings for custom waypoint styles (locator bar icons).
- Generating a simple Bedrock resource pack for blocks and simple 2D items, as well as:
- Simple custom armour items, by analysing an item's `minecraft:equippable` component and loaded equipment assets.
- Custom elytra items also work, but only visually, due to bedrock limitations.