Quick Access Configuration

Quick Access Configuration

File: quickaccess/quickaccess.json

Configures the quick access sidebars on the left and/or right of the main content.

Complete Example

{
  "left": {
    "enabled": true,
    "width": 260,
    "title": "Navigation",
    "categories": [
      {
        "title": "Links",
        "icon": "Ore_Prisma",
        "color": "#4a9eff",
        "buttons": [
          {
            "label": "Discord",
            "command": "https://discord.gg/example",
            "text": "Join our Discord Server!"
          },
          {
            "label": "Website",
            "command": "https://example.com"
          }
        ]
      },
      {
        "title": "Teleports",
        "icon": "Weapon_Longsword_Iron",
        "color": "#69db7c",
        "buttons": [
          { "label": "Home", "command": "/home" },
          { "label": "Spawn", "command": "/spawn" }
        ]
      }
    ]
  },
  "right": {
    "enabled": true,
    "width": 260,
    "title": "Quick Access",
    "categories": [
      {
        "title": "Achievements",
        "icon": "Ore_Gold",
        "buttons": [
          { "label": "Achievements", "command": "/achievements" },
          { "label": "Rewards", "command": "/rewards" }
        ]
      },
      {
        "title": "Tools",
        "icon": "Tool_Pickaxe_Iron",
        "buttons": [
          { "label": "Settings", "command": "/settings" },
          { "label": "Statistics", "command": "/stats" }
        ]
      }
    ]
  }
}

---

Sidebar Structure

{
  "enabled": true,
  "width": 260,
  "title": "Sidebar Title",
  "categories": []
}

Field	Type	Default	Description
enabled	Boolean	true	Enable/disable the sidebar
width	Integer	260	Width of the sidebar in pixels (minimum: 260)
title	String	"Quick Access"	Sidebar title
categories	Array	[]	Categories with buttons

---

Category Structure

{
  "title": "Category Title",
  "icon": "Item_Id",
  "color": "#4a9eff",
  "textColor": "#4a9eff",
  "buttons": []
}

Field	Type	Default	Description
title	String	-	Category heading
icon	String	-	Item ID for icon
color	String	auto	Accent color for header background and indicator bars (#RRGGBB or #RRGGBBAA)
textColor	String	same as color	Text color for category header title (#RRGGBB)
buttons	Array	[]	Buttons in this category

:::tip Auto Colors If no color is set, a color is automatically assigned from a built-in palette. The textColor defaults to the accent color if not explicitly set. :::

---

Button Structure

Each button in the Quick Access sidebar can have the following properties:

{
  "label": "Button Text",
  "command": "/command",
  "text": "Optional custom text",
  "permission": "some.permission",
  "runAsConsole": false
}

Field	Type	Required	Default	Description
label	String	Yes	-	The text displayed on the button
command	String	Yes	-	The command to execute or URL to open
text	String	No	-	Optional text for chat links (only for URLs)
permission	String	No	null	Permission required to see this button (null = visible to all)
runAsConsole	Boolean	No	false	If true, the command is executed as the server console instead of the player

:::caution Console Execution Use runAsConsole carefully. Commands run with full server privileges. This is useful for admin commands that require elevated permissions, but should be restricted via the permission field. :::

Supported Actions

Commands

Commands start with / or are a simple command name:

{ "label": "Home", "command": "/home" }
{ "label": "Spawn", "command": "spawn" }

Links

URLs starting with http:// or https:// are displayed as clickable links in chat:

{ "label": "Discord", "command": "https://discord.gg/example" }

Links with Custom Text

The optional text field overrides the automatically extracted domain name:

{
  "label": "Discord",
  "command": "https://discord.gg/example",
  "text": "Join our Discord Server!"
}

:::tip URL Handling When a button with a URL is clicked, the player receives a clickable chat message with the link. Without the text field, the domain name is shown. With the text field, your custom text is displayed instead. :::

---

Limits

• Maximum 4 categories per sidebar
• Maximum 4 buttons per category

---

Examples

Left Sidebar Only

{
  "left": {
    "enabled": true,
    "title": "Quick Menu",
    "categories": [
      {
        "title": "Navigation",
        "icon": "Consumable_Pearl",
        "buttons": [
          { "label": "Spawn", "command": "/spawn" },
          { "label": "Home", "command": "/home" }
        ]
      }
    ]
  },
  "right": {
    "enabled": false,
    "title": "",
    "categories": []
  }
}

Right Sidebar Only

{
  "left": {
    "enabled": false,
    "title": "",
    "categories": []
  },
  "right": {
    "enabled": true,
    "title": "Shortcuts",
    "categories": [
      {
        "title": "Shop",
        "icon": "Ore_Gold",
        "buttons": [
          { "label": "Shop", "command": "/shop" },
          { "label": "Sell", "command": "/sell" },
          { "label": "Balance", "command": "/balance" }
        ]
      }
    ]
  }
}

Both Sidebars Disabled

{
  "left": {
    "enabled": false,
    "title": "",
    "categories": []
  },
  "right": {
    "enabled": false,
    "title": "",
    "categories": []
  }
}

Full Navigation Setup

{
  "left": {
    "enabled": true,
    "title": "Navigation",
    "categories": [
      {
        "title": "Teleport",
        "icon": "Consumable_Pearl",
        "buttons": [
          { "label": "Home", "command": "/home" },
          { "label": "Spawn", "command": "/spawn" },
          { "label": "Warps", "command": "/warps" },
          { "label": "TPA", "command": "/tpa" }
        ]
      },
      {
        "title": "Economy",
        "icon": "Ore_Gold",
        "buttons": [
          { "label": "Shop", "command": "/shop" },
          { "label": "Auction", "command": "/ah" },
          { "label": "Balance", "command": "/bal" }
        ]
      },
      {
        "title": "Social",
        "icon": "Deco_MusicDisc",
        "buttons": [
          { "label": "Party", "command": "/party" },
          { "label": "Guild", "command": "/guild" },
          { "label": "Friends", "command": "/friends" }
        ]
      }
    ]
  },
  "right": {
    "enabled": true,
    "title": "Features",
    "categories": [
      {
        "title": "Progress",
        "icon": "Ore_Prisma",
        "buttons": [
          { "label": "Achievements", "command": "/achievements" },
          { "label": "Quests", "command": "/quests" },
          { "label": "Skills", "command": "/skills" },
          { "label": "Rewards", "command": "/rewards" }
        ]
      },
      {
        "title": "Info",
        "icon": "Deco_Book",
        "buttons": [
          { "label": "Stats", "command": "/stats" },
          { "label": "Playtime", "command": "/playtime" },
          { "label": "Votes", "command": "/vote" }
        ]
      }
    ]
  }
}

---

Best Practices

1. Keep buttons relevant - Most-used commands only
2. Group logically - Related commands together
3. Use clear labels - Short but descriptive
4. Don’t overcrowd - Leave some space
5. Test all buttons - Ensure commands work