resourcepack.ai
DOCS

Building

GUIs

A GUI asset gives one of Minecraft's screens a new look: a chest window turned into a shop menu, a furnace, an anvil, the player's own inventory, the Escape menu. You can have the AI design the whole screen, lay it out yourself with buttons, text and icons, or paint over the vanilla art by hand.

Two GUIs made in Studio: a painted market menu and a blocky shop menu

A GUI changes the look, not the layout

A resource pack can't move a slot, add one, resize the window or change what a click does. That's server code. Design around the slots the screen already has: the buttons you draw are pictures over slots, and a server plugin decides what clicking each slot does.

Two other kinds of screen have their own pages or sections:

  • Menus with real buttons and text fields (a welcome screen, a settings menu) are Dialogs.
  • Screens you write in HTML and CSS, with a mouse pointer and any layout you like, are Custom GUIs, shown by the MC GUI plugin.

Which screens you can change#

KindScreensWho sees it
OverlayChests (1 to 6 rows), Shulker Box, Dispenser / Dropper, Hopper, Crafting Table, Furnace, Blast Furnace, Smoker, Smithing Table, Stonecutter, Grindstone, Loom, Cartography Table, Enchanting Table, Anvil, Brewing StandOnly screens a plugin opens with this GUI's title. Ordinary chests stay ordinary
Player InventoryThe E screenEvery player with the pack, always
Escape MenuThe pause screen's buttons and backgroundEvery player with the pack, always

An overlay is the usual choice for a server menu. Your art is drawn on top of the screen whenever a plugin opens it with the GUI's special title, which Studio gives you. Because your art can be bigger than the window, you can draw outside it: a banner, a frame, hanging chains. The dashed rectangle in the editor is where vanilla's window sits. (The beacon isn't offered: it has no title to draw on.)

The Player Inventory replaces vanilla's inventory picture, so a pack holds one, and anything outside the 176×166 window isn't drawn.

The Escape Menu themes the shared button face (with its hover and disabled states), the background, and each button's label, generated from one description of the material. A pack holds one. Because the button face is shared, the title screen, options screens and world list get the same look. Each button's art replaces its words, and the pause screen's buttons no longer light up under the cursor. It opens in the pixel editor, with a guide box round each sprite.

Making one#

Open a pack, press Add asset and pick GUI, with GUI chosen at the top (the other choice, Custom GUI, is below).

Generate takes a description and a Layout:

  • Planned for you: describe the whole screen, "an underwater pirate shop", and the AI picks the size, title, sections, buttons and layout. Your words decide the look. Name no style and it keeps Minecraft's own grey window. Name a theme or colours ("a witch shop", "dark blue and silver", "clean modern") and it repaints the whole screen to match. Ask for drawn art ("painted", "made of wood", "illustrated cards") and it draws pictures and item sprites too. Everything lands as separate layers you can keep editing.
  • Design it yourself: pick the Screen to reskin and place the buttons and drawings yourself.

For the Player Inventory you choose whether to draw the slot cells and colour them from your panel; vanilla owns the rest of the layout.

Blank starts from the real vanilla art for the screen, centred on the sheet. Upload takes a 256×256 sheet.

On a chest GUI's page, Edit with AI rebuilds the screen with one change made ("make the frame gold", "add a sell button"). It costs about the same as generating one, and a failed edit leaves the screen as it was.

The editor#

The GUI editor shows the vanilla window frame and a guide box on every slot (and on the player's inventory and hotbar below most screens), so you can line a panel up with the grid.

Add pieces from its add menu: Blank, Button, Text, Formatted text, Icon, QR code, Scroll bar, Tabs, Upload image, AI image, Title plate, AI title plate, Background and Player head. A player head shows the viewer's own face and needs RP Engine on the server. Everything is a layer you can move and edit.

Ctrl+C copies the selected piece and Ctrl+V pastes it, into this GUI or another one in any tab. Pasting pixels copied from a texture, or an image copied outside Studio, adds it as an image.

Your own fonts#

Words can be set in a font of your own. Under Font in a piece's panel (a text, title plate, button, tab or formatted text), choose Upload a font (.ttf). The font is kept with the pack, so every GUI, HUD, dialog and rank tag in it can use it. A Game style button can use one too, in place of Minecraft's letters.

The Text tool has the same choice: the editor's own fonts, the pack's, an upload and a size. So does the Text tool in the HUD editor.

The words are drawn into the screen as pixels, so nothing extra ships and no player needs the font. Fonts work the same way as in dialogs: see Your own fonts for sizes, file types and other alphabets. In short:

  • A font with no English letters (Thai, say) uploads and draws, with any missing English letters and digits taken from Minecraft's font. The panel lists which characters came from Minecraft's font.
  • Words in another alphabet (Thai, Chinese, Japanese, Russian) are set in the first font of the pack that has their letters, even if you haven't picked it for that piece.
  • The editor's own fonts (Classic, Small Caps, Tiny) have English letters only. An accented letter is drawn without its accent, and a symbol they lack is drawn as Minecraft draws it.
  • Right-to-left and joined scripts (Arabic, Hindi) don't draw correctly.

Seeing it in game#

An overlay needs something to open it. With RP Engine, our free server plugin, the GUI's page has an Open in-game button, and the command it runs:

/rp screen studio:<id> @p

It needs the rpengine.screen permission (op by default); the button works without it. The screen is real, so you see your art against real slots and items. First Sync the pack, which sends it to you in game.

The Player Inventory and Escape Menu need no command: Sync the pack and press E or Esc.

Opening it from your own plugin#

Without RP Engine, your plugin opens the inventory with the GUI's title, shown on its page, in white. The title looks blank but holds the characters that draw your art:

// Copy the title from the GUI's page in Studio.
Inventory inv = Bukkit.createInventory(null, 54,
    Component.text("").color(NamedTextColor.WHITE));
player.openInventory(inv);

The picture is drawn in the title's colour, so a coloured title tints the whole screen.

Moving a GUI to another pack changes its title

The title's characters are given out per pack, so a GUI copied into another pack gets new ones. Copy the title from its page again. A Player Inventory or Escape Menu won't copy into a pack that already has one.

Custom GUIs#

A Custom GUI is a set of web pages, written in HTML and CSS, that the MC GUI server plugin shows in game: full screen with a mouse pointer, or on a wall of maps players walk up to and click. It isn't tied to a vanilla screen, so the layout is yours: a server menu, a shop with tabs, a leaderboard, a rules board. It's the same editor as mcgui.dev, kept in your pack.

Chest GUICustom GUI
LayoutVanilla's window and slotsAnything HTML and CSS can lay out
Holds real itemsYesNo
NeedsYour pack, plus a plugin to open itThe MC GUI plugin (it makes its own resource pack)
Gets to the serverSync or exportSend to server, then /mcgui import

Making one#

  1. 1

    Add it

    Press Add asset, pick GUI, and choose Custom GUI at the top. Generate asks you to describe it ("a server menu with my level, who's online and buttons for Kits, Rewards and Warps"); the editor opens and writes the first page as you watch. Blank starts from an empty page or a template (Server menu, Shop, Server selector, Leaderboard, Rules or Style guide).

  2. 2

    Change it

    The editor shows the page as a player will see it, and you can click through it like the game. Type a change into the AI bar under the preview ("add a Back button", "make it a dark theme"), or switch views along the top: Map shows every page and how buttons link them, Page lets you click any part of a page to make it a link, and Code is the HTML and CSS itself. Changes save as you go.

  3. 3

    Send it to your server

    Press Send to server. You get a command like /mcgui import abcd1234. Run it in game or in the server console on a server with MC GUI installed, then /mcgui open <page> shows it. Sending the same Custom GUI again replaces what the last import put there.

Each AI request (a new page or a change) costs 10 AI Credits. Editing by hand is free.

Custom GUIs are listed on the pack's GUIs tab beside your other screens. They aren't part of an exported resource pack or a Sync: MC GUI builds the pack its pages need on the server. To put the files on a server by hand, Export downloads them as a .zip for plugins/MCGUI/pages/. See MC GUI for installing the plugin, what a page can use, and its commands.

What's in the exported pack#

An overlay is a PNG under assets/minecraft/textures/font/ plus an entry in the pack's font file. Nothing under textures/gui/ changes, which is why ordinary screens stay ordinary.

The Player Inventory is assets/minecraft/textures/gui/container/inventory.png, and the Escape Menu is vanilla's button sprites plus label overrides. Both work as soon as the pack is applied.

On Bedrock#

GUIs are Java-only. Bedrock draws its screens differently. The rest of your pack converts as normal.