dector / vane

Immersive and lore friendly enhancements for vanilla Minecraft

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MIT License Join us on Discord Features Installation Guide 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 based minecraft server.

For a comprehensive feature overview, visit the official website.

  • 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 and Dynmap integration
  • And a lot more!

Installation

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

Otherwise, simply 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 also need the newest version of ProtocolLib.

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

Installation (vane-waterfall)

Download vane-waterfall.jar into the proxy server's plugins/ directory. The configuration will be generated on first start.

To enable the authentication multiplexing, you need to do the following:

  1. Define multiple listeners (distinct ports) for your servers in the proxy's config.yml.
  2. Map these ports to multiplexer ids in plugins/vane-waterfall/config.yml. The specific multiplexer ids must be >0. Other than that the ids are only important to check player permissions.
  3. Assign the corresponding permission(s) vane_waterfall.auth_multiplexer.<multiplexer_id> to the desired group in the proxy's config.yml.
  4. Assign the group to a player using the players' UUID. THIS IS IMPORTANT and won't work with player names.

Optionally, you can configure the second configuration section in plugins/vane-waterfall/config.yml to allow automatic server start. An example is provided in the config file.

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 software packets will be included in the compilation step:

About

Immersive and lore friendly enhancements for vanilla Minecraft

License:MIT License


Languages

Language:Java 98.9%Language:Kotlin 0.8%Language:Python 0.2%Language:Shell 0.2%