Skip to main content

Admin GUI

The Admin GUI is the in-game control room for Structory Premium.

It is made for owners and trusted staff members who need to inspect structures, recipes, instances and configuration without guessing every internal key by hand.

info

The Admin GUI is a Premium administration tool. It is not meant for normal players.

Opening the editor

The fastest command is:

/structory editor

You can also open the same dashboard through the admin branch:

/structory admin editor

Both commands use:

structory.cmd.admin.editor

Main admin commands

CommandPermissionDescription
/structory editorstructory.cmd.admin.editorOpens the main editor dashboard directly.
/structory admin editorstructory.cmd.admin.editorOpens the same editor dashboard from the admin branch.
/structory admin itemstructory.cmd.admin.itemGives/marks the admin inspection item.
/structory admin instancesstructory.cmd.admin.instancesOpens the placed structure instance list.
/structory admin instance <uuid>structory.cmd.admin.instancesOpens one specific structure instance.
/structory admin recipesstructory.cmd.admin.recipesOpens the loaded recipe list.
/structory admin recipe <name>structory.cmd.admin.recipesOpens one specific recipe.
/structory admin structuresstructory.cmd.admin.structuresOpens the loaded structure template list.
/structory admin structure <name>structory.cmd.admin.structuresOpens one specific structure template.
/structory admin guisstructory.cmd.admin.guisOpens GUI definition tools.
/structory admin guistructory.cmd.admin.guisAlias for the GUI definition tools.
/structory admin validatestructory.cmd.admin.validateRuns the health/validation report.
/structory admin healthstructory.cmd.admin.validateAlias for the health/validation report.

Recommended wildcard permissions:

PermissionDescription
structory.cmd.admin.*Access to all Admin GUI pages.
structory.cmd.*Access to all Structory command groups declared by the plugin.
structory.*Full Structory access. Give only to trusted administrators.
caution

The Admin GUI can expose internal keys, saved item names, recipe names, structure locations, UUIDs and configuration data. Do not give these permissions to normal players.

Editor dashboard

The editor dashboard is the recommended starting point.

It links the main areas:

  • structures;
  • placed instances;
  • recipes;
  • config files;
  • messages;
  • GUI definitions;
  • loaded options;
  • loaded addons;
  • validation/health checks.

Use this page when you are not sure where the problem is. It is meant to help you jump to the closest editor instead of digging through files blindly.

Structures

The structure pages show the templates loaded from the structures/ folder.

Use them to inspect:

  • structure key;
  • display name;
  • check block;
  • layout data;
  • configured options;
  • structure-side option values;
  • particle/decorations when the structure has the particle option.

If a structure does not have the particle option, the editor should not open the particle/decoration editor. It should ask you to add the particle option first.

This is intentional: reusable particles, sounds and decorations belong to options.particle.

Instances

The instance pages show structures that already exist in the world.

An instance is created when a player builds a valid multiblock structure and activates it.

Use instance pages to inspect:

  • structure key;
  • instance UUID;
  • world;
  • position;
  • owner or privacy data, when available;
  • instance-specific option values;
  • debugging values that are useful in commands.

Instance values are separate from structure template values. Some options are configured globally on the structure, while others store data per placed instance.

Recipes

The recipe pages show recipes loaded from the recipes/ folder.

Use them to inspect or edit:

  • recipe key;
  • recipe display item;
  • discover key;
  • ingredients;
  • results;
  • listeners;
  • animation and consume strategy data.

The editor tries to use the recipe's configured item-display as the icon.

Example:

item-display:
material: NETHER_STAR
name: "<aqua>Nether Star Recipe"

If no valid display item is configured, Structory may use a fallback item.

Option editors

Premium options can describe how their own values should be edited.

When an option provides editor metadata, the Admin GUI uses that metadata to build a better editor. This is used for options such as:

  • crafting;
  • crate;
  • privacy;
  • command;
  • valid worlds;
  • particle/decorations.

Generic value-map editing is still available as a fallback for simpler or advanced values.

Config file editing

The editor can open important YAML files such as:

  • config.yml;
  • messages.yml;
  • gui.yml;
  • structure files;
  • recipe files.

When saving sensitive files, Structory creates backups where possible.

Even with the GUI, YAML still matters. After large changes, restart the server and check the console.

Health and validation

Use:

/structory admin validate

or:

/structory admin health

The health report is useful when:

  • a material is invalid;
  • a custom plugin key is used in a Bukkit material field;
  • a structure has missing or broken options;
  • a recipe references missing data;
  • a config file cannot be parsed.

Troubleshooting

I cannot open the editor

Check:

  1. You are using Structory Premium.
  2. You are a player, not console.
  3. You have structory.cmd.admin.editor.
  4. The plugin loaded without startup errors.

I do not see a recipe or structure

Check:

  1. The YAML file exists in the correct folder.
  2. The file has no indentation errors.
  3. The plugin was restarted or reloaded after the change.
  4. The console does not show parser warnings.

The particle editor is blocked

Add the particle option to the structure first.

Example:

options:
particle: {}

Then define decorations such as consume, result, insert, place or take.