> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/pinnapass/getting-started/installation.md).

# Installation

1. Stop the server, put `PinnaPass.jar` in `plugins/`, start it.
2. On the first start the server downloads the H2 database driver (a few seconds, once) and PinnaPass writes its files to `plugins/PinnaPass/`.
3. Join and run `/pass`.

Running several servers (a network)? Keep the passes in one MySQL / MariaDB database: see [Storage & MySQL](/p/pinnapass/getting-started/storage.md).

## Optional plugins

Nothing else is needed. Each of these adds something when it is installed, and nothing breaks when it isn't:

| Plugin                                                                                            | Adds                                                                               |
| ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| Vault + an economy                                                                                | `economy.currency: vault`, `money:` rewards, `money-earned` / `money-spent` quests |
| PlaceholderAPI                                                                                    | `%pinnapass_...%` placeholders, placeholders in menus, `placeholder` quests        |
| PlayerPoints                                                                                      | `economy.currency: playerpoints`, `points:` rewards                                |
| ItemsAdder / Oraxen / Nexo                                                                        | their items as menu icons (`material: itemsadder:ns:id`)                           |
| Jobs, mcMMO, AuraSkills, MythicMobs, EliteMobs, Citizens, ShopGUIPlus, EconomyShopGUI, NuVotifier | quest types, see [Quest Types](/p/pinnapass/quests/quest-types.md)                 |
| PinnaPrison, EdPrison, EdTools, EdDungeons                                                        | `mine-blocks` and other quest types, their currencies for purchases and rewards    |
| PinnaMailbox                                                                                      | reward items that don't fit go to the mailbox instead of the ground                |
| EdLang                                                                                            | every text in each player's own language                                           |

`/pinnapass hooks` lists what was hooked and every quest type the server knows.

## Selling the premium passes

* **In game:** players buy them in `/pass` with the currency of `economy.currency`.
* **Web store (Tebex, CraftingStore...):** set `economy.currency: none` (or keep both) and have the package run `pinnapass premium {player} gold true`. Personal XP boosts: `pinnapass boost {player} 2 3600 -s`.
* **Ranks:** the permissions `pinnapass.gold` / `pinnapass.diamond` count as owning the pass.
