Add support for custom blocks and skulls #3505

Kas-tle · 2023-01-16T06:58:40Z

Major thanks to Amberichu for all her help with this! 🎉

This PR builds off of her initial skull and custom block registry system. It adds support for registration of custom blocks via both extensions and mappings. Via mappings, the user can override either specific blockstates, or all blockstates for a given block. A blocks section may be simply added to existing files in custom_mappings. The structure of the mappings is described in the preview documentation.
Preview documentation: https://pages.kastle.dev/geyser/custom-blocks/

In addition, there is support for registering specific skulls via a config file. These skulls are incorporated into a resource pack generated by Geyser on startup.
Preview documentation: https://pages.kastle.dev/geyser/custom-skulls/

I know we'll probably have a long road to getting this merged, but I'm ready to get started with whatever changes need to be made. Just let me know. Also feel free to commit to my branch directly if you so choose.

Accompanying PR has been made on the wiki for documentation of these new features. See GeyserMC/GeyserWiki#115

@Camotoy (to figure out the branch stuff)

Major Caveats

~~Break speeds will be completely broken for vanilla tools. This cannot be fixed at this time. We can likely fix for custom tools once Added tool break speeds & more #3381 is merged.~~ Thanks to a suggestion from Camotoy, we can calculate the break time server side and simply break the block for the client when needed. See 29835a1
Hit boxes cannot extend outside 1x1x1 block. This means blocks like walls and fences can effectively be jumped over by bedrock players. We could perhaps work around this by adding either solid entities or invisible blocks above blocks with a collision box that extend outside this size. I implemented the proposed workaround; see 7f85e90 and 5f5159d (primarily). The only minor inconvenience here is an unknown geometry warning will be displayed without a slight change to GeyserOptionalPack, but there is not other change in function beyond the content log error. Note that we still have the issue of being limited to cuboid shaped collision boxes, but for now this is a Mojang limitation we cannot control.
Blocks with native GUIs will not work.
Blocks are not overridden in the creative inventory. To accomplish this, we would need a way to programmatically map the blocks in each creative category. This would probably require futzing around with pmmp/bds-mod-mapping. This can now be done as long as the creative category and group is specified in the mappings.
Block geometries are limited to 1.875x1.875x1.875. This limitation is expressly imposed by Mojang and is unlikely to change. See https://bugs.mojang.com/browse/MCPE-152191. Note that currently this can technically be worked around since as of 1.20.12 the transformation component seems to bypass size limits, but note that 1. a content log warning is displayed and 2. there is an open bug regarding this with an ADO (see https://bugs.mojang.com/browse/MCPE-173799) implying that this will likely be patched in the future.

Given the above, I see this as primarily a cosmetic feature. We can do our best to make the components work, but it would be ill advised for anyone to rely on them working.

…kulls Clean up skull block translation a bit

Change `davchoo` to `geyser` in geometry

21 block states vs 48 block states

Custom skulls can now be added by username, uuid, and textures Move skull nbt stuff from requestTexturesFromUsername to SkullBlockEntityTranslator Add requestTexturesFromUUID

# Conflicts: # core/src/main/java/org/geysermc/geyser/registry/BlockRegistries.java # core/src/main/java/org/geysermc/geyser/translator/protocol/bedrock/BedrockInventoryTransactionTranslator.java

Fix incorrect collision names used in CustomBlockComponentsBuilder

# Conflicts: # core/src/main/java/org/geysermc/geyser/GeyserImpl.java # core/src/main/java/org/geysermc/geyser/registry/provider/GeyserBuilderProvider.java

Convert CustomBlockPermutation into a record Change materialInstances in CustomBlockComponents Builder to materialInstance Reuse box components in CustomSkull

Should be easier to modify in needed in the future.

Should reduce memory & storage usage for Bedrock clients

This reverts commit 15fd535.

Add defaultBlockState to CustomBlockData

Remove defaultBlockState CustomBlockState field from GeyserCustomBlockData since it creates a circular reference

Fix missing providers when used in GeyserDefineCustomBlocksEvent

Signed-off-by: Joshua Castle <[email protected]>

polargh · 2023-08-05T02:38:08Z

LGTM! 😀 👍

Tydium · 2023-08-05T07:19:52Z

👀

...va/org/geysermc/geyser/translator/protocol/java/level/JavaLevelChunkWithLightTranslator.java

Signed-off-by: Joshua Castle <[email protected]>

api/src/main/java/org/geysermc/geyser/api/block/custom/NonVanillaCustomBlockData.java

core/src/main/java/org/geysermc/geyser/registry/BlockRegistries.java

core/src/main/java/org/geysermc/geyser/registry/populator/CustomBlockRegistryPopulator.java

core/src/main/java/org/geysermc/geyser/registry/populator/BlockRegistryPopulator.java

Signed-off-by: Joshua Castle <[email protected]>

core/src/main/java/org/geysermc/geyser/pack/SkullResourcePackManager.java

core/src/main/java/org/geysermc/geyser/registry/loader/ResourcePackLoader.java

core/src/main/java/org/geysermc/geyser/registry/mappings/versions/MappingsReader_v1.java

core/src/main/java/org/geysermc/geyser/registry/populator/CustomBlockRegistryPopulator.java

core/src/main/java/org/geysermc/geyser/registry/populator/CustomItemRegistryPopulator.java

Signed-off-by: Joshua Castle <[email protected]>

core/src/main/java/org/geysermc/geyser/registry/loader/ResourcePackLoader.java

Resolved

Signed-off-by: Joshua Castle <[email protected]>

polargh · 2023-08-21T22:55:28Z

LGTM!

polargh · 2023-08-21T22:55:45Z

👍

davchoo and others added 30 commits July 5, 2022 03:41

Super cursed custom skulls custom block

0eb7218

Rename some stuff

c2a6e8c

Attempt to clean up some code

f553dee

Remove skull translation events and define custom blocks for custom s…

49f7f6d

…kulls Clean up skull block translation a bit

Auto generate skull resource pack

9e0af6e

Change `davchoo` to `geyser` in geometry

Add config options for custom blocks and custom skull blocks

774b300

Fix formatting and names for player skulls

d07a06c

Use block states more efficiently for custom skulls

08c24cb

21 block states vs 48 block states

Clean up custom block api a bit

86c8226

Apply some suggestions from Camotoy

a577512

Move custom skull config stuff to its own file

49550a5

Custom skulls can now be added by username, uuid, and textures Move skull nbt stuff from requestTexturesFromUsername to SkullBlockEntityTranslator Add requestTexturesFromUUID

Merge branch 'feature/extensions' into feature/blockstuff-updated

8247e73

# Conflicts: # core/src/main/java/org/geysermc/geyser/registry/BlockRegistries.java # core/src/main/java/org/geysermc/geyser/translator/protocol/bedrock/BedrockInventoryTransactionTranslator.java

Update custom block nbt for v534

e9e89b4

Disable collision box & selection box when box is empty

cb0b52b

Fix incorrect collision names used in CustomBlockComponentsBuilder

Merge branch 'feature/extensions' into feature/blockstuff-updated

88725f8

# Conflicts: # core/src/main/java/org/geysermc/geyser/GeyserImpl.java # core/src/main/java/org/geysermc/geyser/registry/provider/GeyserBuilderProvider.java

Add custom block stuff to provider registry loader

f5d23a6

More API changes

5676870

Convert CustomBlockPermutation into a record Change materialInstances in CustomBlockComponents Builder to materialInstance Reuse box components in CustomSkull

Convert skull floor geometries into a template

8244afa

Should be easier to modify in needed in the future.

Crop and reorder skull textures to eliminate unused space

15fd535

Should reduce memory & storage usage for Bedrock clients

Revert "Crop and reorder skull textures to eliminate unused space"

9f4f2ac

This reverts commit 15fd535.

Use identifier from CustomBlockData in SkullResourcePackManager

2ca3680

Fix isIncorrectHeldItem check for custom skull blocks

36f540f

Add defaultBlockState to CustomBlockData

Fix adding duplicate block states for custom blocks with 0 properties

d00886e

Remove defaultBlockState CustomBlockState field from GeyserCustomBlockData since it creates a circular reference

Add basis for overriding Bedrock block states

42fdbeb

Fix missing providers when used in GeyserDefineCustomBlocksEvent

Merge remote-tracking branch 'upstream/master' into feature/blocky

f2d4176

Fix custom blocks in 1.19.50

3257f3c

Merge remote-tracking branch 'upstream/master' into feature/blocky

b5eeaff

Merge remote-tracking branch 'upstream/master' into feature/blocky

a176fdf

Decouple mappings from items

928b252

Decouple mappings from items

e3dcb6d

Kas-tle added 4 commits August 4, 2023 17:16

Add material instance to provider registry

5db3101

Signed-off-by: Joshua Castle <[email protected]>

oops

265a657

Signed-off-by: Joshua Castle <[email protected]>

Fix case of correctBedrockIdentifier not found

e40cab2

Signed-off-by: Joshua Castle <[email protected]>

Fix docs

5d530ab

Signed-off-by: Joshua Castle <[email protected]>

Redned235 approved these changes Aug 5, 2023

View reviewed changes

Camotoy reviewed Aug 8, 2023

View reviewed changes

...va/org/geysermc/geyser/translator/protocol/java/level/JavaLevelChunkWithLightTranslator.java Outdated Show resolved Hide resolved

Kas-tle added 2 commits August 8, 2023 19:31

Merge remote-tracking branch 'upstream/master' into feature/blocky

0362d27

Signed-off-by: Joshua Castle <[email protected]>

Address @Camotoy's review

ac249b0

Signed-off-by: Joshua Castle <[email protected]>

davchoo previously requested changes Aug 9, 2023

View reviewed changes

Kas-tle added 2 commits August 9, 2023 17:15

Address review from @davchoo

ba7708f

Signed-off-by: Joshua Castle <[email protected]>

Set namespace of custom blocks vs ident direct

7051977

Signed-off-by: Joshua Castle <[email protected]>

Kas-tle requested a review from davchoo August 12, 2023 14:49

rtm516 requested changes Aug 14, 2023

View reviewed changes

Kas-tle added 2 commits August 14, 2023 20:24

Address review from @rtm516

aca66be

Signed-off-by: Joshua Castle <[email protected]>

One more

bd74e36

Signed-off-by: Joshua Castle <[email protected]>

Kas-tle requested a review from rtm516 August 15, 2023 03:37

rtm516 requested changes Aug 19, 2023

View reviewed changes

core/src/main/java/org/geysermc/geyser/registry/loader/ResourcePackLoader.java Outdated Show resolved Hide resolved

Remove rogue space

7dd77d2

rtm516 approved these changes Aug 19, 2023

View reviewed changes

Merge remote-tracking branch 'upstream/master' into feature/blocky

6488fef

davchoo removed their request for review August 20, 2023 14:07

Kas-tle added 3 commits August 20, 2023 15:08

Geo component as builder

0c90a82

Signed-off-by: Joshua Castle <[email protected]>

use super name

ea42fdc

Signed-off-by: Joshua Castle <[email protected]>

Bump version

1be0be7

Signed-off-by: Joshua Castle <[email protected]>

Kas-tle merged commit 9ddfdf9 into GeyserMC:master Aug 21, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for custom blocks and skulls #3505

Add support for custom blocks and skulls #3505

Kas-tle commented Jan 16, 2023 •

edited

Loading

polargh commented Aug 5, 2023

Tydium commented Aug 5, 2023

polargh commented Aug 21, 2023

polargh commented Aug 21, 2023

Add support for custom blocks and skulls #3505

Add support for custom blocks and skulls #3505

Conversation

Kas-tle commented Jan 16, 2023 • edited Loading

Major thanks to Amberichu for all her help with this! 🎉

Major Caveats

polargh commented Aug 5, 2023

Tydium commented Aug 5, 2023

polargh commented Aug 21, 2023

polargh commented Aug 21, 2023

Kas-tle commented Jan 16, 2023 •

edited

Loading