Converted all v3 docs made for now
This commit is contained in:
parent
991f915665
commit
630dcbe7d3
GPG key ID:
B730712F2C3A9D7A
14 changed files with 701 additions and 110 deletions
24
vehiclesplus-v3/about.md
Normal file
24
vehiclesplus-v3/about.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: About
|
||||
---
|
||||
|
||||
# VehiclesPlus
|
||||
|
||||
*Realistic custom vehicles for your Minecraft server!*
|
||||
|
||||
[](https://www.spigotmc.org/resources/vehiclesplus-1-12-1-20-4.70523/) [](https://www.spigotmc.org/resources/vehiclesplus-1-12-1-20-4.70523/) [](https://www.spigotmc.org/resources/vehiclesplus-1-12-1-20-4.70523/)
|
||||
|
||||
## About
|
||||
|
||||
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!
|
||||
|
||||
## Installation
|
||||
|
||||
Follow [the installation instructions on the Setup page](setup).
|
||||
|
||||
## Support
|
||||
|
||||
Can't find the correct answer on our wiki or need more help? You can contact us
|
||||
in [our Discord server](https://discord.gg/z26ZGrrFWB).
|
||||
4
vehiclesplus-v3/api/_category_.json
Normal file
4
vehiclesplus-v3/api/_category_.json
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"position": 5,
|
||||
"label": "API"
|
||||
}
|
||||
148
vehiclesplus-v3/api/examples.md
Normal file
148
vehiclesplus-v3/api/examples.md
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
---
|
||||
sidebar_label: Examples
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# API Examples
|
||||
|
||||
In this section, you'll find additional examples of how to use the VehiclesPlus API (v3) for various tasks.
|
||||
|
||||
## Example 1: Adding a Car to Someone's Garage
|
||||
|
||||
```java
|
||||
// Give car to garage
|
||||
public void giveCar(Garage garage, String vehicleType) {
|
||||
// Attempt to create a vehicle
|
||||
StorageVehicle vehicle = VehiclesPlusAPI.createVehicle(vehicleType);
|
||||
|
||||
if (vehicle == null) {
|
||||
System.err.println("Failed to create vehicle of type: " + vehicleType);
|
||||
return; // Exit if the vehicle could not be created
|
||||
}
|
||||
|
||||
// Add the vehicle's UUID to the garage
|
||||
garage.addVehicle(vehicle.getUuid());
|
||||
System.out.println("Vehicle created and added to the garage successfully.");
|
||||
}
|
||||
```
|
||||
|
||||
## Example 2: Adding a Vehicle to the Player's Default Garage
|
||||
|
||||
```java
|
||||
// Give car to player's default garage
|
||||
public void giveCar(Player player, String vehicleType) {
|
||||
// Attempt to create a vehicle
|
||||
StorageVehicle vehicle = VehiclesPlusAPI.createVehicle(vehicleType);
|
||||
|
||||
// Retrieve the player's default garage
|
||||
Optional<Garage> optionalGarage = VehiclesPlusAPI.getGarage(player.getName());
|
||||
|
||||
if (vehicle == null) {
|
||||
System.err.println("Failed to create vehicle of type: " + vehicleType);
|
||||
return; // Exit if the vehicle could not be created
|
||||
}
|
||||
|
||||
if (optionalGarage.isPresent()) {
|
||||
Garage garage = optionalGarage.get();
|
||||
garage.addVehicle(vehicle.getUuid());
|
||||
System.out.println("Vehicle created and added to the garage successfully.");
|
||||
} else {
|
||||
System.err.println("Garage not found for player: " + player.getName());
|
||||
// Optionally, you could create a new garage for the player here if the API allows it.
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example 3: Despawning the First Vehicle of a Player
|
||||
|
||||
```java
|
||||
public void despawnFirstVehicle(Player player) {
|
||||
// Retrieve the first spawned vehicle of the player
|
||||
Optional<SpawnedVehicle> firstSpawnedVehicleOptional = VehiclesPlusAPI.getVehicle(player);
|
||||
|
||||
// Check if a vehicle is present to despawn
|
||||
if (firstSpawnedVehicleOptional.isPresent()) {
|
||||
// Despawn the vehicle using the API's despawn reason
|
||||
firstSpawnedVehicleOptional.get().despawn(VehicleDespawnEvent.DespawnReason.API);
|
||||
System.out.println("Vehicle despawned successfully.");
|
||||
} else {
|
||||
// Handle the case where the player doesn't have a spawned vehicle
|
||||
System.err.println("Player does not have a spawned vehicle.");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example 4: Despawning the Closest Vehicle to a Player
|
||||
|
||||
```java
|
||||
public void despawnClosestVehicle(Player executor, Player targetPlayer) {
|
||||
// Retrieve a list of all spawned vehicles belonging to the target player
|
||||
@NotNull List<Vehicle> vehiclesOfTargetPlayer = VehiclesPlusAPI.getVehicles(targetPlayer);
|
||||
|
||||
// Find the closest spawned vehicle to the executor player
|
||||
Optional<SpawnedVehicle> closestVehicleOptional = vehiclesOfTargetPlayer.stream()
|
||||
.filter(vehicle -> vehicle instanceof SpawnedVehicle) // Only consider spawned vehicles
|
||||
.map(vehicle -> (SpawnedVehicle) vehicle)
|
||||
.min(Comparator.comparingDouble(vehicle -> vehicle.getHolder().getLocation().distance(executor.getLocation())));
|
||||
|
||||
// Check if the closest vehicle was found
|
||||
if (closestVehicleOptional.isPresent()) {
|
||||
// Despawn the closest vehicle using the API's despawn reason
|
||||
closestVehicleOptional.get().despawn(VehicleDespawnEvent.DespawnReason.API);
|
||||
System.out.println("Closest vehicle despawned successfully.");
|
||||
} else {
|
||||
// Handle the case where no spawned vehicles are found for the target player
|
||||
System.err.println("Target player does not have any spawned vehicles.");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example 5: Removing a Vehicle from the Police Garage
|
||||
|
||||
```java
|
||||
public void removeVehicleFromPoliceGarage(String vehicleModelName) {
|
||||
// Retrieve the "police" garage using its name
|
||||
Optional<Garage> policeGarageOptional = VehiclesPlusAPI.getGarage("police");
|
||||
|
||||
// Check if the police garage exists, and if not, print an error message and exit
|
||||
if (policeGarageOptional.isEmpty()) {
|
||||
System.err.println("Error: The 'police' garage does not exist.");
|
||||
return;
|
||||
}
|
||||
|
||||
// Get the actual garage object
|
||||
Garage policeGarage = policeGarageOptional.get();
|
||||
|
||||
// Search for the vehicle with the given model name within the "police" garage
|
||||
Optional<Vehicle> vehicleToRemoveOptional = policeGarage.getVehicles().stream()
|
||||
// Convert the vehicle UUID to an actual StorageVehicle object
|
||||
.map(VehiclesPlusAPI::getVehicle)
|
||||
// Filter vehicles to match the given model name
|
||||
.filter(vehicle -> vehicle != null && vehicle.getVehicleModel().getId().equals(vehicleModelName))
|
||||
// Select the first match
|
||||
.findFirst();
|
||||
|
||||
// If a matching vehicle is found, attempt to remove it
|
||||
if (vehicleToRemoveOptional.isPresent()) {
|
||||
Vehicle vehicleToRemove = vehicleToRemoveOptional.get();
|
||||
|
||||
try {
|
||||
// Remove the vehicle from the garage
|
||||
vehicleToRemove.remove();
|
||||
System.out.println("Vehicle with model '" + vehicleModelName + "' has been successfully removed from the police garage.");
|
||||
} catch (DataStorageException e) {
|
||||
// Handle any errors that occur during the removal process
|
||||
System.err.println("Error: Failed to remove vehicle with model '" + vehicleModelName + "' from the garage.");
|
||||
throw new RuntimeException("Error while removing vehicle", e);
|
||||
}
|
||||
} else {
|
||||
// If no matching vehicle was found, print an error message
|
||||
System.err.println("Error: No vehicle with model '" + vehicleModelName + "' found in the police garage.");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## More Examples
|
||||
|
||||
For additional usage examples, please visit
|
||||
the [VehiclesPlus API Examples on GitHub](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus-v3-API-example).
|
||||
67
vehiclesplus-v3/api/gettingstarted.md
Normal file
67
vehiclesplus-v3/api/gettingstarted.md
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
---
|
||||
sidebar_label: Usage
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# API Usage
|
||||
|
||||
This guide explains how to integrate the new and improved VehiclesPlus API (v3) into your project.
|
||||
|
||||
## Adding VehiclesPlus to Your Project
|
||||
|
||||
To use the VehiclesPlus API in your plugin, follow these steps:
|
||||
|
||||
### Step 1: Add VehiclesPlus to Your Dependencies
|
||||
|
||||
Ensure VehiclesPlus is added as a dependency in your project. To always use the latest version, update your dependency
|
||||
configuration as shown below:
|
||||
|
||||
Maven (`pom.xml`):
|
||||
|
||||
```xml
|
||||
<!-- Append to the <repositories> section -->
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>sbdevelopment-repo</id>
|
||||
<url>https://repo.sbdevelopment.tech/releases</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
|
||||
<!-- Append to the <dependencies> section -->
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>tech.sbdevelopment</groupId>
|
||||
<artifactId>vehiclesplus</artifactId>
|
||||
<version>latest</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
|
||||
Gradle (`build.gradle`):
|
||||
|
||||
```gradle
|
||||
repositories {
|
||||
maven {
|
||||
url 'https://repo.sbdevelopment.tech/releases'
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation 'tech.sbdevelopment:vehiclesplus:latest'
|
||||
}
|
||||
```
|
||||
|
||||
:::info
|
||||
**Note**: Using `latest` ensures that your project always fetches the most recent release, but it might cause issues if
|
||||
breaking changes are introduced. For more stability, consider specifying a specific version (e.g., `3.0.2`).
|
||||
:::
|
||||
|
||||
## Examples
|
||||
|
||||
For usage examples, please visit
|
||||
the [VehiclesPlus Examples Page](https://docs.sbdevelopment.tech/en/vehiclesplus-v3/api/examples).
|
||||
|
||||
## API Documentation
|
||||
|
||||
For additional details and advanced usage refer to the
|
||||
official [VehiclesPlus Javadoc](https://sbdevelopment.tech/javadoc/vehiclesplus-v3/index.html).
|
||||
87
vehiclesplus-v3/setup.md
Normal file
87
vehiclesplus-v3/setup.md
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Setup
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
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 |
|
||||
|:---------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------|
|
||||
| 1.13.2 - 1.14.4 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.13.2-1.14.4.zip) | `b61d1c370b3768cf966b80c6bfb66f905cb37b8a` |
|
||||
| 1.15.2 - 1.16.1 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.15.2-1.16.1.zip) | `6f25bca11dfb736310fd408a901fc763f87c0b95` |
|
||||
| 1.16.2 - 1.16.5 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.16.2-1.16.5.zip) | `1f0914aa530f5b8de4c64e0d771d1bf4f1694718` |
|
||||
| 1.17 - 1.17.1 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.17-1.17.1.zip) | `c294db880a9ebc197e56586f1fe4192fcea56f43` |
|
||||
| 1.18 - 1.18.2 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.18-1.18.2.zip) | `8e4d4ce39335f762853f7c72e538fbf380c491d8` |
|
||||
| 1.19 - 1.19.2 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.19-1.19.2.zip) | `7aec2e0c56633627f8f1e1d18f01afddf7879388` |
|
||||
| 1.19.3 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.19.3.zip) | `dc8450aae3e75854103c61387f7c56c2ead010e1` |
|
||||
| 1.19.4 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.19.4.zip) | `fe044f3bb4bff8af8fc6f73963acd7d734adf8a8` |
|
||||
| 1.20 - 1.20.1 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.20-1.20.1.zip) | `8c75d9fa52c1ed1ca12cd70b051432625c807dc1` |
|
||||
| 1.20.2 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.20.2.zip) | `da570a8a150a25706c0a885ac34fe4effa64f268` |
|
||||
| 1.20.3 - 1.20.4 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.20.3-1.20.4.zip) | `af9afb8611106d0688033ce018bbad16cf6d92f9` |
|
||||
| 1.20.5 - 1.20.6 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.20.5-1.20.6.zip) | `e137d76255f05773be8fae962836b8ac24814121` |
|
||||
| 1.21 - 1.21.1 | [Click here](https://git.sbdevelopment.tech/SBDevelopment/VehiclesPlus/raw/branch/master/ResourcePacks/Examples-v3/VPExample-v3-1.21-1.21.1.zip) | `b08e6268d89c765df3403f2f1b34e0a724422f6c` |
|
||||
| 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 the Example Pack as a Server Resource Pack:
|
||||
|
||||
It's also possible to use our example pack as your server resourcepack.
|
||||
|
||||
**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 <player> <vehicle> [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.
|
||||
4
vehiclesplus-v3/types/_category_.json
Normal file
4
vehiclesplus-v3/types/_category_.json
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"position": 4,
|
||||
"label": "Types"
|
||||
}
|
||||
146
vehiclesplus-v3/types/cars.md
Normal file
146
vehiclesplus-v3/types/cars.md
Normal file
|
|
@ -0,0 +1,146 @@
|
|||
---
|
||||
sidebar_label: Cars
|
||||
---
|
||||
|
||||
# Cars
|
||||
|
||||
Cars are the most common and versatile vehicles in VehiclesPlus. They are ideal for quick transportation, racing events,
|
||||
and roleplay scenarios. This page will guide you through how cars work, the parts they use, and how to add custom cars
|
||||
to your server.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ How Cars Work
|
||||
|
||||
Cars in VehiclesPlus are powered by a fuel system (if enabled) and are controlled through simple mechanics:
|
||||
|
||||
1. **Driving:** Use the movement keys (WASD by default) to drive.
|
||||
2. **Fuel System:** Cars require fuel to run if the fuel system is enabled. See the [Fuel](../fuel/basics.md) page for
|
||||
details.
|
||||
3. **Passenger Seats:** Depending on the car's model, you can allow additional players to ride as passengers.
|
||||
|
||||
---
|
||||
|
||||
## 🔩 Available Parts for Cars
|
||||
|
||||
Cars can be customized with several parts to change their appearance and functionality:
|
||||
|
||||
### 1. **Skins**
|
||||
|
||||
- Skins represent the body of your vehicle.
|
||||
They determine how your vehicle looks and are applied to the armor stand representing the vehicle.
|
||||
You can fully customize the skin of your vehicle, including its appearance, position, rotation, and more.
|
||||
|
||||
**Here is an example of a Skin configuration with explanation:**
|
||||
|
||||
```json
|
||||
{
|
||||
# The type of part (should always be "skin" for vehicle bodies)
|
||||
type: skin
|
||||
|
||||
# Position offsets relative to the vehicle's spawn point (steps of 0.1 allowed)
|
||||
xoffset: 0 # Horizontal offset
|
||||
yoffset: 0 # Vertical offset
|
||||
zoffset: 0 # Forward/backward offset
|
||||
|
||||
# Rotation of the item on the armor stand, relative to North (0 = North, 90 = East, etc.)
|
||||
rotationOffset: 0
|
||||
|
||||
# The item used as the vehicle's skin (on the armor stand)
|
||||
item: {
|
||||
material: LEATHER_BOOTS # Material used for the vehicle's body (e.g., LEATHER_BOOTS)
|
||||
custommodeldata: 1 # Optional: Custom model data if you use a custom model from your resource pack
|
||||
color: { # Color of the item (if relevant, e.g., for colored leather items)
|
||||
red: 255
|
||||
green: 125
|
||||
blue: 0
|
||||
}
|
||||
}
|
||||
|
||||
# Position of the item on the armor stand (HEAD, LEFT_HAND or RIGHT_HAND)
|
||||
position: HEAD
|
||||
}
|
||||
```
|
||||
|
||||
### 2. **Seats**
|
||||
|
||||
- Seats are parts of the vehicle where players can sit.
|
||||
The seat configuration controls where the seat is placed and whether it allows steering.
|
||||
|
||||
**Here is an example of a Seat configuration with explanation:**
|
||||
|
||||
```json
|
||||
{
|
||||
# The type of part (should always be "seat" for vehicle seats)
|
||||
type: seat
|
||||
|
||||
# Position offsets relative to the vehicle's spawn point (steps of 0.1 allowed)
|
||||
xoffset: 0 # Horizontal offset
|
||||
yoffset: 0 # Vertical offset
|
||||
zoffset: 0 # Forward/backward offset
|
||||
|
||||
# Rotation of the seat relative to the vehicle's orientation (in degrees)
|
||||
rotationOffset: 0
|
||||
|
||||
# Whether this seat allows driving (true = player can drive from this seat)
|
||||
steer: true
|
||||
|
||||
# The GUI item used to represent the seat part in the configuration GUI
|
||||
guiitem: {
|
||||
damage: 1 # The item’s damage value (used for durability, if applicable)
|
||||
material: DIAMOND_HOE # The material of the item (e.g., DIAMOND_HOE)
|
||||
unbreakable: true # Unbreakable will be true most of the time if damage is used
|
||||
flags: [ # Flags to apply to the item (can be used to hide item tooltips)
|
||||
HIDE_UNBREAKABLE
|
||||
HIDE_ADDITIONAL_TOOLTIP
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. **Wheels**
|
||||
|
||||
- Wheels are parts of the vehicle that determine its movement and appearance.
|
||||
The wheel configuration controls where the wheel is placed, what design to use, and whether it has steering
|
||||
capabilities.
|
||||
|
||||
**Here is an example of a Wheel configuration with explanation:**
|
||||
|
||||
```json
|
||||
{
|
||||
# The type of part (should always be "wheel" for vehicle wheels)
|
||||
type: wheel
|
||||
|
||||
# Position offsets relative to the vehicle's spawn point (steps of 0.1 allowed)
|
||||
xoffset: 0 # Horizontal offset
|
||||
yoffset: 0 # Vertical offset
|
||||
zoffset: 0 # Forward/backward offset
|
||||
|
||||
# Rotation of the wheel relative to the vehicle's orientation (in degrees)
|
||||
rotationOffset: 0
|
||||
|
||||
# Rim design used for this wheel
|
||||
rimDesignId: default
|
||||
|
||||
# Whether this wheel is used for steering (true = wheel is used for steering)
|
||||
steering: true
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Adding New Cars
|
||||
|
||||
Want to add custom cars to your server? VehiclesPlus makes it easy to integrate new models and designs.
|
||||
|
||||
1. **Model Creation:**
|
||||
Create a custom car model using a 3D modeling tool like Blockbench.
|
||||
|
||||
2. **Resource Pack Setup:**
|
||||
Add your model to the server’s resource pack. See the [Models](../models/adding.md) page for detailed instructions.
|
||||
|
||||
3. **Configuration:**
|
||||
Define the new car in the plugin’s configuration file. Specify properties like speed, fuel capacity, and parts
|
||||
compatibility.
|
||||
|
||||
For a detailed guide, visit the [Adding New Vehicles](../vehicles/models/adding.md) page.
|
||||
35
vehiclesplus-v3/vehicles.md
Normal file
35
vehiclesplus-v3/vehicles.md
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Vehicles
|
||||
---
|
||||
|
||||
# Vehicles
|
||||
|
||||
Explore the various features and customization options for vehicles in VehiclesPlus.
|
||||
|
||||
---
|
||||
|
||||
## 🚗 **Vehicles & Parts**
|
||||
|
||||
Discover how to set up a vehicle per type available in VehiclesPlus.
|
||||
|
||||
- [Cars](types/cars): Learn about cars and their features.
|
||||
- [Bikes](types/bikes): Get details on how to use bikes.
|
||||
- [Helicopters](types/helicopters): Understand helicopters and their mechanics.
|
||||
- [Boats](types/boats): A guide to boats and water travel.
|
||||
|
||||
---
|
||||
|
||||
## ⛽ **Fuel**
|
||||
|
||||
Configure and manage the fuel system for vehicles.
|
||||
|
||||
- [Adding Fuel Types](fuel/adding): Add or modify fuel types available.
|
||||
|
||||
---
|
||||
|
||||
## 🚘 **Rims**
|
||||
|
||||
Customize the appearance of rims for your vehicles.
|
||||
|
||||
- [Adding New Rims](rims/adding): Instructions for adding custom rim styles.
|
||||
Loading…
Add table
Add a link
Reference in a new issue