Add settings for poof animation, sounds, and emissive layers

- Added config options to enable/disable poof animation (#40), animation sounds (closes #39), and hiding emissive mob layers
- Added partial support for Pehkui <3.4.0

Author: Tschipcraft

CHANGES.md

@@ -1,5 +1,6 @@
 - **Entities with emissive layers are now properly hidden** (Endermen, Spiders, and Cave Spiders) (closes [#25](https://github.com/Tschipcraft/spawnanimations/issues/25))
   - For this feature to work in Minecraft 1.20.4 and below, [Pehkui](https://modrinth.com/project/t5W7Jfwy) must be installed. Pehkui can still be installed in newer versions for smoother poof animations
+- Added config options to enable/disable poof animation ([#40](https://github.com/Tschipcraft/spawnanimations/issues/40)), animation sounds (closes [#39](https://github.com/Tschipcraft/spawnanimations/issues/39)), and hiding emissive mob layers
 - Improved performance by refactoring entity activation distance calculations to bundle and cache position data retrieval calls, and updating batch activation logic (the whole data pack is now up to 1ms (~45%ish) faster per tick!)
 - Modified the attack predicate of the secondary dig-up requirements so that it disregards the Y-distance. This allows mobs to, for example, appear at the bottom of pillars, if a player decides to build up during the night
 - Added an activation distance recommendation message when using the vanilla activation mode

assets/spawnanimations/lang/en_us.json

@@ -5,23 +5,29 @@
 
   "spawnanimations.midnightconfig.title": "Spawn Animations Configuration",
   "spawnanimations.midnightconfig.empty": "",
-  "spawnanimations.midnightconfig.configure_ingame": "§dℹ Info:§r§f To configure this data pack on a world-to-world basis,",
+  "spawnanimations.midnightconfig.configure_ingame": "§dℹ Info:§f To configure this data pack on a world-to-world basis,",
   "spawnanimations.midnightconfig.configure_ingame2": "join a world and execute the command §o/function spawnanimations:settings§r.",
   "spawnanimations.midnightconfig.empty2": "",
   "spawnanimations.midnightconfig.global_settings": "§n§l-=- Global Settings -=-",
-  "spawnanimations.midnightconfig.info": "§dℹ Info:§r§f These settings will be applied globally to all worlds.",
+  "spawnanimations.midnightconfig.info": "§dℹ Info:§f These settings will be applied globally to all worlds.",
   "spawnanimations.midnightconfig.info2": "Please make sure to rejoin any world for the global settings to take effect.",
   "spawnanimations.midnightconfig.empty3": "",
   "spawnanimations.midnightconfig.empty4": "",
 
   "spawnanimations.midnightconfig.activation_distance": "Activation Distance",
   "spawnanimations.midnightconfig.activation_distance.tooltip": "Default: §a20 blocks§f\nMobs closer to a player than this value will play the animation.\nSetting this to 0 will use the world-specific value.",
   "spawnanimations.midnightconfig.activation_mode": "Activation Mode",
-  "spawnanimations.midnightconfig.activation_mode.tooltip": "Default: §aClassic§f\n§nClassic§r: Out of range mobs will stay hidden until a player is in range\n§nVanilla§r: Out of range mobs will spawn normally\nWhen set to Vanilla, it is recommended to set the activation distance to at least 25 blocks to see the animation",
-  "spawnanimations.midnightconfig.hide_worn_armor_and_tools": "Hide worn armor and tools",
-  "spawnanimations.midnightconfig.hide_worn_armor_and_tools.tooltip": "Default: §aYes§f\nIf enabled, stores the worn armor and tools in the feet and in some versions leggings slot of a hidden entity.\n§6⚠ Note: This may impact worn armor and tool drop rates from farms when enabled.",
-  "spawnanimations.midnightconfig.play_animation_on_unsupported_blocks": "Play block break animation on unsupported blocks",
-  "spawnanimations.midnightconfig.play_animation_on_unsupported_blocks.tooltip": "Default: §cNo§f\nIf enabled, plays a block breaking animation even on blocks that are not hard-coded into the data pack.\n§6⚠ Note: This could lead to unwanted block updates when enabled.",
+  "spawnanimations.midnightconfig.activation_mode.tooltip": "Default: §aClassic§f\n§nClassic§r: Mobs outside the activation range remain hidden until a player is in range.\n§nVanilla§r: Mobs outside the activation range spawn normally.\n§9ℹ Info:§f When set to Vanilla, it is recommended to set the activation distance to at least 25 blocks to see the animation.",
+  "spawnanimations.midnightconfig.enable_poof_animation": "Enable Poof Animation",
+  "spawnanimations.midnightconfig.enable_poof_animation.tooltip": "Default: §aYes§f\nIf enabled, some mobs, or mobs without a block to dig up from, will play the poof animation instead.",
+  "spawnanimations.midnightconfig.play_animation_sounds": "Play Animation Sounds",
+  "spawnanimations.midnightconfig.play_animation_sounds.tooltip": "Default: §aYes§f\nIf enabled, sounds will be played during the animation.",
+  "spawnanimations.midnightconfig.hide_worn_armor_and_tools": "Hide Worn Armor and Tools",
+  "spawnanimations.midnightconfig.hide_worn_armor_and_tools.tooltip": "Default: §aYes§f\nIf enabled, worn armor and tools are stored in the body, feet, or in some versions, leggings slot of a hidden entity.\n§6⚠ Note: This may impact worn armor and tool drop rates from mob farms when enabled.",
+  "spawnanimations.midnightconfig.hide_emissive_mob_layers": "Hide Emissive Mob Layers",
+  "spawnanimations.midnightconfig.hide_emissive_mob_layers.tooltip": "Default: §aYes§f\nIf enabled, emissive layers of some mobs (e.g., Endermen, Spiders, and Cave Spiders), or with Pehkui all mobs, will be hidden by shrinking them.\nRequires Pehkui to be installed in Minecraft 1.20.4 and below.\n§6⚠ Note: This may decrease the efficiency of mob farms due to the changed hitbox size for hidden entities when Pehkui is §nnot§r installed and the feature is enabled.",
+  "spawnanimations.midnightconfig.play_animation_on_unsupported_blocks": "Play Block Break Animation on Unsupported Blocks",
+  "spawnanimations.midnightconfig.play_animation_on_unsupported_blocks.tooltip": "Default: §cNo§f\nIf enabled, the block breaking animation plays on blocks not explicitly supported by Spawn Animations.\n§6⚠ Note: This could lead to unwanted block updates when enabled.",
 
   "spawnanimations.midnightconfig.enum.bool.WORLD": "§bWorld-Specific",
   "spawnanimations.midnightconfig.enum.bool.YES": "§a[✔] Yes",

data/spawnanimations/function/internal/animation/dig_up/sound/sound.mcfunction

@@ -1,7 +1,7 @@
 ## by Tschipcraft
 
-execute if block ~ ~ ~ #spawnanimations:supported run function spawnanimations:internal/animation/dig_up/sound/play_sound
-execute if score $play_unsupport ts.sa.settings matches 1..2 unless block ~ ~ ~ #spawnanimations:supported unless block ~ ~ ~ #spawnanimations:nonsolid unless block ~ ~ ~ minecraft:bedrock unless block ~ ~ ~ minecraft:air run function spawnanimations:internal/animation/dig_up/sound/support
+execute if score $play_sounds ts.sa.settings matches 1..2 if block ~ ~ ~ #spawnanimations:supported run function spawnanimations:internal/animation/dig_up/sound/play_sound
+execute if score $play_sounds ts.sa.settings matches 1..2 if score $play_unsupport ts.sa.settings matches 1..2 unless block ~ ~ ~ #spawnanimations:supported unless block ~ ~ ~ #spawnanimations:nonsolid unless block ~ ~ ~ minecraft:bedrock unless block ~ ~ ~ minecraft:air run function spawnanimations:internal/animation/dig_up/sound/support
 
 # Update stage + adjust animation speed
 scoreboard players add @s ts.sa.e.stage 1

data/spawnanimations/function/internal/animation/dig_up/sound/sound2.mcfunction

@@ -1,7 +1,7 @@
 ## by Tschipcraft
 
-execute if block ~ ~ ~ #spawnanimations:supported run function spawnanimations:internal/animation/dig_up/sound/play_sound2
-execute if score $play_unsupport ts.sa.settings matches 1..2 unless block ~ ~ ~ #spawnanimations:supported unless block ~ ~ ~ #spawnanimations:nonsolid unless block ~ ~ ~ minecraft:bedrock unless block ~ ~ ~ minecraft:air run function spawnanimations:internal/animation/dig_up/sound/support
+execute if score $play_sounds ts.sa.settings matches 1..2 if block ~ ~ ~ #spawnanimations:supported run function spawnanimations:internal/animation/dig_up/sound/play_sound2
+execute if score $play_sounds ts.sa.settings matches 1..2 if score $play_unsupport ts.sa.settings matches 1..2 unless block ~ ~ ~ #spawnanimations:supported unless block ~ ~ ~ #spawnanimations:nonsolid unless block ~ ~ ~ minecraft:bedrock unless block ~ ~ ~ minecraft:air run function spawnanimations:internal/animation/dig_up/sound/support
 
 scoreboard players reset @s ts.sa.e.stage
 scoreboard players reset @s ts.sa.e.speed

data/spawnanimations/function/internal/animation/dig_up/verify_in_air.mcfunction

@@ -1,9 +1,10 @@
 ## by Tschipcraft
+# The "Poof" animation
 
 tag @s remove ts.sa.verify
 tag @s remove ts.sa.to_verify
 function spawnanimations:internal/entity/unhide
 function spawnanimations:internal/entity/unprotect
-particle minecraft:spit ~ ~1 ~ 0 0.3 0 0.2 15 normal
-playsound minecraft:entity.llama.spit hostile @a ~ ~ ~ 0.75 0
+execute if score $enable_poof_anim ts.sa.settings matches 1..2 run particle minecraft:spit ~ ~1 ~ 0 0.3 0 0.2 10 normal
+execute if score $enable_poof_anim ts.sa.settings matches 1..2 if score $play_sounds ts.sa.settings matches 1..2 run playsound minecraft:entity.llama.spit hostile @a ~ ~ ~ 0.75 0
 function spawnanimations:internal/animation/dig_up/verify

data/spawnanimations/function/internal/entity/ehs/hide.mcfunction

@@ -9,4 +9,4 @@ tag @s add ts.sa.to_hide
 effect give @s invisibility 10 0 true
 
 # Pehkui integration (overlay_pre_49)
-function spawnanimations:internal/entity/ehs/pehkui/hide
+execute if score $hide_emissive ts.sa.settings matches 1..2 run function spawnanimations:internal/entity/ehs/pehkui/hide

data/spawnanimations/function/internal/entity/ehs/hide_exec.mcfunction

@@ -10,4 +10,4 @@ execute if score $hide_armor ts.sa.settings matches 1..2 as @s[type=#spawnanimat
 
 # Entity specific
 execute if entity @s[type=minecraft:creeper] run function spawnanimations:internal/entity/ehs/entity_specific/creeper/hide
-execute if entity @s[type=#spawnanimations:has_emissive_layer,tag=!ts.sa.ehs.pehkui.shrunk] run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/hide
+execute if score $hide_emissive ts.sa.settings matches 1..2 if entity @s[type=#spawnanimations:has_emissive_layer,tag=!ts.sa.ehs.pehkui.shrunk] run function spawnanimations:internal/entity/ehs/entity_specific/emissive_layer/hide

data/spawnanimations/function/settings/classic.mcfunction

@@ -1,5 +1,5 @@
 ##by Tschipcraft
 
-tellraw @s ["",{"text":"\n-> Set activation mode to "},{"text":"[classic]","color":"yellow"}]
+tellraw @s ["",{"text":"\n-> Set Activation Mode to "},{"text":"[Classic]","color":"yellow"}]
 scoreboard players set $activation_mode ts.sa.settings 1
 function #spawnanimations:settings