# Overview

The Elevators plugin allows players to teleport vertically using Elevators. By placing Elevators aligned vertically, players can jump to ascend or crouch to descend between floors.

---

# Features

Easily create personalized elevators with many features designed for flexibility:

• Custom Item names and lore
• On-Use Effects & Actions
• Multiple Elevator Types
• Admin GUI
• Per-Elevator Customization
• Hologram, PlaceHolder & Protection Plugin Integration

---

# Usage

BGHDDevelopment was kind of enough to make a funny and concise video detailing how to use this plugin.

---

# Installation

You can download the latest version of Elevators below:

For installation instructions and getting started, check out the Getting Started guide.

---

# Goals

# Simple Setup

This plugin can be used right out of the box with no configuration changes needed. Any changes that may be desired can be done through the in-game admin menu.

# Lightweight

Elevators is built with performance in mind. At its core, the plugin does exactly what an elevator should—teleport players from point A to point B with minimal impact on server resources.

While the plugin offers a variety of optional features to enhance the experience, the core functionality remains lightweight and efficient.

Performance is further optimized when running on PaperMC or any of its forks, which include internal improvements that specifically benefit mechanics involving shulker boxes.

# Highly Configurable

Nearly every aspect of the elevators plugin can be configured, from individual elevator permissions all the way down to which Elevator an effect should play on when used. Most config settings can be changed through the admin UI.

# Easy To Use

Teleporting does not get much easier than jumping and crouching to navigate. To top it off, the setup is as simple as placing two Elevator blocks in line with each other.

# No External Data Storage

Unlike many other Elevator plugins, this plugin does not keep a database or config file for storing the location of the Elevators. All the data is stored in the individual block. This means that this plugin offers maximum support for any action that can move or break an Elevator, including WorldEdit and basic Minecraft commands.

# Open Source

This plugin is available under the GPL-3.0 license. You are able to fork it, change it, and even sell it commercially; however, any iteration must also have this license.

# Compatibility

This plugin supports Minecraft versions all the way down to 1.14 when the Spigot API first introduced the DataContainerService that makes this possible.