> 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/getting-started/install.md).

# Installation and updates

This page covers installation on Paper, Folia, Leaf and compatible servers, as well as Spigot. Before installing, check that your server and Java versions meet the [Requirements](/arcmenu-wiki/getting-started/requirements.md).

## Installation steps

Both server types use the same ArcMenu plugin file.

1. Stop the server.
2. Place the ArcMenu `.jar` file in the server's `plugins/` directory.
3. If ArcMenu is already installed, remove the old `.jar` file so that only one ArcMenu plugin file remains.
4. Start the server and check the console for errors.
5. Follow the instructions for your server below to check the configuration files and open an example menu.

## Paper, Folia and Leaf

### Initial startup

ArcMenu creates configuration files and example menus in `plugins/ArcMenu/`. Install the relevant [optional plugins](/arcmenu-wiki/getting-started/requirements.md#optional-plugins) if you need placeholders, economy features or custom items.

| Path             | Purpose                                                             |
| ---------------- | ------------------------------------------------------------------- |
| `config.yml`     | Basic settings, including language, shortcuts and interaction mode. |
| `menus/`         | Menu configuration.                                                 |
| `images/`        | PNG images used by menus.                                           |
| `templates/`     | Reusable menu components.                                           |
| `animations.yml` | Menu animations.                                                    |
| `tooltip.yml`    | Tooltip styles.                                                     |
| `languages/`     | Plugin messages.                                                    |

These paths are relative to `plugins/ArcMenu/`. Refer to `menus/example.yml` alongside the example menu in game to understand its configuration.

### Example menu

Join with an OP account and run the following command while standing on the ground:

```
/arcmenu open example
```

By default, **Shift+F** opens or closes the main menu. A menu can also be closed with:

```
/arcmenu close
```

{% hint style="info" %}
Players must be on the ground to open a menu. Moving, teleporting or dying closes it. Looking around while standing still keeps it open.
{% endhint %}

### Resource pack configuration

Menus with custom images require players to load the ArcMenu resource pack.

**With CraftEngine:** After changing images or related configuration, run these commands in order:

```
/arcmenu reload all
/ce reload all
```

CraftEngine merges the ArcMenu assets into its resource pack. After the rebuild completes, distribute the updated pack to players.

**Without CraftEngine:** The generated ArcMenu pack is located at:

```
plugins/ArcMenu/generated/arcmenu-resourcepack.zip
```

Distribute this file through the server's resource pack settings or merge it into an existing pack. ArcMenu does not automatically send the file to players.

{% hint style="info" %}
Players must accept and load the resource pack for menu images to appear correctly. After changing images, update the pack players receive as well.
{% endhint %}

### Interaction modes

Touch mode is the default and allows players to point at menu buttons with their view. Players can switch modes with:

```
/arcmenu mode touch
/arcmenu mode mouse
```

`touch` selects touch mode; `mouse` selects mouse mode. If an administrator has forced a mode, players cannot change it. Before using mouse mode, check the client version against [Requirements](/arcmenu-wiki/getting-started/requirements.md) and load the matching resource pack.

### Configuration reload

| Command               | Purpose                                                                                        |
| --------------------- | ---------------------------------------------------------------------------------------------- |
| `/arcmenu validate`   | Check menu configuration for errors.                                                           |
| `/arcmenu reload`     | Reload menu, animation and related configuration.                                              |
| `/arcmenu reload all` | Reload configuration and rebuild resources after changing images, templates or tooltip styles. |

A successful reload closes currently open menus. If configuration errors are reported, correct them and reload again. Resource changes also require updating the pack players receive.

## Spigot

### Initial startup

Spigot requires version 26.1 or newer. After installing the plugin using the steps above, ensure that the server has internet access on its first startup so ArcMenu can download the required files. If the download fails, check the connection and restart the server.

After startup, check the following files:

| Path                                       | Purpose                           |
| ------------------------------------------ | --------------------------------- |
| `plugins/ArcMenu/config.yml`               | Plugin message language settings. |
| `plugins/ArcMenu/languages/`               | Plugin messages.                  |
| `plugins/ArcMenu/spigot/config.yml`        | Main-menu shortcut settings.      |
| `plugins/ArcMenu/spigot/menus/example.yml` | Example main menu.                |
| `plugins/ArcMenu/spigot/menus/details.yml` | Example details menu.             |

Place custom menus in `plugins/ArcMenu/spigot/menus/` and edit shortcut settings in `plugins/ArcMenu/spigot/config.yml`.

Language settings use the root configuration. See [Language management](/arcmenu-wiki/feature-configuration/languages.md).

### Example menu

Join with an OP account and run:

```
/arcmenu open example
```

Use the crosshair to point at menu buttons. By default, **Shift+F** opens or closes the main menu. A menu can also be closed with:

```
/arcmenu close
```

To disable the main-menu shortcut, set the following in `plugins/ArcMenu/spigot/config.yml`:

```yaml
shortcuts:
  shift-f: false
```

Then run `/arcmenu reload`.

### Configuration reload

| Command             | Purpose                                        |
| ------------------- | ---------------------------------------------- |
| `/arcmenu list`     | List loaded menus.                             |
| `/arcmenu validate` | Check menu configuration for errors.           |
| `/arcmenu reload`   | Reload menus, shortcuts and language settings. |

A successful reload closes currently open menus. If configuration errors are reported, correct them and reload again.

{% hint style="info" %}
Spigot supports basic menus. Mouse mode, custom images, animations, tooltips, the visual editor and the optional integrations listed in Requirements are unavailable. The resource pack and mouse-mode setup steps above do not apply to Spigot. See Requirements for the full list of Spigot limitations.
{% endhint %}

## Permissions

Players have `arcmenu.use` by default, allowing them to open menus. If a menu has an additional permission, players also need that permission.

Configuration validation, menu lists and reload commands require `arcmenu.admin`, which is granted to OPs by default.

## Plugin updates

1. Back up the entire `plugins/ArcMenu/` directory, including Spigot configuration if present.
2. Read the release notes for any configuration changes or required editor updates.
3. Stop the server.
4. Remove the old plugin `.jar` file and install the replacement.
5. Start the server and check the console for errors.
6. Open menus and verify their buttons and the features in use.

Existing configuration is usually retained and should be adjusted according to the release notes. Servers using resource packs must also rebuild and distribute the pack when an update changes its assets.

Replacing the plugin file requires a server restart. `/arcmenu reload` cannot replace that restart.

## Next step

After installation and a successful check of the example menu, follow [Your first menu](/arcmenu-wiki/getting-started/first-menu.md) to create a custom menu.