Documentation Index
Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt
Use this file to discover all available pages before exploring further.
BTCMobs includes a powerful menu system for in-game administration and browsing of mobs, items, and spawners.
Menus can be opened with the /btc menu command:
/btc menu # Opens the main menu
/btc menu open <name> # Opens a specific menu
| Menu | Description |
|---|
main | Main navigation hub with access to all sub-menus |
mob-browser | Paginated list of all registered mobs |
item-browser | Paginated list of all registered items |
spawner-browser | Paginated list of all spawners |
mob-editor | Edit mob properties (view, spawn, kill) |
item-editor | Edit item properties (get, give) |
spawner-editor | Edit spawner settings |
config | Plugin configuration options |
color-picker | Color selection utility for customization |
Dynamic Content
Browser menus automatically populate with real data from the plugin:
- Mob Browser: Shows all registered mobs with active instance counts
- Item Browser: Displays all custom items with their actual icons
- Spawner Browser: Lists all spawners with their current status
Large lists are automatically paginated. Use the Previous Page and Next Page buttons to navigate.
Quick Actions
Click on items in browsers to perform quick actions:
- Mobs: Left-click to spawn, right-click to kill all instances
- Items: Click to receive the item
- Spawners: Left-click to force spawn, right-click to toggle active state
You can create custom menus by placing YAML files in the plugins/btcMobs/menus/ directory.
Menu:
Display: "<bold>My Custom Menu"
Size: 27 # Must be a multiple of 9 (9, 18, 27, 36, 45, 54)
DataProvider: mobs # Optional: mobs, items, spawners
Schema:
- "0 0 0 0 0 0 0 0 0"
- "0 M M M M M M M 0"
- "0 0 0 B 0 N 0 0 0"
Icons:
BORDER:
Mapping: "0"
Material: BLACK_STAINED_GLASS_PANE
Display: " "
MOB_SLOT:
Mapping: M
Material: BARRIER
Display: "<gray>Empty"
Dynamic: true # Filled by DataProvider
BUTTON_BACK:
Mapping: B
Material: ARROW
Display: "<red>Back"
Actions:
- "open: main"
BUTTON_NEXT:
Mapping: N
Material: PAPER
Display: "<yellow>Next Page"
Actions:
- "nextpage: my-menu"
Icon Properties
| Property | Description | Example |
|---|
Mapping | Character used in Schema | M |
Material | Bukkit material type | DIAMOND_SWORD |
Display | Display name (supports MiniMessage) | <gold><bold>My Item |
Lore | List of lore lines | See below |
Model | Custom model data | 100 |
Actions | List of click actions | See below |
Dynamic | Mark as dynamic slot for DataProvider | true |
Available Actions
| Action | Description | Example |
|---|
open: <menu> | Open another menu | open: item-browser |
close | Close the current menu | close |
command: <cmd> | Execute command as player | command: btc mobs spawn zombie |
console: <cmd> | Execute command as console | console: give <player> diamond 1 |
message: <msg> | Send message to player | message: <green>Hello! |
nextpage: <menu> | Go to next page | nextpage: mob-browser |
prevpage: <menu> | Go to previous page | prevpage: mob-browser |
Placeholders
| Placeholder | Description |
|---|
<page> | Current page number (1-indexed) |
<totalPages> | Total number of pages |
<currentPage> | Alias for page |
<totalItems> | Total items in the data provider |
<player> | Player name (in console commands) |
Data Providers
| Provider | Description |
|---|
mobs | Provides all registered mob types |
items | Provides all registered custom items |
spawners | Provides all configured spawners |