oddlama / vane

Immersive and lore friendly enhancements for vanilla Minecraft
MIT License
272 stars 33 forks source link
minecraft minecraft-plugin paper papermc plugin vane velocity-plugin

[![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 that provides many immersive and lore-friendly additions to vanilla minecraft. It will run on any PaperMC based minecraft server.

For a comprehensive feature overview, visit the official website.

📷 Gallery

Visit the Gallery on Modrinth to view a selection of features or refer to the official website for a complete overview.

(And a lot more!)

📥 Installation

If you are setting up a new server, check out our Server Installer for an easy way to properly set up a minecraft server with vane, autostart, 3D online map, and more awesome features.

Download all desired jars files from the Releases and put them into the plugins/ directory. Grab the all-plugins.zip if you don't want to download each file by hand. You can also download vane from Modrinth. Make sure that:

For a comprehensive guide, visit the Installation Guide on the wiki.

Proxy Installation (vane-velocity)

Download vane-velocity.jar and place it in the velocity proxy server's plugins/ directory. The configuration will be generated on first start. All configuration is handled in the plugin's config.toml.

There are permissions players will need to perform certain actions, such as starting offline servers and joining servers in maintenance mode. Permissions can be handled by any external permissions plugin, such as LuckPerms.

Building from source

You can, of course, build the plugin yourself. To do that, you need at least JDK 17.

  1. Execute ./gradlew build
  2. All resulting jar files that can be used on a server will be in target/.

If you experience "peer not authenticated" issues from Gradle, just retry. Seems to be a skittish integration between Gradle and Maven repositories.

FAQ

Please refer to the FAQ in the wiki.

Acknowledgements & 3rd-party software

I would like to thank the following projects and people maintaining them:

Included software

The following projects will be included in the compilation step: