SBDevelopment/docs
Archived
3
0
Fork 1
Code Activity

docs: add all untracked content

Browse source
This commit is contained in:
Stijn Bannink 2024-12-01 18:21:22 +00:00
parent 035cfeb7db
commit dfd4986a60
15 changed files with 79 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

2
vehiclesplus/configuration/plugin.md
View file

@ -2,7 +2,7 @@
title: Plugin Configuration
description: Configure the VehiclesPlus plugin.
published: true
date: 2024-02-18T18:45:36.995Z
date: 2024-02-18T18:45:39.664Z
tags:
editor: markdown
dateCreated: 2023-07-22T09:20:23.417Z

2
vehiclesplus/configuration/sounds.md
View file

@ -2,7 +2,7 @@
title: Sounds Configuration
description: Change the sounds of a base vehicle.
published: true
date: 2023-07-22T13:05:32.455Z
date: 2023-07-22T13:05:35.416Z
tags:
editor: markdown
dateCreated: 2023-07-22T13:05:32.455Z

69
vehiclesplus/configuration/vehicles.md
View file

@ -2,7 +2,7 @@
title: Vehicle Configuration
description: Configure the base vehicles.
published: true
date: 2024-04-14T18:25:52.348Z
date: 2024-10-13T18:34:34.478Z
tags:
editor: markdown
dateCreated: 2023-07-22T14:07:37.924Z
@ -15,10 +15,6 @@ If you want to proceed with VehiclesPlus, it's possible to make or buy your own
## Creating a new vehicle
### Tabs {.tabset}
#### YouTube tutorial (NL/BE)
You can find a step-by-step tutorial on YouTube by The BelgiumGames. He explains how to add the models to the resourepack and how to setup the vehicles in the config file.
https://www.youtube.com/watch?v=5CbPg7ld7hw
#### Text tutorial (EN)
##### Step 1: 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!
@ -26,46 +22,27 @@ The first step is to achieve the models you want to use. Make sure the models ar
> You can easily find VehiclesPlus-compatible models [on Polymart](https://vehicles.polymart.org/).
{.is-info}
##### Step 2: Download the empty tutorial resourcepack
> Do you already have a resourcepack for your server? Then **skip** this step.
##### Step 2: Generate the resourcepack
**Generate the resourcepack for your server using the [VehiclesPlus Resourcepack Generator tool](https://vprpgenerator.sbdevelopment.tech/).**
Just fill in your Minecraft version, choose a Namespace (leave it at `vp` to be safe) and select an Item you want to insert the models on.
Then easily upload all the models you want to add to your resourcepack and click on the **Generate** button.
> **NOTE:** The tool overwrites the item configuration for the selected item. Please select an item that you currently do not use in the case you upload your own resourcepack.
{.is-warning}
To get started, you must [download the empty tutorial resourcepack](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/releases/download/v1.0/VP-Tutorial-RP-v1.0.zip). Unzip the ZIP file so that you can easily add new files.
##### Step 3: Changing the supported version
Open the `pack.mcmeta` file. 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.
| 1.12 - 1.12.2 | 1.13 - 1.14.4 | 1.15 - 1.16.1 | 1.16.2 - 1.16.5 | 1.17 - 1.17.1 | 1.18 - 1.18.2 | 1.19 - 1.19.2 | 1.19.3 | 1.19.4 | 1.20 - 1.20.2 | 1.20.2 - 1.20.4 |
|:-------------:|:-------------:|:-------------:|:---------------:|:-------------:|:-------------:|:-------------:|:------:|:------:|:-------------:|:---------------:|
| `3` | `4` | `5` | `6` | `7` | `8` | `9` | `12` | `13` | `15` | `18` |
###### Step 4: 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 directly 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 5: 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.
The easist way to generate the file for an item is using the [Model File Generator](https://vpmodelfiletool.sbdevelopment.tech/). Just enter the name of the model files and download the file.
> **Example:** If you put the `ferrari_roma.json` file in the `assets/vp/models/item` folder, leave the Namespace as `vp` and use `ferrari_roma` as the model name.
>
> ![image.png](/image.png)
{.is-info}
###### Step 6: ZIP the contents
Now your resourcepack is ready! Zip the `assets` folder and the `pack.mcmeta` to one ZIP file and install it inside your Minecraft client to test it out.
###### Step 7: Create a configuration file
###### Step 3: 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).
Copy the example configuration file from the VehiclesPlus plugin folder for the type of vehicle you want to add **(for example `cars/ExampleCar.yml`)**. If you don't have the original example 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`
Rename the copied file to the name of your vehicle (for example from `ExampleCar.yml` to `MyCoolCar.yml`). Also make sure to change the name inside the file, like `name: MyCoolCar`
Now go to the skin section, and change the values to the once given by the generator.
**Example:** If your model is called MyCoolCar and has been bound to `custom_model_data: 2` change the value under `meta` to `2`.
Now go to the skin section, and change the settings to the onces you chose before.
**PLEASE NOTE: Do *NOT* copy/paste!** Only change the `type` and `meta` sections.
```yaml
list0:
className: me.legofreak107.vehiclesplus.vehicles.vehicles.objects.addons.skins.Skin
@ -79,12 +56,20 @@ list0:
custom-model-data: 1
```
###### Step 8: Change other settings
Now it's time to change the other settings to match your vehicle. Check the "Settings per vehicle" section below to see what each setting does.
> **NOTE:** Do *NOT* copy/paste this configuration part! Only change the `type` and `meta` sections according to your situation.
{.is-warning}
> This step might take some time. You need to change the settings, reload your server and see if everything is working as expected. You might need to tinker some settings multiple times.
###### Step 4: Change other settings
Now it's time to change the other settings to match your vehicle. Check the "Settings per vehicle" section below to see what each section means.
> This step might take some time. You need to change the settings, restart your server and see if everything is working as expected. You might need to tinker some settings multiple times.
>
> **NOTE: You have to give yourself a new vehicle to see the changes you made!**
{.is-info}
#### YouTube tutorial (NL/BE)
You can find a step-by-step tutorial on YouTube by The BelgiumGames. He explains how to add the models to the resourepack and how to setup the vehicles in the config file.
https://www.youtube.com/watch?v=5CbPg7ld7hw
## Settings per vehicle
This section explains which settings are available per vehicle.
*Per setting will be explained what it means as a comment (`#`).*