Zauber Cauldrons 1.20 Feature Update (Spreading the Magic Update)

[Bloo-dev]

With 1.20 Zauber Cauldrons is receiving another feature update, aiming to tie up some loose ends in the magic system.

Progress Overview

• Make Splash and Lingering Soulutions Functional
• Enable re-texturing of Zauber Cauldrons via the RP
• Use Beet templates to reduce repetitive code
• Update Particle Effect Colors (1.20 potion color changes)
• Add support for custom liquids via expansions
• Allow custom liquids to display their own particles
• Implement 'Biome Painter' Potions and Soulutions
• Rebalance Wandering Trader Deals
• Performance Enhancements
• Update to 1.20.4
• Make Crystals unstackable (depends on Allow lib_player_heads to Create Unstackable Player Heads #937 )

Feature Outline

Below is a list of features to be introduced with this update.

Splash and Lingering Soulutions

Soulutions are now available for all supported potion types as splash and lingering variants! Simply use soul fire to heat a powered-snow filled Zauber Cauldron and craft a Soulution as usual. The resultung splash or lingering Soulution will drop a copy of the Soulution item when thrown -- but with one 'Sip' (in this case called 'Throw') less.
The copy will spawn at the location of impact of the thrown potion. Dispensers are supported.

Splash and Lingering Soulutions from previous versions of Zauber Cauldrons already have all the required data, and will function as expected in this newer version (apart from a lore line being missing on these outdated items).

Crystals

Zauber Crystals have gotten a minor revision in this update, which not only updated the textures to match the new potion colors, but also makes them less annoying to use:

• Crystals are no longer stackable
• Crystals can no longer be placed down from the offhand

The latter is achieved by turning them into firework star items when in the offhand. This is completely invisible to resource pack users. Old crystals in existing worlds will remain stackable and keep their old textures.

Magic in a Bottle

Magic in a bottle gains a new property: The preferred Moon phase. Possessed items created by a Zauber Cauldron now prefer one out of the 8 Moon phases and are calmed by this moon phase. Magic in a Bottle doesn't burst as quickly during this Moon phase and bottling of Magico (see below) is possible.
The preferred Moon phase weakly depends on the coordinates of the Zauber Cauldron in which the Magic in a Bottle was made as well as the world seed.
Players wearing a full set of Zauber Armor will see sparkle particles on Magic in a Bottle and Magicol during this moon phase.

Wandering Trader Deals

The trades added to Wandering Traders by Zauber Cauldrons have been overhauled. Previously all trades were rather overpriced and therefore generally uninteresting. The new trades have prices set depending on the item sold (enchanted prismarine shard, golden apple, or prismarine crystals) and the sell quantities have been adjusted in the player's favor.

Here's a quick overview of the new trade pool layout:

• there is a single trade pool called gm4_zauber_cauldrons:precursors
• the pool contents vary based on chance:
  • there is a 33% chance of Enchanted Prismarine Shards in the pool, with a 12.5% for a count of 3 instead of 1
  • there is a 50% chance of a Golden Apple in the pool
  • there is a 40% chance of 8 to 24 Prismarine Crystals in the pool

From the selected pool members, one trade is then selected to be presented by the Wandering Trader.

Magicol

Magicol is a new liquid which can be created within a Zauber Cauldron. To craft Magicol first fill up the Zauber Cauldron with water. All water levels work, but for maximum efficiency filling it up to the brim is recommended. Now add an Enchanted Prismarine Shard, Magic in a Bottle, and some dye.

Once the recipe completes the water in the Zauber Cauldron will now be replaced with Magicol.
Magicol itself has no uses, it can simply remain in the Zauber Cauldron until it is bottled, however, this bottling process can only be executed during the preferred Moon phase of the Magic in a Bottle used to craft the Magicol.

If you wish to disable the entire Magicol system you can set $disable_magicol in gm4_zc_data to 1. This will disable all Magicol related crafting recipes. It wil not disable the functionality of those items though.

Bottled Magicol

Bottled Magicol is a magical liquid which can dye biomes. To obtain it one must be familiar with Zauber Cauldron's mechanics and explore some of its magic branches, or I better say it is recommended to do so, yet technically Bottled Magicol can be made without any advanced gear or knowledge.

First the Zauber Cauldron must be filled with Magicol, see the section above for details. Once this is done the Magicol can be bottled, however, this must be done during the Moon phase preferred by the Magic in a Bottle used to make the Magicol.
To figure this Moon phase out two methods may be used:

• trial & error: During their preferred Moon phase Possessed Items don't break out of Magic in a Bottle as quickly. Trying this experiment for 8 nights will reveal the right phase
• using Zauber Armor: When wearing Zauber Armor sparkles will appear around Magic in a Bottle and Zauber Cauldrons filled with Magicol during the preferred Moon phase

Once this knowledge has been obtained for a Cauldron once the player can simply look at the Moon and does not have to do this research again.
To obtain Bottled Magicol throw the following into a Zauber Cauldron filled with Magicol:

• a Slime Ball, Magma Cream, or a Snowball
• a drinkable, splash, or lingering water bottle
• Prismarine Crystals

When using a slime ball, the resulting Bottled Magicol will be temperate, with Magma Cream it will be arid, and with a Snowball it will be polar. The different types of bottles do the obvious. Here is an overview of all the parameters:

• The Bottled Magicol obtained via this process will take the color of the Magicol liquid previously in the cauldron.
• If a lingering water bottle was used the resulting Bottled Magicol will cause permanent particle effects in the air of the biome it creates, a splash bottle does not do this. Drinkable Bottled Magicol is currently useless.
• Temperate Bottled Magicol allows for rain, Polar Bottled Magicol allows for snow, and Arid Bottled Magicol forces clear skies in the biome it creates. Additionally, the base color is slightly shifted for these three variants
• All of these biomes are spawn-proof
• Using Soul Fire Bottled Magicol Soulutions can be made.
  

Bottled Magicol causes tall grass (called short grass in 1.20.4) to spawn around the impact location. If the flower corrosponding to the biome that was painted in is considered lucky, it will also cause that flower to spawn and grant luck to nearby players for a short amount of time.

Technical Features

Below is a list of features which do not directly affect gameplay but may interest the more technically inclined.

Loot Tables

Most items in Zauber Cauldrons are now available via loot tables located in the standard items/ directory. Do note that some of these items have special versions which are not available in loot tables (mainly soulutions).

Custom Liquid System

Zauber Cauldrons now implements its own system of custom liquids. Expansions can hook into this system to add their own liquids. In some future update Zauber Cauldrons will move over to exclusively using this custom liquid system, i.e. instead of throwing a Poison II potion bottle into the cauldron to make a Poison IV potion, the player would then fill the Zauber Cauldron with Poison II liquid first and then upgrade this liquid and bottle it after.

Version Compatibility

This version of Zauber Cauldrons makes heavy use of 1.20.2+ features and does therefore not work in 1.20 or 1.20.1.

File-Driven Definitions

With this PR a folder ./raw/ is introduced. This folder holds configuration data for recipes and items in Zauber Cauldrons. To make editing these easier this PR adds the temporary lock files created by LibreOffice to .gitignore.

Expanded CustomModelData Support

With the custom liquid system and the file-driven definitions Zauber Cauldrons now provides extensive support for CustomModelData. Most items in Zauber Cauldrons, and the Magicol custom liquid now support CustomModelData. The numeric values can be assigned via the files in ./raw/.

[Bloo-dev]

I've tested this again on a fresh world of mine and everything is working as expected & feature complete now.

However, we must reserve CMD values before this is merged. I will get in touch with @SpecialBuilder32 for that. I will un-draft this PR once this has been resolved.

[Bloo-dev]

Did some more testing and found two more bugs, those are now fixed. I also teste dupgrading old worlds, which works without an issue.