SBDevelopment/docs
Archived
3
0
Fork 1
Code Activity

docs: update vehiclesplus/configuration/plugin

Browse source
This commit is contained in:
Stijn Bannink 2023-07-22 13:06:03 +00:00 committed by stijnb1234
parent 2827d806d5
commit 7e2de3f459
1 changed files with 2 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
vehiclesplus/configuration/plugin.md
View file

@ -2,17 +2,14 @@
title: Plugin Configuration title: Plugin Configuration
description: Configure the VehiclesPlus plugin. description: Configure the VehiclesPlus plugin.
published: true published: true
date: 2023-07-22T09:20:23.417Z date: 2023-07-22T13:06:00.040Z
tags: tags:
editor: markdown editor: markdown
dateCreated: 2023-07-22T09:20:23.417Z dateCreated: 2023-07-22T09:20:23.417Z
--- ---
# Plugin Configuration # Plugin Configuration
Configure the VehiclesPlus plugin. This page explains the `config.yml` file, which contains generic configuration.
## config.yml
This file includes generic configuration settings.
*Per setting will be explained what it means as a comment (`#`).* *Per setting will be explained what it means as a comment (`#`).*
```yaml ```yaml
# DO NOT CHANGE # DO NOT CHANGE
@ -58,53 +55,4 @@ showActionBar: true
# If true, vehicles spawn in the locked state # If true, vehicles spawn in the locked state
vehiclesSpawnLocked: true vehiclesSpawnLocked: true
```
## sounds.yml
This file changes the sounds used per base vehicle.
### Example file
*Per setting will be explained what it means as a comment (`#`).*
```yaml
# Below are all the available sounds, applied on the base vehicle 'examplecar'.
sounds:
examplecar-engine-idle:
# The sound to play
sound: car.idle
# The duration (ticks) to play it for (PAY ATTENTION: some sounds do loop)
duration: 6
examplecar-engine-start:
sound: car.start
duration: 2
examplecar-engine-accelerate:
sound: car.accelerate
duration: 2
examplecar-engine-driving:
sound: car.driving
duration: 2
examplecar-engine-slowingdown:
sound: car.slowingdown
duration: 2
```
### Adding new sounds
To add the sounds for another base vehicle, just copy the default list and change all the settings.
*Do NOT copy the `[...]`, instead copy the part below it and paste at the end of the file.*
```yaml
[...]
newbasevehicle-engine-idle:
sound: car.idle
duration: 6
newbasevehicle-engine-start:
sound: car.start
duration: 2
newbasevehicle-engine-accelerate:
sound: car.accelerate
duration: 2
newbasevehicle-engine-driving:
sound: car.driving
duration: 2
newbasevehicle-engine-slowingdown:
sound: car.slowingdown
duration: 2
``` ```