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
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,2 +1,12 @@
---
title: README
description:
published: true
date: 2024-02-16T20:10:10.773Z
tags:
editor: markdown
dateCreated: 2024-02-16T20:10:08.108Z
---
# SBDevelopment documentation
This repository contains the documentation of SBDevelopment. Check it out [here](https://docs.sbdevelopment.tech).

2
home.md
View file

@ -2,7 +2,7 @@
title: SBDevelopment Wiki
description: The wiki of SBDevelopment!
published: true
date: 2023-07-22T17:41:09.981Z
date: 2023-07-22T17:41:13.030Z
tags:
editor: markdown
dateCreated: 2023-02-16T21:10:28.455Z

4
themepark/about.md
View file

@ -2,10 +2,10 @@
title: About
description:
published: true
date: 2022-08-30T17:09:07.211Z
date: 2023-02-16T21:10:32.830Z
tags:
editor: markdown
dateCreated: 2022-08-28T14:44:05.052Z
dateCreated: 2023-02-16T21:10:31.111Z
---
# What is the ThemePark series?

2
themepark/setup.md
View file

@ -2,7 +2,7 @@
title: Setup
description: Setup of the ThemePark package.
published: true
date: 2023-07-22T18:04:03.923Z
date: 2023-07-22T18:04:07.217Z
tags: themepark
editor: markdown
dateCreated: 2023-02-16T21:10:33.614Z

4
themepark/setup/linux.md
View file

@ -2,10 +2,10 @@
title: VPS running Linux.
description: Setup of ThemeParkPanel if using a VPS running Linux.
published: true
date: 2022-08-28T19:14:05.111Z
date: 2023-02-16T21:10:48.624Z
tags:
editor: markdown
dateCreated: 2022-08-28T19:14:05.111Z
dateCreated: 2023-02-16T21:10:46.768Z
---
# VPS running Linux

4
themepark/setup/shared.md
View file

@ -2,10 +2,10 @@
title: Shared webhosting
description: Install ThemeParkPanel on shared webhosting.
published: true
date: 2022-08-28T18:48:21.838Z
date: 2023-02-16T21:10:51.324Z
tags:
editor: markdown
dateCreated: 2022-08-28T18:04:31.507Z
dateCreated: 2023-02-16T21:10:49.481Z
---
# Shared Webhosting

4
themepark/usage.md
View file

@ -2,10 +2,10 @@
title: Usage
description: Information about the usage of the ThemePark plugins
published: true
date: 2022-11-11T19:24:44.053Z
date: 2023-02-16T21:10:38.117Z
tags:
editor: markdown
dateCreated: 2022-11-11T19:17:53.986Z
dateCreated: 2023-02-16T21:10:36.262Z
---
# ThemePark

4
vehiclesplus-v3/customization/vehiclemodel.md
View file

@ -2,10 +2,10 @@
title: Creating a VehicleModel
description: This page describes how to create a custom VehicleModel
published: true
date: 2023-01-25T19:43:44.275Z
date: 2023-02-16T21:10:54.035Z
tags:
editor: markdown
dateCreated: 2023-01-25T19:35:38.907Z
dateCreated: 2023-02-16T21:10:52.165Z
---
# Creating a VehicleModel

2
vehiclesplus-v3/setup.md
View file

@ -2,7 +2,7 @@
title: Setup
description:
published: true
date: 2024-02-18T19:15:10.681Z
date: 2024-08-17T19:52:13.034Z
tags:
editor: markdown
dateCreated: 2023-02-16T21:10:44.132Z

6
vehiclesplus/about.md
View file

@ -2,7 +2,7 @@
title: About
description: Information about VehiclesPlus
published: true
date: 2024-04-07T10:53:24.755Z
date: 2024-12-01T17:51:02.401Z
tags:
editor: markdown
dateCreated: 2023-02-16T21:10:38.912Z
@ -11,9 +11,7 @@ dateCreated: 2023-02-16T21:10:38.912Z
# VehiclesPlus
*Realistic custom vehicles for your Minecraft server!*
[![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/)
[![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/)
## What is VehiclesPlus?
VehiclesPlus is a plugin adding realistic vehicles to your Minecraft server. It support Cars, Planes, Bikes, Hovercrafts, Boats, Tanks and Helicopters. It's also possible to add your own types!

2
vehiclesplus/configuration.md
View file

@ -2,7 +2,7 @@
title: Configuration
description: Configuration of VehiclesPlus
published: true
date: 2023-07-22T14:14:45.134Z
date: 2023-07-22T14:14:48.181Z
tags:
editor: markdown
dateCreated: 2023-07-22T09:04:36.338Z

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 (`#`).*

58
vehiclesplus/setup.md
View file

@ -2,41 +2,33 @@
title: Setup
description: Instructions for the setup of VehiclesPlus.
published: true
date: 2024-04-07T10:58:30.366Z
date: 2024-12-01T18:10:14.729Z
tags:
editor: markdown
dateCreated: 2023-02-16T21:10:41.502Z
---
# Plugin installation
**Supported Versions:** VehiclesPlus works on all Spigot/Paper versions from 1.12.x, **except 1.14.x**!
# Setup
### Step 1: Check your Java version
This plugin explains the steps to take to start using VehiclesPlus.
VehiclesPlus requires **Java 11** or higher. Make sure your server is compatible with Java 11 or higher.
## Installation
### Step 2: Download the latest version
Download the latest stable version from [SpigotMC](https://www.spigotmc.org/resources/vehiclesplus-1-12-1-20-4.70523/) or [Polymart](https://polymart.org/resource/vehiclesplus-1-12-1-20-4.633).
Put the .jar file into the `/plugins` folder of your server.
### Step 3: Download the dependencies
> VehiclesPlus **requires** additional plugins to work correctly. The plugin __WON'T LOAD__ without them.
> - The plugin works on all Spigot/Paper versions starting from 1.12.x, **except for 1.14.x**!
> - The plugin requires **Java 11 or higher**. Make sure your server is compatible with Java 11 or higher.
> - **Make sure you have installed [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/), [Vault](https://www.spigotmc.org/resources/vault.34315/) and an economy plugin (like [EssentialsX](https://essentialsx.net/downloads.html)).**
>
> Make sure to check these requirements before you proceed!
{.is-warning}
VehiclesPlus requires [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/), [Vault](https://www.spigotmc.org/resources/vault.34315/) and an economy plugin (like [EssentialsX](https://essentialsx.net/downloads.html)) to work. Make sure you have them installed!
### Step 4: Download the example resourcepack
> 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.**
{.is-info}
Download the correct resourcepack for your Minecraft version and test it out in your Minecraft client.
If you are satisfied, you can install it into your Minecraft server:
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=`.
1. Download the latest stable version from [SpigotMC](https://www.spigotmc.org/resources/vehiclesplus-1-12-1-20-4.70523/) or [Polymart](https://polymart.org/resource/vehiclesplus-1-12-1-20-4.633).
2. Put the .jar file into the `/plugins` folder of your server.
3. Restart your server.
3. Download the correct resourcepack for your Minecraft version below and test it out in your Minecraft client.
4. If you are satisfied, you can install it into your Minecraft server:
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=`.
| Version | Download | SHA1 Hash |
|:---:|:---:|---|
@ -55,14 +47,12 @@ If you are satisfied, you can install it into your Minecraft server:
| 1.20.5 - 1.20.6 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v2/VPExample-v2-1.20.5-1.20.6.zip) | `28cba204318a7f985a12239aece1e8e8f236f619` |
| 1.21 - 1.21.1 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v2/VPExample-v2-1.21-1.21.1.zip) | `28fae42b8eca5bcb6cf58d245db88ae3a1402b4b` |
> **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).
> {.is-warning}
## Adding your own vehicles
### 4. Restart your server
- **Do you already have some vehicle models to use**, or do you want to design your own models? Check out [the usage page](/en/vehiclesplus/configuration/vehicles) for more information about that.
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.
- **Do you want to buy pre-made vehicle models for your server**? Check out our recommended sellers below:
- [SBDevelopment official models](https://polymart.org/team/sbdevelopment.93): These models are made for VehiclesPlus and allow you to use all the functionalities the plugin has.
- [Saturn Studio](https://polymart.org/user/saturnstudio.235): Sells a lot of vehicles, like Tesla and Emergency Services. Also has configurations available on request.
- [MKModels](https://polymart.org/user/melchmwoan.2244): Has different types of cheap vehicles available. Configurations are not included.
- [PixelMine](https://polymart.org/user/pixelmine.728): Has a big collection of cars and other vehicles. Configurations are not included by default.