[![MIT License](https://img.shields.io/badge/license-MIT-informational.svg)](./LICENSE) [![Join us on Discord](https://img.shields.io/discord/907277628816388106.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/RueJ6A59x2) [![Features](https://img.shields.io/badge/link-Features-informational.svg)](https://oddlama.github.io/vane/) [![Installation Guide](https://img.shields.io/badge/wiki-Installation-informational.svg)](https://github.com/oddlama/vane/wiki/Installation-Guide) [![FAQ](https://img.shields.io/badge/wiki-FAQ-informational.svg)](https://github.com/oddlama/vane/wiki/FAQ) # About vane Vane is a plugin-suite which provides many immersive and lore friendly additions to vanilla minecraft. It will run on any [PaperMC](https://papermc.io) based minecraft server. [**For a comprehensive feature overview, visit the official website.**](https://oddlama.github.io/vane/) - 🎆 Lore friendly and properly integrated immersive features. Vane augments the classic vanilla experience, and doesn't try to replace it. Generally, player's are not supposed to notice which features were introduced by vane. - 🚀 Countless quality-of-life, gameplay and system improvements - ⚙️ Fully-configurable. Disable or configure anything you dislike - 🛠️ Several carefully designed custom items -

Many custom enchantments for a selection of tools, including the elytra - 🌌 The best portals you can imagine. Expensive but worthwile for long distance travel. Supports all entities including minecarts! - 📜 A simple but powerful region system for grief protection - 🗺️ [BlueMap](https://bluemap.bluecolored.de/), [Dynmap](https://www.spigotmc.org/resources/dynmap%C2%AE.274/) and [Pl3xMap](https://github.com/BillyGalbreath/Pl3xMap) integration - [And a lot more!](https://oddlama.github.io/vane/) ## 📷 Gallery Visit the [**Gallery on Modrinth**](https://modrinth.com/mod/vane/gallery) to view a selection of features or refer to [**the official website**](https://oddlama.github.io/vane/) for a complete overview.

(And a whole lot more!) ## 📥 Installation ### [---> YOU NEED PROTOCOLLIB FROM HERE <---](https://ci.dmulloy2.net/job/ProtocolLib/) ^{_{If you are setting up a new server, check out our [Server Installer](https://oddlama.github.io/minecraft-server)
for an easy way to properly setup a minecraft server with vane, autostart, 3D online map, and more awesome features.}} Simply download the plugin zip file from here or from [GitHub](https://github.com/oddlama/vane/releases/latest) and extract the .jar files into the `plugins/` directory. Make sure that: - You are using the correct Paper (or Purpur) server version (compatible versions are listed in the title on the download page) - Make sure to use the latest version of [ProtocolLib](https://ci.dmulloy2.net/job/ProtocolLib/) from [-->HERE<--](https://ci.dmulloy2.net/job/ProtocolLib/) - Beware that `vane-waterfall`, `vane-velocity` and `vane-plexmap` (plexmap addon) are not classical server plugins! Use them only if you know what you are doing. For a comprehensive guide, visit the [Installation Guide](https://github.com/oddlama/vane/wiki/Installation-Guide) on the wiki. ## ❓ FAQ Please refer to the [FAQ](https://github.com/oddlama/vane/wiki/FAQ) in the wiki. ## ✅ Acknowledgements & 3rd-party software I would like to thank the following projects and people maintaining them: - [Spigot](https://www.spigotmc.org/) for the awesome baseline server software. - [PaperMC](https://papermc.io/) for the valuable additions missing from Spigot, and for Waterfall. - [ProtocolLib](https://github.com/dmulloy2/ProtocolLib) for the awesome protocol layer library. - [DynmapCoreAPI](https://github.com/webbukkit/DynmapCoreAPI) (Apache-2.0), dynmap integration - [BlueMapAPI](https://github.com/BlueMap-Minecraft/BlueMapAPI) (MIT), [BlueMap](https://bluemap.bluecolored.de/) integration - [Quark](https://quarkmod.net) (CC-BY-NC-SA 3.0) Assets and texts for the Slime Bucket #### Included software The following projects will be included in the compilation step: - [org.json](https://github.com/stleary/JSON-java) (MIT), Java json implementation - [SnakeYAML](https://bitbucket.org/snakeyaml/snakeyaml) (Apache-2.0), Java YAML 1.1 implementation - [ronmamo reflections](https://github.com/ronmamo/reflections) (WTFPL), Java reflection helper - [PacketWrapper](https://github.com/dmulloy2/PacketWrapper) (LGPL3), only specific parts are included - [bStats](https://bstats.org/) (LGPL3), plugin metrics