Update README.md

This commit is contained in:
Stijn Bannink 2024-02-28 17:31:40 +00:00
parent d0e8346c35
commit b116dc6b8e

View file

@ -1,7 +1,44 @@
# VehiclesPlus # VehiclesPlus
This repository contains the example resourcepacks and vehicle configuration files for VehiclesPlus. Issues for the plugin can also be created in this repository. *Realistic custom vehicles for in your Minecraft server!*
* Please join our [Discord](https://discord.gg/R6ax6z2) server for support!
* The [v2 JavaDoc](https://sbdevelopment.tech/javadoc/vehiclesplus/index.html) and [v3 JavaDoc](https://sbdevelopment.tech/javadoc/vehiclesplus-v3/index.html) can both be found on our site. [![Version](https://img.shields.io/spiget/version/70523?label=version)](https://www.spigotmc.org/resources/vehiclesplus-1-12-1-20-4.70523/)
[![Downloads](https://img.shields.io/spiget/downloads/70523)](https://www.spigotmc.org/resources/vehiclesplus-1-12-1-20-4.70523/)
[![Rating](https://img.shields.io/spiget/stars/70523?color=orange)](https://www.spigotmc.org/resources/vehiclesplus-1-12-1-20-4.70523/)
## Installation
VehiclesPlus works on all Spigot/Paper versions from 1.12.x, **except 1.14.x**! Versions below 1.12.x are NOT and will NOT BE supported.
### 0. Check your Java version
VehiclesPlus requires __Java 11__ or higher to work! Check if your server works with Java 11 or higher (check your console at boot). Can't find the Java version? Ask your hosting.
### 1. Download the latest version
Download the latest stable version on SpigotMC or Polymart, depending on where you bought the plugin.
Put the .jar file into the `/plugins` folder of your server.
### 2. Download the dependencies
VehiclesPlus requires ProtocolLib, Vault and an economy manager (like EssentialsX) to work. Make sure you have them installed!
### 3. Download the example resourcepack
> ## ⚠ **VehiclesPlus requires an resourcepack!**<br>
> VehiclesPlus uses items to display the vehicles in your server. If you don't use the resourcepack, it's not possible to see the vehicles.
Download the correct example resourcepack for your Minecraft server. You can find [the correct version here](https://docs.sbdevelopment.tech/en/vehiclesplus/setup#resourcepack-download).
Install it into your Minecraft server ([follow the instructions](https://docs.sbdevelopment.tech/en/vehiclesplus/setup#using-our-example-pack-as-server-resourcepack)) or into your Minecraft client if you prefer to test it yourself.
> ### ⚠ **VehiclesPlus contains an EXAMPLE resourcepack!**<br>
> The plugin is designed to make it easy to create your own vehicles. We recommend making or buying your own vehicles to suit your server better.<br>
> If you want to buy one of the example vehicles included with the plugin, you can find them [here](https://polymart.org/team/sbdevelopment.93).
### 4. Restart your server
Restart your server using the Restart button. Do ***NOT*** reload, it will break the plugin!
### 5. Have fun!
The plugin is now installed into your Minecraft server! Have fun with testing the plugin and creating your own vehicles.
## Support
First check if [the Wiki](https://docs.sbdevelopment.tech/en/vehiclesplus/about) answer your question. Can't find the correct answer or need more help? You can contact us in [our Discord server](https://discord.gg/z26ZGrrFWB).
## License ## License
Please be advised that the materials contained within this repository are subject to the terms and conditions of the Creative Commons Attribution-NoDerivatives 4.0 International License (CC BY-ND 4.0). We kindly request that you review the `LICENSE.md` file, which provides further details regarding the applicable license. Please be advised that the materials contained within this repository are subject to the terms and conditions of the Creative Commons Attribution-NoDerivatives 4.0 International License (CC BY-ND 4.0). We kindly request that you review the `LICENSE.md` file, which provides further details regarding the applicable license.