Installation Guide

TL;DR: Copy all of the jar files you like to use into your plugins/ directory and restart your server. If you use a third-party permissions plugin, be sure not to use vane-permissions but remember to give the relevant permissions to your players as described below! Vane will serve a server-resource pack, so if you are already using a pack, you will need to merge the two and serve it yourself.

1. Requirements

Before you proceed, make sure your server meets all requirements:

• Install the latest version of ProtocolLib (download here). Just drop the jar file in your plugins/ folder.

---

2. Download & Extract

Start by downloading all-plugins.zip from GitHub Releases. This archive will contain all the required vane-*.jar files so you don't have to download them individually. Place the .jar inside the archive into your plugins/ folder and delete the zip file.

At this step, you may choose which of vane's modules you want to have installed. For an better overview, have a look at the repository's README.md and the linked overview page at the top of it. For the sake of simplicity, you can for just use all the plugins and disable what you don't want later by editing the corresponding config.yml. You can even disable a whole plugin just by doing this.

• vane-core (always needed)
• vane-admin (chat message formatting, /setspawn, /spawn, automatic server stopping, mob griefing protections)
• vane-bedtime (skip night when 50% of players are sleeping)
• vane-enchantments (all custom enchantments)
• vane-permissions (actually lightweight and pedantic permission management, REPLACES other permission plugins)
• vane-portals (provides fancy portals)
• vane-regions (provides region system, requires portals to be installed, provides region system)
• vane-trifles (requires enchantments to be installed, provides a lot of the quality-of-life enhancements)

Delete the corresponding jar files, if you want to completely disable a module. If you want to disable just a specific function, you can do so later in the vane-whatever/config.yml file.

Beware to only use vane-permissions, if you don't want to use any other permission management system on your server. If you chose not to use vane-permissions, you NEED another way to add the permissions to your players (see 3.B.).

vane-permissions is lightweight and can be (optionally) configured to be very pedantic, but isn't suited for large server hubs that for example need to retrieve permissions from a database. If you are creating a server for a small group of people, vane-permissions will certainly suit your needs.

---

3. Give permissions to players

Finally, you may start your server again. Depending on what permission system you settled on, you will need to do some additional configuration. Continue with the appropriate subsection.

3.A. vane-permissions

No additional setup is needed for vane, and you can assign a permission group to a player by executing the following command on the console (or as an admin, if you have already given yourself that group):

perm add pepe_the_player user         # (Just a normal user, give this to players)
perm add pepe_the_player trusted      # (Also a user, but may also add new users with `/verify`)
perm add pepe_the_player admin        # (Full permissions, may execute any vane command)

If you have other plugins installed, you will need to add the required permissions to your user group. This is best done by simply editing vane-permissions/config.yml. This is also true for the vanilla commands like /tp, even when your player is OP! A list of the default permissions can be found here, or by executing perm list permissions.

3.B. Other permission management system / Default bukkit permissions

If you are NOT using vane-permissions, you will need to give your players some permissions so they have access to the correct things in vane. As there are many different permission systems, we can't go into the details for every one of them here.

Below is a list of permissions and who should have them. Use your permissions plugin to add these permissions to the correct player groups. And obviously you do not need to give players permissions from e.g. vane.admin.<something> if you don't use vane-admin in the first place.

# Any normal user should have these permissions.
user:
  - vane.admin.commands.spawn
  - vane.admin.modify_world
  - vane.regions.commands.region
  - vane.trifles.commands.heads

# Additionally to what normal users can do, verified users may use `/vouch`
verified:
  - vane.permissions.commands.vouch

# Admins should have everything `verified` users have, plus:
admin:
  - vane.admin.bypass_spawn_protection
  - vane.portals.admin
  - vane.regions.admin
  - vane.*.commands.*

---

4. Done

Congratulations, you have successfully installed vane. If you also want the advanced features like automatically starting the server or account multiplexing, please continue with Installation Guide (proxy). Otherwise, have fun playing!