AbstractMenus Docs

The original version of AbstractMenus you can buy here or here

Getting Started

• How to create menu
• HOCON format
• FAQ
• Tips

General Features

• Menu structure
• Item format
• Activators
• Actions
• Rules
• Variables
• Text formatting
• Placeholders
• Examples

Advanced Features

• Logical structures
• User input
• Templates
• Animations
• Menu generator
• Drag and drop

For Developers

• Plugin API
• Types deserializing
• Create own types
• Data Handlers
• Variables API
• Utils

General

Abstract Menus - it’s a Spigot plugin, with the one you can create simple or complex interactive menus. The main difference between this plugin and other similar ones in large opportunities for customization and menu optimization and a large number of tools for creating complex GUI. This plugin can easily replace most plugins for GUI creation, as well as some other simple plugins with GUI only.

Basic concepts

Menu file:

A file inside menus folder in AbstractMenus plugin folder. In menu file you could describe single or several menus.

Data type:

One of the ways to describe some data via HOCON syntax.

Activator:

An event that caused menu opening.

Rule:

A condition. For example, whether a player has permission, money, etc.

Action:

An action that can be executed. For example, action givePermission gives some permission to the player.

Item:

An inventory item with some properties. This may be menu button, or object for some checks.

Placeholder:

The part of the text enclosed between %, which is replaced to some data, for example, to the player nickname.

Bindings:

Special item property that allows to bind some other properties to rules. If player complies with rules, propertu will be applied to item.

Variable:

Any text or numeric value, saved in plugin’s database with the opportunity to change or use it via placeholders.

Template:

Any block or parameter in a file that can be inserted anywhere in the menu file. Templates exist primarily to exclude the copying of entire blocks, such as items, and for convenient menu editing in the future.

Animation frame:

Animation unit, that contains frame-specified items and other useful parameters.

Catalog:

Dynamic collection of some objects which used to generate menu.

Value Extractor:

Value provider that accepts context object placeholder and returns some value of this object. Using usually by activators and catalogs.

Context placeholder:

Special placeholders that uses one of the Value Extractors to provide some properties of context objects through placeholders. For example, Activator placeholders (%activator_<extractor_placeholder>%).

Commands

/am open <menu_name>

Open menu without activators.

/am open <menu_name> <player>

Open menu for some player without activators.

/am reload

Reload every menu from menus folder. For full plugin reloading we advice you reload server.

/am serve

Listen for files updates and reload menu automatically. Use it only while you developing menus.

/var get <name>

Display value of global variable.

/var set <name> <value>

Create or change global variable.

/var set <name> <value> <true/false replace protection>

Create or change global variable with change protection.

/var set <name> <value> <time>

Create or change temporary global variable.

/var set <name> <value> <time> <true/false replace protection>

Create or change temporary global variable with change protection.

/var rem <name>

Remove global variable.

/var inc <name> <number>

Increment numeric global variable.

/var dec <name> <number>

Decrement numeric global variable.

/var mul <name> <number>

Multiply numeric global variable.

/var div <name> <number>

Divide numeric global variable.

/varp get <player> <name>

Display value of personal variable.

/varp set <player> <name> <value>

Create or change personal variable.

/varp set <player> <name> <value> <true/false replace protection>

Create or change personal variable with change protection.

/varp set <player> <name> <value> <time>

Create or change temporary personal variable.

/varp set <player> <name> <value> <time> <true/false replace protection>

Create or change temporary personal variable with change protection.

/varp rem <player> <name>

Remove personal variable.

/varp inc <player> <name> <number>

Increment numeric personal variable.

/varp dec <player> <name> <number>

Decrement numeric personal variable.

/varp mul <player> <name> <number>

Multiply numeric personal variable.

/varp div <player> <name> <number>

Divide numeric personal variable.

Permissions

am.admin - Allow use all commands, described above.

External plugins support

• Vault - Support of any Economy plugin on server. Required for actions and rules to manipulate with player’s balance.

• PlaceholderAPI - Many placeholders instead of defaults.

• LuckPerms - For all actions and rules, which use permissions and groups.

• WorldGuard - Required for activators, which use WG regions.

• Citizens - Required for correct NPC activators working.

• HeadDatabase - Allows you to get any custom head from large database as an item.

• MMOItems - You can get any item from this plugin.

• SkinsRestorer - For actions to change/reset a player’s skin.

• ItemsAdder - Takes a custom item stack, defined in plugin’s registry by their namespaced id

• Oraxen - Takes a custom item stack, defined by Oraxen plugin