Differences

This shows you the differences between two versions of the page.

--- plugin:extrafireworks:config [2020/12/28 11:17] – phoenix616
+++ plugin:extrafireworks:config [2025/12/22 18:38] (current) – [Example Schematic] Add example of custom effect phoenix616
@@ Line 4: / Line 4: @@
 The default values are always compatible for the latest version, if you need to set the plugin up with an older version (currently only necessary for 1.12 and 1.13) then please take a look at these [default configs](https://gist.github.com/Phoenix616/eeec41ce3db5b3fa535341bfaab3ad8b).
+## debug
+Log some more debug information
+//Default:// `true`
 ## language
@@ Line 30: / Line 35: @@
 Where to download skins from when only the skull  owner name is known. Use `%name%` as the placeholder for the name.
-//Default:// `https://crafatar.com/skins/%name%`
+//Default:// `https://minotar.com/skin/%name%`
 #### uuid
 Where to download skins from when the skull owner uuid is known. Use `%uuid%` as the placeholder for the name.
-//Default:// `https://crafatar.com/skins/%uuid%`
+//Default:// `https://minotar.com/skin/%uuid%`
 #### texture
@@ Line 135: / Line 140: @@
 #### image
 The image in the images folder on which the custom effect is based on.
+#### schematic
+The schematic in the schematics folder. (Only if no image is set) This required WorldEdit 7 (or later) and allows for custom 3D effects.
+If the string starts with a / then the server-root is assumed for the path (e.g. to allow schematics from WorldEdit)
 #### scale
-The scale of the image (blocks per pixel)
+The scale of the image (blocks per pixel or blocks)
 #### density
-How many particles should be used to display one pixel
+How many particles should be used to display one pixel (Only for images. Use a larger schematic and adjust the scale for clearer effects)
 #### recipe
@@ Line 146: / Line 156: @@
 #### box
-Whether the effect should always be in a box shape. (`true`/`false`) Enabling this will disallow crafting the item to a box automatically.
+Whether the effect should always be in a box shape. (`true`/`false`) Enabling this will disallow crafting the item to a box automatically. (Only supported by images)
 #### transparent
-Whether the effect should always display dark color as transparent. (`true`/`false`) Enabling this will disallow crafting the item with the transparent modifier automatically.
+Whether the effect should always display dark color as transparent. (`true`/`false`) Enabling this will disallow crafting the item with the transparent modifier automatically. (Only supported by images. For schematics just leave air blocks in the schematic.)
 #### particle
@@ Line 156: / Line 166: @@
 #### colors
 The color the effect should have, forces the particle to redstone. Set to an empty string if you don't want a color. E.g. if you want only a red outline use `colors: "255,0,0"`
+#### flash-color
+The color that the explosion flash should have. (Only supported on 1.21.9 and newer.) If not set and colors are provided then the first color will be used!
+#### sounds
+Specify custom sounds to play at the explosion location when the effect gets displayed. See [this list](https://minecraft.fandom.com/wiki/Sounds.json#Java_Edition_values) for sounds available in the Vanilla game. (Resource pack sounds are supported too!)
+Defining a custom sound will not play the normal explosion sound if the firework doesn't have a Vanilla firework effect!
+Can be multiple and omit the category or volume or pitch and uses the following syntax: `<sound>[,<category>][,<volume>[,<pitch>]]`
 #### allow
@@ Line 171: / Line 191: @@
 If no dye is provided it will use the specified particle.
-### Example
+### Example Image
 <code yaml>
@@ Line 184: / Line 204: @@
     particle: "redstone"
     colors: ""
+    sounds:
+    - "entity.cow.ambient,master,10,1"
     allow:
       box: true
@@ Line 189: / Line 211: @@
       coloring: false
 </code>
+### Example Schematic
+<code yaml>
+custom:
+  xmastree:
+    schematic: xmastree.schem
+    scale: 0.5
+    recipe: spruce_sapling
+    particle: "redstone"
+    flash-color: "0,192,0"
+    colors: ""
+    sounds: []
+    allow:
+      box: false
+      transparency: false
+      coloring: false
+</code>
+This config will create an effect looking like this:
+{{ plugin:extrafireworks:image:custom_xmastree.jpg?nolink |Minecraft screenshot of a firework looking like a Christmas tree out of green particles }}
+{{ https://i.phoenix616.dev/hm18OPrh.mp4?1280x720 | Minecraft video of a firework looking like a Christmas tree out of green particles }}