This is a snippet for how to use Jetbrains Compose Multiplatform to show Minecraft Display Entities.
The following is a preview of the ComposeTestMod.
Compose displays must be bound to an entity, and must explicitly add players to watch the displays.
val entity: Entity = ...
val player: ServerPlayerEntity = ...
val holder = entity.openDisplayGui {
// Place Compose code here
}
holder.startWatching(player)Note: There are a few caveats to using the example snippet in ComposeTestMod noted near the bottom of the file. Keep these in mind when adding the code to your project.
While this project aims to serve as just a proof-of-concept, if there are components or improvements you want to add which you think would be beneficial to others, feel free to open a PR.
Unless it requires significant changes the example code, I am unlikely to merge pull requests for version updates, as this is only a proof-of-concept.
This project is licensed under the BSD-3-Clause-NON-AI license. The TL;DR:
- You are free to copy-paste this code in your own project, as long as you properly disclose it includes this code. This includes adding the LICENSE file to any releases made using this code.
- You may under no circumstances use the code in this repository to train AI.
This project would not have been possible without:
- The FabricMC community, for helping with a bunch of issues I ran into.
- ComposePPT for giving a small example of the bare minimum to create a Compose backend.
- Mosaic for giving a more practical example of Compose backends.