repository·mc1.21.1/dev·Indexed 26 days ago
https://github.com/creators-of-create/createA Minecraft mod focused on aesthetic automation and physical contraptions using animated components. This documentation covers technical details including packet limits for contraptions (NBT and byte limits), Basin recipe lookup optimizations using sparse trie maps, client and server-side commands (/create, /angle, /camera), and contribution guidelines via Crowdin.
Create is a Minecraft mod that provides tools and blocks for building, decoration, and aesthetic automation. Unlike many tech mods that rely heavily on user interfaces (UIs), Create focuses on physical contraptions made of animated components that work together in various arrangements.
To learn how specific mechanics and gadgets work, use the in-game visual documentation system called Ponder.
To prevent clients from being 'chunkbanned' due to oversized contraptions, be aware of four distinct packet limits. Note that the NBT limit is measured in NBT size units, while the others are measured in bytes. Because of this, the NBT limit is typically the first threshold encountered.
Packet Limits:
2_097_152 (measured in NBT size units, enforced by FriendlyByteBuf.readNbt())1_048_576 bytes (applies to ClientboundCustomPayloadPacket)32767 bytes (applies to ServerboundCustomPayloadPacket)8_388_608 bytes (applies to all packets)Basin. Instead of checking every recipe against a Basin's contents, the system pre-constructs a trie map from sorted AbstractVariant IDs to a list of Recipe<?>s. This allows for efficient subset matching using a SuperBasin representation.1_048_576 bytes). While the NBT limit is technically relevant, client-side deserialization typically bypasses it. Syncing is generally less prone to hitting limits than Pickup because significant portions of data can be skipped during the sync process.When handling contraption pickup, the NBT limit is the most critical constraint and is usually the first to be hit. If other mods increase the NBT limit, the packet limit (8_388_608 bytes) may become the next relevant bottleneck.
Note: The custom payload limit is not relevant for item sync during pickup, as item sync utilizes the vanilla ClientboundContainerSetSlotPacket.
To perform an optimized recipe lookup, follow these steps:
Basin (a set of AbstractVariants) is converted into a SuperBasin (a set of AbstractIngredients). A SuperBasin contains all AbstractIngredients that can be satisfied by at least one AbstractVariant in the Basin. Caching this conversion can improve performance.SuperBasin to traverse the pre-constructed sparse trie map.AbstractRecipes whose ingredient sets are subsets of the SuperBasin.AbstractRecipes into concrete Recipe<?> objects.Localization for Create is managed through Crowdin. To contribute translations, create a Crowdin account and join the project using the official invite link. Avoid submitting translation changes via Pull Requests (PRs) or modified .json files directly to the repository; use the Crowdin platform instead.
https://translate.createmod.net/project/createmod/invite?h=64e492afe2ffbc180e3419654374135f1536385When managing contraption data, distinguish between NBT Size and Bytes:
NbtAccounter. It is not exactly bits, but it is a similar unit.writerIndex.The following terms define the data structures used in the recipe lookup optimization:
AbstractVariants (satisfied by any AbstractVariant it contains - OR semantics).AbstractIngredients, mapping one-to-many to Recipe<?> (satisfied by a set containing all its AbstractIngredients - AND semantics).AbstractVariants.AbstractIngredients constructed from a Basin by defining it as the set of all AbstractIngredients that can be satisfied by at least one AbstractVariant in the Basin.