Differences

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

--- plugin:extrafireworks:config [2025/12/10 18:38] – Add flash-color doc phoenix616
+++ plugin:extrafireworks:config [2025/12/22 18:38] (current) – [Example Schematic] Add example of custom effect phoenix616
@@ Line 140: / 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 151: / 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 186: / Line 191: @@
 If no dye is provided it will use the specified particle.
-### Example
+### Example Image
 <code yaml>
@@ Line 206: / 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 }}