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

# How to Install LiricCasino on Your Minecraft Server

> Download the LiricCasino JAR, install Vault and an economy plugin, drop the file into plugins/, and restart your server to get all 10 games running.

Installing LiricCasino takes only a few minutes. The plugin generates all of its configuration files automatically on first start, so there is no manual setup beyond placing the required dependencies. Follow the steps below to get your casino up and running.

## Dependencies

Before you install the plugin JAR, make sure these dependencies are in place:

| Plugin                                                                    | Required?    | Purpose                                                                     |
| ------------------------------------------------------------------------- | ------------ | --------------------------------------------------------------------------- |
| [Vault](https://www.spigotmc.org/resources/vault.34315/)                  | **Required** | Economy API bridge — LiricCasino talks to your economy plugin through Vault |
| Economy plugin (EssentialsX, CMI, etc.)                                   | **Required** | Provides the actual player balances Vault reads and writes                  |
| [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) | Optional     | Enables casino stat placeholders in scoreboards and other plugins           |

<Note>
  LiricCasino uses **SQLite by default**, so you do not need to set up an external database to get started. A `casino.db` file is created automatically inside `plugins/LiricCasino/`. If you prefer MariaDB for a multi-server setup, you can switch to it in `config.yml` after the first start — see the [Configuration](/casino/configuration) page for details.
</Note>

## Installation Steps

<Steps>
  <Step title="Verify your Java and server version">
    LiricCasino requires **Java 21 or newer** and runs on **Paper or Spigot 1.20.x – 1.21.x**. Folia is also supported. Check your Java version before continuing:

    ```bash theme={null}
    java -version
    ```

    You should see `version "21"` or higher in the output. If not, update your Java runtime before proceeding.
  </Step>

  <Step title="Download the plugin JAR">
    Grab the latest `CasinoLiric.jar` (version 2.0.3) from the official distribution page. Always download from the official source to ensure you have the correct, unmodified file.
  </Step>

  <Step title="Install Vault and your economy plugin">
    Download [Vault](https://www.spigotmc.org/resources/vault.34315/) and your chosen economy plugin (for example, EssentialsX or CMI) and place both JARs in your server's `plugins/` folder. LiricCasino will not load without Vault present.

    ```
    plugins/
    ├── Vault.jar
    ├── EssentialsX.jar   ← or your preferred economy plugin
    └── CasinoLiric.jar   ← added in the next step
    ```

    If you want PlaceholderAPI support, add that JAR to `plugins/` as well.
  </Step>

  <Step title="Drop CasinoLiric.jar into plugins/">
    Copy the downloaded `CasinoLiric.jar` into your server's `plugins/` folder alongside Vault and your economy plugin. No further file editing is required at this stage.
  </Step>

  <Step title="Start or restart your server">
    Start your server (or run `/restart` if it is already running). LiricCasino will detect Vault on startup and automatically generate all configuration files inside `plugins/LiricCasino/`:

    ```
    plugins/LiricCasino/
    ├── config.yml        ← main settings: database, taxes, per-game options
    ├── messages.yml      ← all player-facing messages
    ├── webhooks.yml      ← Discord webhook targets
    └── menus/
        ├── roulette.yml
        ├── blackjack.yml
        ├── slots.yml
        └── ...           ← one file per game
    ```

    Once the server finishes loading, you will see LiricCasino's startup message in the console confirming that Vault and the economy plugin were found.
  </Step>

  <Step title="Place physical games in your world">
    Some games — Roulette, Slots, Blackjack, and Poker — require a physical in-world object before players can use them. Use the setup command as an operator or a player with the `casino.admin` permission.

    For **Roulette**, **Blackjack**, and **Poker**, stand at the location where you want the game to appear and run:

    ```bash theme={null}
    /casino ruleta setup
    /casino blackjack setup
    /casino poker setup
    ```

    For the **Slot Machine**, look directly at the block you want to attach the machine to (within 5 blocks), then run:

    ```bash theme={null}
    /casino tragamonedas setup
    ```

    GUI-only games (Scratch Cards, Lottery, CoinFlip, Rock Paper Scissors, Tic Tac Toe, Horse Racing) are accessible immediately via their commands — no setup step needed.
  </Step>
</Steps>

## Verifying the Installation

After your server restarts, check the console for LiricCasino's startup message confirming that Vault and the economy plugin were detected. You can also run the following command in-game or from the console:

```bash theme={null}
/casino reload
```

If you see a success message, LiricCasino loaded correctly. You can then open any game with `/casino <game>` or its shortcut alias:

| Game                | Command                | Aliases                           |
| ------------------- | ---------------------- | --------------------------------- |
| Roulette            | `/casino ruleta`       | `/ruleta`, `/roulette`            |
| Blackjack           | `/casino blackjack`    | `/blackjack`, `/bj`, `/21`        |
| Slots               | `/casino tragamonedas` | `/tragamonedas`, `/slots`, `/777` |
| Poker               | `/casino poker`        | `/poker`                          |
| Scratch Cards       | `/casino boleto`       | `/boleto`, `/scratch`             |
| Lottery             | `/casino loteria`      | `/loteria`, `/lottery`            |
| CoinFlip            | `/casino coinflip`     | `/coinflip`, `/cf`                |
| Rock Paper Scissors | `/casino rps`          | `/rps`                            |
| Tic Tac Toe         | `/casino ttt`          | `/ttt`                            |
| Horse Racing        | `/casino carreras`     | `/carreras`                       |

<Tip>
  Grant yourself the `casino.admin` permission (or use operator status) to access setup, delete, and reload commands. Regular players only need the default permissions to play all enabled games.
</Tip>
