> For the complete documentation index, see [llms.txt](https://simple.superiormc.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://simple.superiormc.cn/arcmenu-wiki/configuration-and-administration/commands-permissions.md). # Commands and permissions The main command is `/arcmenu`. `` indicates a required value and `[argument]` indicates an optional value; omit the brackets when entering commands. Tab completion is available. ## Common commands These commands apply to Paper, Folia, Leaf and Spigot. ### Player controls | Command | Purpose | Permission | | ------------------------- | ------------------------------------------------- | ------------------------------------------------------ | | `/arcmenu open ` | Open a menu for the player executing the command. | `arcmenu.use` and any permission required by the menu. | | `/arcmenu close` | Close the executing player's current menu. | No additional permission required. | Both commands must be executed in game. Neither accepts an argument for targeting another player. For example, open a menu configured with `id: welcome`: ``` /arcmenu open welcome ``` ### Configuration management These commands require `arcmenu.admin` and can be executed in game or from the console. Omit the leading `/` in the console. | Command | Purpose | | ------------------- | -------------------------------------- | | `/arcmenu list` | List loaded menu identifiers. | | `/arcmenu validate` | Check configuration and report errors. | | `/arcmenu reload` | Reload configuration. | | `/arcmenu status` | View menu counts and current usage. | After changing menus, validate and reload: ``` /arcmenu validate /arcmenu reload ``` {% hint style="info" %} A successful reload closes currently open menus. Correct reported errors before reloading again. Validation does not replace reloading; replacing the plugin file requires a server restart. {% endhint %} ## Commands for Paper, Folia and Leaf These commands are unavailable on Spigot. ### Interaction modes See [Touch and mouse input](/arcmenu-wiki/feature-configuration/input-modes.md) for controls, mode policies and cursor settings. These commands require `arcmenu.use` and must be executed in game. | Command | Purpose | | --------------------- | --------------------------------------------------------------- | | `/arcmenu mode` | View the current interaction mode and server policy. | | `/arcmenu mode touch` | Select touch mode, using the player's view to point at buttons. | | `/arcmenu mode mouse` | Select mouse mode, using a cursor to interact. | Players cannot change modes when an administrator has forced a mode. Client and resource-pack requirements for mouse mode are listed in [Requirements](/arcmenu-wiki/getting-started/requirements.md). ### Resources and templates These commands require `arcmenu.admin` and can be executed in game or from the console. | Command | Purpose | | --------------------- | ---------------------------------------------------------------- | | `/arcmenu reload all` | Reload configuration and templates, and rebuild image resources. | | `/arcmenu resources` | Rebuild the resource pack without reloading menu definitions. | | `/arcmenu templates` | List loaded template identifiers. | Rebuilt packs still need to be distributed to players. With CraftEngine, run `/ce reload all` afterward. Other distribution methods are covered in [Resource pack configuration](/arcmenu-wiki/getting-started/install.md#resource-pack-configuration). ### Preview and editing These commands require `arcmenu.admin` and must be executed in game. | Command | Purpose | | ------------------------------------------------ | ----------------------------------------------------------------------------------------- | | `/arcmenu preview [frontend\|backend]` | Preview a menu's visible content by default, or use `backend` to inspect its hit regions. | | `/arcmenu edit ` | Open a menu for editing with ArcMenu Editor. | For example, inspect the hit regions of `welcome`: ``` /arcmenu preview welcome backend ``` Previews do not execute menu click actions. Use `/arcmenu open ` to test buttons in a normally opened menu. Editing requires a compatible ArcMenu Editor installation on the administrator's client. Players do not need the editor. ### Animations These commands require `arcmenu.admin`. | Command | Purpose | Execution location | | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------ | | `/arcmenu animations` | List animations available in the player's current menu, or configured animation identifiers when executed from the console. | Game or console. | | `/arcmenu animate ` | Play an animation in the current menu. | In game. | | `/arcmenu stop-animation ` | Stop an animation in the current menu. | In game. | Open a menu containing the animation before playing or stopping it. The argument is an animation identifier, not a menu identifier. ### Status and troubleshooting These commands require `arcmenu.admin`. Use them to inspect menu interaction or collect information about a problem. | Command | Purpose | Execution location | | ---------------------------- | -------------------------------------------------------------------- | -------------------------- | | `/arcmenu pointer` | View pointer information for the current menu. | In game, with a menu open. | | `/arcmenu pointer debug on` | Enable cursor diagnostic visuals to investigate mouse-mode problems. | In game. | | `/arcmenu pointer debug off` | Disable cursor diagnostic visuals. | In game. | | `/arcmenu performance` | View plugin performance statistics. | Game or console. | | `/arcmenu performance reset` | Reset performance statistics. | Game or console. | Before using cursor diagnostics, open a menu in mouse mode and load its matching resource pack. The command reports when diagnostics are unavailable. ## Permission configuration ### Plugin permissions | Permission | Purpose | Default | | --------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------ | | `arcmenu.use` | Open menus and select an interaction mode on supported servers. | All players. | | `arcmenu.admin` | Validate and reload configuration, manage menus, and use editing and other administrative features on supported servers. | OP. | `arcmenu.admin` does not replace `arcmenu.use` or a menu's additional permission. Administrators who use menus also need the appropriate permissions. ### Menu permissions Set an additional permission using a menu's top-level `permission` field: ```yaml permission: myserver.menu.vip ``` Players then need both `arcmenu.use` and `myserver.menu.vip` to open that menu. Grant custom permissions through your server's permissions plugin. ## Spigot command scope Spigot uses the common commands listed on this page. Menus use the crosshair; `mode` cannot enable mouse mode. Resource-pack, template, editing, preview and animation management commands are unavailable. Apply configuration changes with `/arcmenu reload`; `reload all` is unnecessary. Configuration paths and update procedures are described in [Configuration files](/arcmenu-wiki/configuration-and-administration/configuration-files.md). ## Next step Continue with [Platform and plugin compatibility](/arcmenu-wiki/configuration-and-administration/compatibility.md) to check feature availability and integration requirements.