README.md

Cmarkup stands for Container Markup

Minecraft server plugin to markup containers with ease.

Theory

Container markup holds container metadata and slot keys.

Container metadata is used for in-game inventory creation.

Slot keys is a map of strings and slot index sets.

Each slot in container may have one or many keys.

Practice

Container-based menus

Suppose the development of 9 slots paged menu where the last slot is the load next button, the pre-last slot is the reset to the first page button, and the other first slots are page items.

The JSON representation of this container menu:

{
  "title": "Paged Menu",
  "titleColor": "#ffffff",
  "size": 9,
  "type": null,
  "slots": {
    "page_item": [0, 1, 2, 3, 4, 5, 6],
    "page_reset": [7],
    "page_next": [8]
  }
}

Here is first 7 slots are marked with page_item key, pre-last with page_reset, and last with page_next.

In code, to handle user interactions with slots, these slot keys could be referenced to implement specific behaviour:

// Load a markup using loader instance
val markup: ContainerMarkup = loader.loadMarkup("paged_menu")

// Open an inventory for a player using container markup
player.openInventory(MarkupBaseInventory(markup).inventory)

// Handle inventory click event

// Check if player clicked slot with key `page_next`
if (markup.slots["page_next"].contains(event.slot)) {
    setNextPage()
}

// Check if player clicked slot with key `page_reset`
if (markup.slots["page_reset"].contains(event.slot)) {
    setInitialPage()    
}

// Set items of a page
markup.slots["page_item"].foreach {
    event.clickedInventory.setItem(it, nextPageItem())
}

Usage

Plugin

The plugin provides commands to manipulate markups in-game, so the slot keys and container could be setted up rapidly.

The markup files are stored in markups folder of the plugin directory: plugins/Cmarkup/markups/*.json.

Library

ContainerMarkup is a data class that is serializable, so the markups can be loaded and saved in any format.

MarkupBaseInventory is an inheritable class that constructs inventory using ContainerMarkup.