> For the complete documentation index, see [llms.txt](https://mavenverse.gitbook.io/mavenverse-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mavenverse.gitbook.io/mavenverse-docs/introduction-and-setup.md).

# Introduction & Setup

Installation, requirements, and building your first zipline

Welcome to the official **Zipline** documentation. Zipline brings realistic, physics-based aerial cable transit to Minecraft 1.20.4+ Paper, Purpur, and Spigot servers.

## Key Features

* **Custom Trolleys**: Multi-part cable cars complete with cushion seats, overhead crossbeams, hanging chains, and pulley clamps.
* **Smooth Riding**: Fluid client-side movement with zero stutter, jitter, or armor-stand wobble.
* **Dynamic Speed**: Downhill slopes give a natural speed boost, uphill climbs slow down realistically, and trolleys gently brake as they arrive at stations.
* **Multi-Station Lines**: Build scenic transit networks with multiple stops along a single line.
* **Two-Way Travel**: Return journeys with persistent parking—the trolley stays where it stopped, even across server restarts.
* **Station Call Buttons**: Players can press a button or ring a bell at any station to summon an empty trolley.
* **Safe Platform Dismount**: Riders step off safely onto the station walkway without getting stuck in the seat or suffocating in low ceilings.
* **No Resource Pack Needed**: Renders dynamically in vanilla Minecraft using modern Display Entities.

***

## Server Requirements

| Component             | Requirement                                                |
| --------------------- | ---------------------------------------------------------- |
| **Minecraft Version** | 1.20.4+ (Paper, Purpur, or Spigot)                         |
| **Java Version**      | Java 21 or newer                                           |
| **Dependencies**      | None (Optional: Vault + any Economy plugin for ride fares) |

***

## Installation

1. Download the latest `zipline-x.x.x.jar`.
2. Place the jar file into your server's `plugins/` directory.
3. Restart your server.
4. Verify the plugin is running with `/zipline` or `/plugins`.

***

## Building Your First Zipline

Creating a zipline takes just a few clicks with the setup wand.

### 1. Get the Wand

Run the command:

```bash
/zipline wand
```

You will receive the **Zipline Setup Wand** in your hand.

### 2. Select Your Stations

Click the blocks where you want the cable to attach (the rope anchors to the bottom of the clicked block):

* **Left-Click**: Sets the **Start Station** (Point 1). Visualized with green particles.
* **Right-Click**: Adds a **Curve Waypoint** (guides the cable around corners without stopping). Visualized with blue particles.
* **Sneak + Right-Click**: Adds a **Station Stop** (where the trolley pauses so passengers can get on or off). Visualized with flame particles.
* **Sneak + Left-Click**: Sets the **End Station** (Terminus). Visualized with chime particles.

A glowing line connects your points in real time to preview the route.

### 3. Create the Line

Once your start and end points are set, build the zipline:

```bash
/zipline create alpine_express
```

You can also set speed and colors right away:

```bash
/zipline create <id> [speed] [cable_color] [seat_color]
```

*Example:* `/zipline create alpine_express 14.0 BLACK RED` creates a line cruising at 14 blocks/second with a black cable and red seat.

Right-click the trolley seat to board and enjoy the ride!


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://mavenverse.gitbook.io/mavenverse-docs/introduction-and-setup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.