Chest-UI

A Minecraft: Bedrock Script API pack that alters the Action Form UI to look & function like a chest does.

Benefits

• As fast as vanilla forms
• Java-style UIs
• Cursor-following hover text
• Easy to read
• Good for large numbers of buttons
• Supports enchanted items and isometric blocks
• Supports durability

For Pack's additional features/add-ons, visit the additional-features branch.

Note that the inventory section of the form is simply for display, and does not reflect the actual player's inventory. Hopefully coming soon!

Also note that custom UI retextures will not affect these UIs, as they are controlled by RP/textures/ui/generic_27.png & RP/textures/ui/generic_54.png.

Usage

Import into file- this example will work for any top-level file. Changes will be needed for nested files.

import { ChestFormData } from './extensions/forms.js';

Create a new chest form, like you would for any other form UI. The size can be left out, and will default to 'small'.

const form = new ChestFormData()

Add a name to the UI, to display at the top.

form.title('Form Title')

Add buttons!

form.button(0, 'Button Name', ['Button Lore'], 'minecraft:diamond', 10)
form.button(2, 'Button Name', ['Button Lore'], 'textures/items/my_custom_item', 6, 60)

The parameters for the button are as follows:

1. Location. The slot that the item will display in, starting from zero. Max of 26 for a small chest, or 53 for a large.
2. Name. The name of the button.
3. Lore. An array of strings which will display below the item's name.
4. Texture. Item/block type id or path to the texture. Can be used like minecraft:cake or minecraft:acacia_log (A namespace of minecraft: will be assumed if not specified). For custom textures, specify the path of the texture (Must include textures/ at the start of the path)
5. Stack size. This is an optional parameter, and will default to 1. Displays a small number in the lower right-hand corner- useful for shops selling multiple of an item at once!
6. Durability. This is an optional parameter, and will default to 0. Supports value between 0 and 99. Displays the durability that can set using the form interface- useful for tools and in general for looks.
7. Enchanted. This is an optional parameter, and will default to false. Displays the enchant glint effect on the item/block rendered if using the type id. This parameter will not work if using a custom textures path (textures/...)

Show it to the player & get a response

form.show(player).then(response)

Example usage: index.js.

Find all item/block type ids here.

All item images & semi-referenced ids can be found here

Want to add custom items / blocks to the form?

1. Download this_pack to see all item IDs and their icons, including custom ones.
2. Add the item typeId & ID to the typeIds.js file. Note that experimental items shift the vanilla IDs at 256- make sure to manually shift the IDs up, and remember the full typeId for your custom items!
3. You cannot use the constant number_of_1_16_100_items if you chose to add your custom items. Set it to zero!

Want Dynamic Sizing/Custom Number of Slots?

If you want custom chest slots sizes, you have to add controls to "chest_panel" in chest_server_form.json in the format like the ones that already exist. Then you have to edit forms.js, and add you condition and identifier to sizes map/array following the format using which how pre-defined sizes are added.

Want to edit the texture?

Open chest_server_form.jsson and search and change $background (ninesliced) variable.

Important!!!

If you are using behaviour packs with items of format 1.16.100 or higher, vanilla item IDs are changed! To remedy this, navigate to scripts/extensions/forms.js and change the constant number_of_1_16_100_items to whatever number of 1.16.100+ custom items your applied pack(s) have.

Future Ideas

• Functioning inventory section (it’s just for looks at the moment) (feels impossible to do)
• Dynamic sizing based on number of buttons, in rows of 9 at a time (complex and probably have to rewrite everything) Done.

Credits

Maintained by Herobrine64 & LeGend077.