> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hauch.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installing hLobby

> Download and install hLobby on your Velocity proxy.

## Prerequisites

> **Velocity 3.4.0+**
>
> A running Velocity proxy.

> **Java 21+**
>
> Required runtime version.

> **Lobby servers**
>
> Backend servers already registered in `velocity.toml`.

## Download

Download the latest JAR from the [releases page](https://github.com/hauchdev/hLobby/releases/latest).

```bash theme={null}
wget https://github.com/hauchdev/hLobby/releases/latest/download/hLobby-1.0.0.jar
```

Replace `hLobby-1.0.0.jar` with the latest version shown on the release page.

## Install

**1. Place the jar**

Move the downloaded JAR into your Velocity `plugins/` folder.

```bash theme={null}
mv hLobby-1.0.0.jar /path/to/velocity/plugins/
```

**2. Start Velocity**

Start or restart your proxy. hLobby will create `plugins/hLobby/config.yml` and `plugins/hLobby/lang/*.yml` on first start.

**3. Add your lobbies**

Open `plugins/hLobby/config.yml` and list your lobby servers under `lobby.servers`. These names must match the servers defined in `velocity.toml`.

**4. Reload**

Run `/hlobby reload` from the console or in-game with permission `lobby.admin.main`.

## Verify the installation

Run `/hlobby about` in-game or `hlobby about` from the console. You should see the plugin version, metrics status, and website link.

## Updating

To update hLobby:

1. Stop your Velocity proxy.
2. Replace the old JAR with the new one in `plugins/`.
3. Start the proxy again.

Your `config.yml` and language files are preserved. New config options are added automatically when missing.

## Next steps

> **[Configuration](https://docs.hauch.dev/en/hLobby/configuration.md)**
>
> Learn every config option.

> **[Commands](https://docs.hauch.dev/en/hLobby/commands.md)**
>
> See all available commands.

> **[Permissions](https://docs.hauch.dev/en/hLobby/permissions.md)**
>
> Set up permissions.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.