Region Welcome

A common server pattern: when a player walks into spawn, show a welcome screen with quick-access buttons (rules, hub, kit). The activator here is regionJoin from WorldGuard, not a command - the menu opens itself when the player crosses the region boundary.

What it teaches

• The regionJoin activator (and its sibling regionLeave)
• WorldGuard integration via region names
• Combining a passive welcome with quick-action tiles that link to other menus

intermediate

Features: regionJoinopenMenuWorldGuard-integration

Requires: WorldGuard

Open: (on region enter)

menu.conf

# Region Welcome - greet players who enter a WorldGuard region
# Docs: https://abstractmenus.github.io/docs/en/examples/world-integrations/region-welcome
# Open: automatically on entering region "spawn"
# Requires: WorldGuard

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

title: "&6Welcome to Spawn"
size: 3

activators {
  regionJoin: ["spawn"]
}

items: [
  ${borderBlack} { slot: "0-8" }
  ${borderBlack} { slot: "18-26" }

  # Welcome banner
  {
    slot: 4
    material: NETHER_STAR
    name: "&6&lWelcome to MyTestServer"
    lore: [
      "&7You've entered the &fSpawn&7 region."
      ""
      "&7Pick up where you left off."
    ]
  }

  # Quick links
  {
    slot: 11
    material: COMPASS
    name: "&aOpen the main hub"
    lore: ["&7Browse all available menus."]
    click {
      openMenu: "ame_hub"
    }
  }
  {
    slot: 13
    material: WRITTEN_BOOK
    name: "&aServer rules"
    lore: ["&7Read the rules before playing."]
    click {
      openMenu: "ame_rules"
    }
  }
  {
    slot: 15
    material: CHEST
    name: "&aGet your starter kit"
    lore: ["&7Free items for new players."]
    click {
      openMenu: "ame_kit"
    }
  }

  ${buttonClose} { slot: 22 }
]

_shared/templates.conf

# AbstractMenus example pack - shared templates
# Reusable HOCON snippets referenced from menus via ${blockName} substitution.
# Docs: https://abstractmenus.github.io/docs/en/examples

# Sound presets (Paper 1.21+ registry keys)
clickSound:    "ui.button.click"
openSound:     "block.chest.open"
closeSound:    "block.chest.close"
successSound:  "entity.experience_orb.pickup"
failSound:     "block.note_block.bass"
deniedSound:   "block.anvil.land"

# Deny action snippets (use as: denyActions: ${denyNoMoney})
denyNoMoney {
  sound:   ${deniedSound}
  message: "&cYou don't have enough money."
}
denyNoPerm {
  sound:   ${deniedSound}
  message: "&cYou don't have permission."
}
denyCooldown {
  sound:   ${deniedSound}
  message: "&cYou're on cooldown. Try again later."
}

# Border items (use as: ${borderBlack} { slot: "0-8" })
borderBlack {
  material: BLACK_STAINED_GLASS_PANE
  name: " "
}
borderGray {
  material: GRAY_STAINED_GLASS_PANE
  name: " "
}
borderBlue {
  material: BLUE_STAINED_GLASS_PANE
  name: " "
}

# Navigation buttons (use as: ${buttonClose} { slot: 22 })
buttonClose {
  material: BARRIER
  name: "&cClose"
  click {
    closeMenu: true
  }
}
buttonBack {
  material: ARROW
  name: "&eBack"
  lore: ["&7Return to previous menu"]
  click {
    closeMenu: true
  }
}
buttonNext {
  material: ARROW
  name: "&eNext page"
  click {
    pageNext: 1
  }
}
buttonPrev {
  material: ARROW
  name: "&ePrevious page"
  click {
    pagePrev: 1
  }
}

# Rule shortcut snippets (use as: rules: ${rulesAdmin})
rulesAdmin   { permission: "abstractmenus.admin" }
rulesVip     { permission: "abstractmenus.vip" }
rulesDonator { permission: "abstractmenus.donator" }

# Common decorative header (use as: ${commonHeader} { slot: 4 })
commonHeader {
  material: NETHER_STAR
  name: "&6&lExample Menu"
  lore: ["&7Welcome to the AbstractMenus example pack"]
}

↓ menu.conf ↓ Bundle (.zip)

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

How it works

The activator block names one or more region IDs:

activators {
  regionJoin: ["spawn"]
}

When the player enters the spawn region (defined in WorldGuard), the menu opens for them. Multiple region IDs can be listed; the menu opens whenever the player enters any of them.

The menu has no money rules, no buy actions - it’s a glorified bulletin board. The three quick-link tiles in the middle row each call openMenu to navigate the player to another example.

Region setup on the server

This example assumes a WorldGuard region named spawn exists. Define it with:

/rg define spawn

Then put this menu in plugins/AbstractMenus/menus/example/world-integrations/01-region-welcome/menu.conf, and /am reload. Walking into the region triggers the menu.

Related activators

• regionLeave - same shape, fires when the player leaves the region. Useful for “say goodbye” or “warn before PvP” use cases.
• clickEntity / clickNPC / clickBlock - other “the world triggers the menu” activators. See Activators for the full list.

Try it

After installing the example pack:

1. Install WorldGuard.
2. Create a region named spawn with /rg define spawn.
3. Drop the bundle into plugins/AbstractMenus/menus/example/.
4. /am reload.
5. Walk into the region.