GroupeZ Docs
Modules

Warp Module

Server warp system with optional inventory display

File: modules/warp/config.yml

The Warp module provides a server-wide warp point system that allows administrators to create named locations and players to teleport to them. Warps can be browsed through a zMenu inventory GUI or listed directly in chat, depending on your configuration. This module is ideal for creating hub teleport points, event areas, shops, or any frequently visited location on your server.


Source Configuration

enable: true
enable-inventory: false
enable-no-argument-message: true

Options

OptionTypeDefaultDescription
enableBooleantrueEnable or disable the Warp module
enable-inventoryBooleanfalseWhen true, running /warps opens a zMenu inventory GUI (warps.yml) displaying all available warps. When false, warps are listed in chat instead
enable-no-argument-messageBooleantrueWhen true and enable-inventory is false, running /warp without arguments sends a chat message listing all available warps

Display Modes

  • Inventory mode (enable-inventory: true) -- Running /warps opens an interactive zMenu inventory defined in warps.yml. Players can click warp items to teleport. This provides a rich, visual browsing experience.
  • Chat mode (enable-inventory: false, enable-no-argument-message: true) -- Running /warp without arguments lists all available warps directly in the player's chat. Players can then use /warp <name> to teleport.

If you enable inventory mode, make sure the warps.yml zMenu inventory file is properly configured. The plugin will attempt to open this inventory when players use the /warps command.

When both enable-inventory and enable-no-argument-message are set to false, running /warp without arguments will produce no output. Ensure at least one display option is enabled so players can discover available warps.


How It Works

  1. An administrator creates a warp point at their current location using /setwarp <name>.
  2. The warp is saved and becomes available to all players with the appropriate permission.
  3. Players teleport to a warp using /warp <name>.
  4. If enable-inventory is true, players can browse all warps in a GUI by running /warps.
  5. If enable-inventory is false and enable-no-argument-message is true, running /warp without arguments lists all warps in chat.
  6. Administrators can remove a warp using /delwarp <name>.

CommandAliasesPermissionDescription
/warpwessentials.warpTeleport to a named warp point
/setwarpwcreateessentials.warp.setCreate a new warp at your current location
/delwarpwdeleteessentials.warp.delDelete an existing warp
/warpswlistessentials.warpsList all available warps (chat or inventory depending on config)

For the full command list, see Commands & Permissions.


PermissionDescription
essentials.warpAllows teleporting to warp points using /warp
essentials.warp.setAllows creating new warp points using /setwarp
essentials.warp.delAllows deleting warp points using /delwarp
essentials.warpsAllows listing all warp points using /warps

Example Usage

Inventory Mode

Enable the GUI-based warp browser for a user-friendly experience:

enable: true
enable-inventory: true
enable-no-argument-message: true

Players running /warps will see a zMenu inventory with all configured warps. Clicking a warp item teleports the player to that location.

Chat Mode

Keep things simple with a chat-based warp list:

enable: true
enable-inventory: false
enable-no-argument-message: true

Players running /warp without arguments will receive a chat message listing all available warp names. They can then use /warp <name> to teleport.

On this page

GroupeZ MCP

Documentation in your AI

MCP lets your AI search GroupeZ documentation and read current examples to help you configure your plugins.

Read-only · No documentation API key needed

1. Copy the server URL

Transport: HTTP (Streamable HTTP). Authentication: none. Your tool uses its own model and subscription limits.

  1. Open Plugins in ChatGPT on the web, then + → Add custom MCP server.
  2. Name it ‘GroupeZ Documentation’, paste the URL above and choose ‘No authentication’. Create and install the plugin.
  3. In a conversation, type @ and select the plugin before asking. If needed, enable search, get_page and list_pages in its settings.
Official setup guide

3. Ask a question

Use GroupeZ MCP to help me create a zMenu inventory. Search relevant pages, read the examples and cite your sources.
Other clients and troubleshooting

For clients using mcpServers, adapt this example to their format:

{
  "mcpServers": {
    "groupez-docs": {
      "url": ""
    }
  }
}

Available tools are search, get_page and list_pages. Refresh the connector’s tools after updates. If your AI cannot access them, check that the connector is enabled in the conversation and your account allows custom MCP servers. Opening the URL in a browser is not an MCP test.