Skip to content
AbstractMenus AbstractMenus

Online Players

The headline use case for GeneratedMenu: a paginated browser of online players. Each head is auto-generated from the PLAYERS catalog with health and world info in the lore. Left-click teleports admin to the player, shift-click kicks them. Restricted to admins via the rulesAdmin shared snippet.

What it teaches

Section titled “What it teaches”
  • Building a generated menu with a catalog + matrix + templates
  • Using catalog placeholders (%ctg_player_name%, %ctg_player_health%, %ctg_player_world%)
  • Click-type discrimination: click { left { ... } shift_left { ... } }
  • The command action with console: to run server commands as console
  • Built-in pagination via pageNext / pagePrev (shared ${buttonNext} and ${buttonPrev})
  • Pagination placeholders: %page%, %pages_count%, %pages_total%
  • Menu-level access restriction: top-level rules: ${rulesAdmin}
advanced
Features: GeneratedMenuPLAYERS-catalogmatrix-cellsmatrix-templatesctg-placeholdersclick-types-left-shiftcommand-actionpageNext-pagePrev
Open: /ame_online 
# Online Players - generated catalog menu of online players with admin actions
# Docs: https://abstractmenus.github.io/docs/en/examples/admin-tools/online-players
# Open: /ame_online
# Requires: -


include required(file("./plugins/AbstractMenus/menus/example/_shared/templates.conf"))


title: "&6Online Players (page %page% / %pages_count%)"
size: 6


# Restrict access - admins only.
rules: ${rulesAdmin}


activators {
  command: "ame_online"
}


# Pull online players as catalog entries. Each entry exposes %ctg_player_*% placeholders.
catalog {
  type: PLAYERS
}


# 7-wide grid of player heads with borders. 4 rows of 7 = 28 heads per page.
matrix {
  cells: [
    "_________"
    "_xxxxxxx_"
    "_xxxxxxx_"
    "_xxxxxxx_"
    "_xxxxxxx_"
    "_________"
  ]


  templates {
    "x" {
      material: PLAYER_HEAD
      skullOwner: "%ctg_player_name%"
      name: "&e%ctg_player_name%"
      lore: [
        "&7Health: &c%ctg_player_health%"
        "&7World: &b%ctg_player_world%"
        ""
        "&aLeft-click  - teleport to player"
        "&cShift-click - kick player"
      ]
      click {
        left {
          actions {
            command {
              console: "tp %player_name% %ctg_player_name%"
            }
            sound: ${clickSound}
            closeMenu: true
          }
        }
        shift_left {
          actions {
            command {
              console: "kick %ctg_player_name% &cKicked by an admin"
            }
            sound: ${successSound}
            refreshMenu: true
            message: "&aKicked &e%ctg_player_name%"
          }
        }
      }
    }
  }
}


items: [
  ${borderBlack} { slot: "0-8" }
  ${borderBlack} { slot: "45-53" }


  # Pagination buttons - shown only when there are multiple pages.
  ${buttonPrev} { slot: 48 }
  ${buttonNext} { slot: 50 }


  # Page counter (info-only)
  {
    slot: 49
    material: PAPER
    name: "&ePage %page% / %pages_count%"
    lore: ["&7Total online: &e%pages_total%"]
  }


  ${buttonClose} { slot: 53 }
]
↓ menu.conf

Bundle includes _shared/templates.conf and INSTALL.txt.

How GeneratedMenu pieces fit together

Section titled “How GeneratedMenu pieces fit together”

Three blocks make a generated menu:

catalog { type: PLAYERS }                  # the source of dynamic content


matrix {                                   # how to lay it out
  cells: [ "_________", "_xxxxxxx_", ... ]
  templates {
    "x" { ... item template ... }
  }
}


items: [                                   # static items (borders, buttons, page counter)
  ...
]

The catalog produces a stream of objects. The matrix decides where each catalog entry goes (x cells consume catalog entries one by one). Static items in items: render on every page in the same positions.

Catalog placeholders

Section titled “Catalog placeholders”

Inside matrix templates, the current catalog object is exposed via %ctg_<key>%. For the PLAYERS catalog, the player object has name, health, food_level, world, gamemode, and a few others. Different catalog types expose different keys - see the Generation docs for a full table.

Click types

Section titled “Click types”

The click block can specify per-button-type handlers:

  • left { ... } - left-click only
  • right { ... } - right-click only
  • shift_left { ... } - shift + left-click
  • shift_right { ... } - shift + right-click
  • drop { ... } - drop key (Q)

If only one click variant is defined, other clicks are no-ops. This menu uses left for teleport and shift_left for kick - so a regular shift-left click won’t accidentally teleport.

Pagination

Section titled “Pagination”

Generated menus paginate automatically when the catalog has more entries than fit. The pageNext and pagePrev actions move between pages. The shared ${buttonNext} and ${buttonPrev} templates wire those actions to ARROW items.

If the menu fits on one page (catalog has fewer entries than matrix slots), the next/prev buttons still render but their actions are no-ops.

The %page%, %pages_count%, and %pages_total% placeholders show pagination state - useful for “Page 2 / 5” titles or footer counters.

Customizing

Section titled “Customizing”

To restrict to a subset of players, add filters to the catalog:

catalog {
  type: PLAYERS
  filters {
    permission: "myserver.online_visible"
    notWorld: ["staff_world"]
  }
}

To add more admin actions, extend the click block with right, shift_right, etc. - each pointing to its own command via the command action.

To swap the catalog entirely (browse worlds, regions, online BungeeCord servers), change catalog { type: ... } to WORLDS, BUNGEE_SERVERS, or any other registered catalog type.

Try it

Section titled “Try it”

After installing the example pack:

  1. Drop the bundle into plugins/AbstractMenus/menus/example/.
  2. /am reload.
  3. Make sure your account has the abstractmenus.admin permission.
  4. Type /ame_online in-game.
  5. Left-click a player head to teleport. Shift-left to kick.