SBDevelopment/docs
Archived
3
0
Fork 1
Code Activity

docs: update vehiclesplus/configuration/vehicles

Browse source
This commit is contained in:
Stijn Bannink 2024-04-07 10:08:34 +00:00 committed by SBDeveloper
parent 72b3308c72
commit c9ccbe9ef0
1 changed files with 94 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

115
vehiclesplus/configuration/vehicles.md
View file

@ -2,13 +2,105 @@
title: Vehicle Configuration
description: Configure the base vehicles.
published: true
date: 2024-04-07T09:53:33.571Z
date: 2024-04-07T10:08:30.685Z
tags:
editor: markdown
dateCreated: 2023-07-22T14:07:37.924Z
---
# Vehicle Configuration
By default, VehiclesPlus gets shipped with some example vehicles. These are made for testing the plugin and to stimulate your inspiration. You can find the correct resourcepack on the Setup page.
If you want to proceed with VehiclesPlus, it's possible to make or buy your own vehicles, and set them up in the plugin. This creates endless possibilities!
## Modifying an existing vehicle
The plugin comes with a standard vehicle per type (cars, motorcycles, boats, etc.).
- `bikes/ExampleBike.yml`
- `boats/ExampleBoat.yml`
- `cars/ExampleCar.yml`
- `helicopters/ExampleHelicopter.yml`
- `hovercrafts/ExampleHovercraft.yml`
- `planes/ExamplePlane.yml`
- `tanks/ExampleTank.yml`
The default files can be download from [the GitHub repository](https://github.com/SBDPlugins/VehiclesPlus/tree/master/Vehicle%20Models/Examples-v2).
## Creating a new vehicle
### Step 1: Resourcepack setup {.tabset}
The first step is to add the model to a resourcepack. This makes it possible to place the model on a vehicle.
#### YouTube tutorial (NL/BE)
You can find a step-by-step tutorial on YouTube by The BelgiumGames.
https://www.youtube.com/watch?v=5CbPg7ld7hw
#### Text tutorial (EN)
##### Step 1a: Purchase your models
The first step is to achieve the models you want to use. Make sure the models are delivered in a Minecraft-compatible `.json` file. This makes it super easy to install!
You can easily find VehiclesPlus-compatible models [on Polymart](https://vehicles.polymart.org/).
##### Step 1b: Changing the supported version
Open the `pack.mcmeta` file in the root folder. Change the `pack_format` to the correct number according to the table below. Then change the `game_version` to the default (latest) version you want to support.
| **Version:** | **`pack_format:`** |
|-----------------|--------------------|
| 1.12 - 1.12.2 | `3` |
| 1.13 - 1.14.4 | `4` |
| 1.15 - 1.16.1 | `5` |
| 1.16.2 - 1.16.5 | `6` |
| 1.17 - 1.17.1 | `7` |
| 1.18 - 1.18.2 | `8` |
| 1.19 - 1.19.2 | `9` |
| 1.19.3 | `12` |
| 1.19.4 | `13` |
| 1.20 - 1.20.1 | `15` |
| 1.20.2 | `18` |
| 1.20.3 - 1.20.4 | `22` |
##### Step 1c: Install the model files
Now its time to install the model's files inside the resourcepack. Most of the time, a `.json` file is included with your model. You can direclty put this file in the `assets/vp/models/item` folder.
If any textures files are included (most of the time, this is not the case), insert them into the `assets/vp/textures/item` folder.
##### Step 1d: Add the models to the correct item
VehiclesPlus uses an item to make the models visible. You can choose any item you want, by default the plugin uses the `leather_boots` for models.
Under the `overrides` section, add a line like this:
```json
"overrides": [
{ "predicate": {"custom_model_data":1}, "model": "vp:item/YOURMODEL"}
]
```
Replace `YOURMODEL` by the name of the `.json` file (excluding the extension!). Replace the `1` by the data number you want to assign. This must be unique for the `leather_boots` file. Remember this number for step 5.
##### Step 1e: Create a configuration file
Now go to your Minecraft server's files.
Copy the example configuration file from the VehiclesPlus plugin folder for the type of vehicle you want to add. If you don't have the original files in your plugin folder anymore, you can [find them here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/src/branch/master/Vehicle%20Models).
Rename the copied file to the name of your file. Then also change the name inside the file, like `name: MyCoolCar`
Now go to the skin section, and replace the meta section by this:
```yaml
list0:
className: me.legofreak107.vehiclesplus.vehicles.vehicles.objects.addons.skins.Skin
skin:
==: org.bukkit.inventory.ItemStack
v: 3337
# ONLY change the section below!
# Change the type to the correct item. Probably you used the LEATHER_BOOTS.
type: LEATHER_BOOTS
meta:
==: ItemMeta
meta-type: UNSPECIFIC
# Set the custom model data you chose in step 4.
custom-model-data: 1
```
## Settings per vehicle
This section explains which settings are available per vehicle.
*Per setting will be explained what it means as a comment (`#`).*
@ -279,24 +371,3 @@ The wheel parts represents the wheels of a vehicle. Wheels can rotate when steer
# DO NOT CHANGE
isCustomPlaced: false
```
## Modifying an existing vehicle
The plugin comes with a standard vehicle per type (cars, motorcycles, boats, etc.).
- `bikes/ExampleBike.yml`
- `boats/ExampleBoat.yml`
- `cars/ExampleCar.yml`
- `helicopters/ExampleHelicopter.yml`
- `hovercrafts/ExampleHovercraft.yml`
- `planes/ExamplePlane.yml`
- `tanks/ExampleTank.yml`
The default files can be download from [the GitHub repository](https://github.com/SBDPlugins/VehiclesPlus/tree/master/Vehicle%20Models/Examples-v2).
## Creating your own new vehicle
### Texturepack setup
The first step is to link the model to your resourcepack.
#### YouTube tutorial (NL/BE)
https://www.youtube.com/watch?v=5CbPg7ld7hw