From 3536676ea650a3c94b0fd1c55ec64f892efe5df9 Mon Sep 17 00:00:00 2001 From: Administrator Date: Fri, 20 Dec 2024 19:13:45 +0000 Subject: [PATCH] docs: update vehiclesplus-v3/setup --- vehiclesplus-v3/setup.md | 58 +++++++++++++++++++++++++++++++++------- 1 file changed, 48 insertions(+), 10 deletions(-) diff --git a/vehiclesplus-v3/setup.md b/vehiclesplus-v3/setup.md index 39c6cbe..2a644dd 100644 --- a/vehiclesplus-v3/setup.md +++ b/vehiclesplus-v3/setup.md @@ -2,20 +2,34 @@ title: Setup description: published: true -date: 2024-08-17T19:52:13.034Z +date: 2024-12-20T19:13:43.224Z tags: editor: markdown dateCreated: 2023-02-16T21:10:44.132Z --- -# Plugin installation -1. Make sure you have [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) installed. Optionally also install [Vault](https://dev.bukkit.org/projects/vault) and an economy manager (like [EssentialsX](https://essentialsx.net/downloads.html)) to use economy. -2. Download the plugin on [Spigot](https://www.spigotmc.org/resources/50-off-vehiclesplus-1-12-1-19.70523/) or [Polymart](https://polymart.org/resource/vehiclesplus-1-12-1-19.633) +# Getting Started with VehiclesPlus + +Welcome to VehiclesPlus! This guide will walk you through installing the plugin, setting up the resource pack, and getting started with your first vehicle. + +--- +## Step 1: Plugin Installation + +To use VehiclesPlus, follow these steps to install the plugin: + +1. If you want to use the plugin's economy features, make sure you have installed [Vault](https://dev.bukkit.org/projects/vault) and an economy manager like [EssentialsX](https://essentialsx.net/downloads.html). +2. Download the plugin on [Spigot](https://www.spigotmc.org/resources/vehiclesplus-1-13-1-21.70523/) or [Polymart](https://polymart.org/resource/vehiclesplus-1-12-1-20-2.633) 3. Put the JAR file into your `/plugins` folder. 4. Restart your server. -# Resourcepack download -We provide an **example** resourcepack to use with our plugin (and the provided example vehicles). We recommend creating your own resourcepack, so that you can add more custom vehicles. +To verify the installation: +- Run `/plugins` in your server console or in-game to confirm that VehiclesPlus is loaded (it must be green). + +--- + +## Step 2: Resourcepack Download + +VehiclesPlus requires a resource pack for vehicles to display properly. We provide an **example resource pack** for your convenience, but we recommend creating your own to support custom vehicles and models. | Version | Download | SHA1 Hash | |:---:|:---:|---| @@ -35,9 +49,33 @@ We provide an **example** resourcepack to use with our plugin (and the provided | 1.21.2 - 1.21.3 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.21.2-1.21.3.zip) | `d415719b803bb35dd12e35389fb44f85c51df4f9` | | 1.21.4 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.21.4.zip) | `14e92415fc14dd56cd209a486c555efe8d0529a3` | -## Using our example pack as server resourcepack +### Using the Example Pack as a Server Resource Pack: It's also possible to use our example pack as your server resourcepack. -1. Open the `server.properties` file. -2. Copy the link of the [Click here](#) button for your server version and paste it after `resource-pack=`. -3. Copy the SHA1 hash for your server version and paste it after `resource-pack-sha1=`. \ No newline at end of file +**You can configure your server to use our example resource pack automatically:** +1. Open your `server.properties` file. +2. Copy the resource pack link for your version from the table above and paste it after `resource-pack=` in the file. +3. Copy the SHA1 hash for your version and paste it after `resource-pack-sha1=`. + +Example: +```properties +resource-pack=https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.20.2.zip +resource-pack-sha1=da570a8a150a25706c0a885ac34fe4effa64f268 +``` + +Save the file and restart your server. + +## Step 3: Spawning Your First Vehicle + +Once the plugin and resource pack are installed, you're ready to spawn your first vehicle: + +1. **Give yourself a vehicle** + Use the `/v give [red] [green] [blue]` command to obtain a vehicle. Example: `/v give SBDevelopment ExampleCar` + +2. **Place the Vehicle** + Open the garage using `/vgarage` and left click the vehicle in the garage menu to spawn it. + +3. **Drive the Vehicle** + - Enter the vehicle by right-clicking on a seat. + - Use shift right-click to open the vehicle menu. + - Use your movement keys (WASD) when in a driver seat to drive. \ No newline at end of file