... | ... | @@ -35,14 +35,25 @@ NOTE: All particle configs will have different required values in `properties` d |
|
|
- `enabled` - Boolean to toggle whether your particle is enabled<br>
|
|
|
- `spawning.biomes` - Array of Spigot [biomes](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Biome.html) your particle will be shown in<br>
|
|
|
- `spawning.spawnDistance` - Float for the minimum distance between shapes Aurora will spawn from the same config<br>
|
|
|
- `spawning.randMultiplier` - Float for how far the location calculation of `spawning.spawnDistance` should deviate from its actual value. Should be between `0` (0%) and `1.0` (100%)<br>
|
|
|
- `spawning.randMultiplier` - Float for how far the location calculation of `spawning.spawnDistance` should deviate from its actual value
|
|
|
- Should be between `0` (0%) and `1.0` (100%)<br>
|
|
|
- `spawning.minY` - Integer for the minimum y-coordinate the particle will spawn at<br>
|
|
|
- `spawning.maxY` - Integer for the maximum y-coordinate the particle will spawn at<br>
|
|
|
- `spawning.shuffleLocations` - Boolean to toggle whether calculated particle-spawn locations in the internal list should be randomised<br>
|
|
|
`particle.particleName` - Spigot [particle](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html) the shape should be made of<br>
|
|
|
- `particle.particleType` - Aurora particle shape. Can be `POINT`, `LINE`, `CUBE`, `RING`, `CIRCLE`, `SPHERE` or `WAVE`<br>
|
|
|
- `particle.particleType` - Aurora particle shape
|
|
|
- Can be
|
|
|
- `POINT`
|
|
|
- `LINE`
|
|
|
- `CUBE
|
|
|
- `RING`
|
|
|
- `CIRCLE`
|
|
|
- `SPHERE`
|
|
|
- `WAVE`<br>
|
|
|
- `particle.maxCount` - Integer for the maximum number of shapes from the same config that can appear at any one time per player<br>
|
|
|
- `particle.enableLighting` - Boolean to toggle whether lighting should be set at particle-spawn locations. It is **recommended to disable** this as lighting may not update correctly when a chunk is unloaded, leaving "ghost" light sources. Only enable if your particle cannot be seen in the dark, or if `spawning.minY` is above 100<br>
|
|
|
- `particle.enableLighting` - Boolean to toggle whether lighting should be set at particle-spawn locations
|
|
|
- It is **recommended to disable** this as lighting may not update correctly when a chunk is unloaded, leaving "ghost" light sources
|
|
|
- Only enable if your particle cannot be seen in the dark, or if `spawning.minY` is above 100<br>
|
|
|
- `properties` - Configuration section depending on `particle.particleType`
|
|
|
#### Point particle type
|
|
|
```json
|
... | ... | @@ -51,8 +62,10 @@ NOTE: All particle configs will have different required values in `properties` d |
|
|
"duration": 20
|
|
|
}
|
|
|
```
|
|
|
`properties.update` - Integer for how often the server should update the particle in ticks. It is **recommended to set this value above 5 for non-moving shapes** to avoid unnecessary server lag and FPS drops for clients as most particles will stay for a few ticks even if not updated. For moving particles with `LINE` or `WAVE` particle types, this value determines how fast the shape travels<br>
|
|
|
`properties.duration` - Integer for how long in ticks a particles in a shape should should stay for<br>
|
|
|
- `properties.update` - Integer for how often the server should update the particle in ticks
|
|
|
- It is **recommended to set this value above 5 for non-moving shapes** to avoid unnecessary server lag and FPS drops for clients as most particles will stay for a few ticks even if not updated
|
|
|
- For moving particles with `LINE` or `WAVE` particle types, this value determines how fast the shape travels<br>
|
|
|
- `properties.duration` - Integer for how long in ticks a particles in a shape should should stay for<br>
|
|
|
#### Line particle type
|
|
|
```json
|
|
|
"properties": {
|
... | ... | @@ -61,7 +74,8 @@ NOTE: All particle configs will have different required values in `properties` d |
|
|
"duration": 1
|
|
|
}
|
|
|
```
|
|
|
`properties.rate` - Float for the distance between each individual particle inside a shape. It is **recommended to set this value between 0.2 and 0.5** for optimal performance and nice-looking shapes
|
|
|
- `properties.rate` - Float for the distance between each individual particle inside a shape
|
|
|
- It is **recommended to set this value between 0.2 and 0.5** for optimal performance and nice-looking shapes
|
|
|
#### Cube particle type
|
|
|
```json
|
|
|
"properties": {
|
... | ... | @@ -73,9 +87,9 @@ NOTE: All particle configs will have different required values in `properties` d |
|
|
"rotationAxis": "x"
|
|
|
}
|
|
|
```
|
|
|
`properties.length` - Float for length of a cuboid object<br>
|
|
|
`properties.rotationAngle` - Float for angle the object should be rotated by<br>
|
|
|
`properties.rotationAxis` - Character for axis the object should be rotated in. Can be `x`, `y` or `z`
|
|
|
- `properties.length` - Float for length of a cuboid object<br>
|
|
|
- `properties.rotationAngle` - Float for angle the object should be rotated by<br>
|
|
|
- `properties.rotationAxis` - Character for axis the object should be rotated in. Can be `x`, `y` or `z`
|
|
|
#### Ring particle type
|
|
|
```json
|
|
|
"properties": {
|
... | ... | @@ -87,7 +101,7 @@ NOTE: All particle configs will have different required values in `properties` d |
|
|
"rotationAxis": "x"
|
|
|
}
|
|
|
```
|
|
|
`properties.radius` - Float for radius of a circular object<br>
|
|
|
- `properties.radius` - Float for radius of a circular object<br>
|
|
|
#### Circle particle type
|
|
|
```json
|
|
|
"properties": {
|
... | ... | @@ -119,8 +133,8 @@ NOTE: All particle configs will have different required values in `properties` d |
|
|
"rotationAngle": 50.0,
|
|
|
"rotationAxis": "x"
|
|
|
}
|
|
|
`properties.waveCycles` - Float for how many complete cycles the wave should consist of<br>
|
|
|
`properties.waveAmplitude` - Float for the maximum height in blocks of each wave relative to its midpoint
|
|
|
- `properties.waveCycles` - Float for how many complete cycles the wave should consist of<br>
|
|
|
- `properties.waveAmplitude` - Float for the maximum height in blocks of each wave relative to its midpoint
|
|
|
```
|
|
|
|
|
|
## Troubleshooting
|
... | ... | |