### 🌐 Translations * [English](https://github.com/Stoupy51/SmartOreGeneration/blob/main/README.md) * [Française](https://github.com/Stoupy51/SmartOreGeneration/blob/main/README.fr.md) # 📖 Smart Ore Generation [![GitHub](https://img.shields.io/github/v/release/Stoupy51/SmartOreGeneration?logo=github&label=GitHub)](https://github.com/Stoupy51/SmartOreGeneration/releases/latest) [![Smithed](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.smithed.dev%2Fv2%2Fpacks%2Fsmart_ore_generation%2Fmeta&query=%24.stats.downloads.total&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgdmlld0JveD0iMCAwIDQgNCIgeG1sbnM6dj0iaHR0cHM6Ly92ZWN0YS5pby9uYW5vIj48cGF0aCBkPSJNLjczNy44NTlsLjg4Ny0uMjg1Yy4wOTktLjAzMi4yMDUtLjAzMi4zMDQgMGwxLjMzNS40MjktMS4wNC4zMzR6bS0uMTk1LjE4OXYuNDg3YzAgLjEwNS4wNjguMTk5LjE2OC4yMzFsMS41MTQuNDg3TDMuMjkgMS45MWMuMS0uMDMyLjE2OC0uMTI2LjE2OC0uMjMxdi0uNDg3bC0xLjIzNC4zOTF6bS44NTkgMS4xOWwuODIzLjI2LjQxMi0uMTI3di4zNzlsLS40MTIuMTMyLS44MjMtLjI2NHptLS40NDguNTA1di4yOTlsMS4yNzIuNDA4LjgyMy0uMjY0di0uM2wtLjgyMy4yNTl6IiBwYWludC1vcmRlcj0ic3Ryb2tlIGZpbGwgbWFya2VycyIgZmlsbD0iIzFiNDhjNCIvPjwvc3ZnPg%3D%3D&logoColor=224bbb&label=Smithed&labelColor=black&color=224bbb)](https://smithed.net/packs/smart_ore_generation) [![Modrinth](https://img.shields.io/modrinth/dt/smart_ore_generation?logo=modrinth&label=Modrinth)](https://modrinth.com/datapack/smart_ore_generation) [![PMC](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.planetminecraft.com%2Fdata-pack%2Fsmart-ore-generation%2Fstatsv2&query=%24.downloads&logo=data%3Aimage%2Fvnd.microsoft.icon%3Bbase64%2CAAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAABMLAAATCwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJdNAUBLJgD%2FSyYA%2FxkoD%2F8vKAn%2Fl00BgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2FwAAAP8AAAD%2FmVgI%2F0tcHf8CXjP%2FL10l%2FwAAAP8AAAD%2FAAAA%2FwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2F5VOAf%2BVTQH%2FfVkP%2FyZ%2BOv8BgET%2FAYBE%2FwGARP9LZyP%2FlU0B%2F5ZNAf8AAAD%2FAAAAAAAAAAAAAAAAAAAAAJVOAf%2FYeRL%2F64wl%2F7eZOP8Bo1f%2FAaNW%2FwGjVv88nkv%2F2oEb%2F9N0Df%2FTdA3%2FlU0B%2F5dNAUAAAAAAAAAAAAAAAACkVQH%2F3pAq%2F6CcOv92pUf%2FLLli%2F12zW%2F%2FBqEv%2Fy59B%2F%2B2OJ%2F%2Figxz%2F03QN%2F5VNAf%2BEUARAAAAAAAAAAAAAAAD%2FjoMq%2Fzi2XP96r1T%2F3ahG%2F%2BCvUP%2F9qkr%2F%2F6hL%2F%2F2kRP%2F2mTT%2F7Y4n%2F%2BCBGv93aRf%2FAAAA%2FwAAAAAAAAAAp1gB%2FxHEb%2F%2BlslX%2F36xL%2F9StTP%2F%2Fp0f%2F%2F6VE%2F%2F%2BqTv%2F%2Fqk7%2F%2FaVH%2F%2FecOf%2Ftjif%2FMIQ3%2FwNhMP8AAAAAAAAAAI9bA%2F8SxXD%2FHr5o%2Fzm8ZP%2Fvo0D%2F%2F6I9%2F%2F%2BiPf%2F%2Fq1D%2F%2F6tQ%2F%2F%2BrUP%2F7pEb%2F7Y4n%2FwGCQf8BYDD%2FAAAAAAAAAAB8Wgz%2FFMdy%2FxDDbv8Qw27%2Fh7Zd%2F%2F%2BnSP%2F%2Foj3%2F%2F6xS%2F%2F%2BsUv%2F%2Fp0j%2F%2B504%2F%2B2OJ%2F%2BUfyH%2FAWIw%2FwAAAAAAAAAAelsL%2Fwa2Y%2F8TxnH%2FieK4%2F9fu2P%2F%2F2rH%2F%2F6pN%2F%2F%2BlQv%2F%2FpUL%2F%2F6NA%2F%2F2fOv%2F1li%2F%2FlH8h%2FwJhMP8AAAAAqVcBQIFaCkABczz%2FFMdy%2F7Hs0P%2F%2F%2F%2F%2F%2F6O7W%2F9SyV%2F%2F%2Foj3%2F%2F6RC%2F%2FidOv%2Fxkyz%2FxJEw%2F01fGf8hWR1wAVQqQAAAAAAAAAAAAV4y%2Fw2%2Fa%2F%2Bs16b%2F1OfK%2F7%2Fdr%2F%2F%2BrFH%2F%2F6RB%2F%2F%2BmRv%2F2mzn%2F2Y4p%2F2qOOP8BVCr%2FJDorQAAAAAAAAAAAAAAAAAFeMv8BsF7%2FLbpl%2F0DAaP%2Bmtlz%2Fo7Vc%2F%2F%2BoS%2F%2F%2FqEv%2F9ps6%2FyeOQf8BjUb%2FAlQq%2FwFUKkAAAAAAAAAAAAAAAAAAAAAAAl0z%2FxheKf8PdTL%2FeqxN%2FyvDaf%2F8rVL%2Fz6dF%2F7R6H%2F8BXS7%2FAlQq%2FwdRKwIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABGUCICeF4GQGNfDP9sXwj%2FqFgB%2F4hbB%2F9DWiKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKpXAUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2FB8AAOAHAADAAwAAwAMAAMADAACAAQAAgAEAAIABAACAAQAAgAEAAMADAADAAwAAwAMAAOAHAAD8H%2F%2F%2F%2F%2F%2F%2F%2Fw%3D%3D&label=PMC&color=6ec310)](https://www.planetminecraft.com/data-pack/smart-ore-generation/) [![Discord](https://img.shields.io/discord/1216400498488377467?label=Discord&logo=discord)](https://discord.gg/anxzu6rA9F) [![StewBeet](https://img.shields.io/github/v/release/Stoupy51/StewBeet?logo=github&label=StewBeet)](https://github.com/Stoupy51/StewBeet) 🎮 A Minecraft data pack library for handling custom ore generation by using a smart system for ore location. * 🔄 This library is an addition to the vanilla ore generation system. It does not replace it. * 🤝 It has been designed to be compatible with other ore generation libraries. * 💎 This library only provide a way to generate ores in a smart way, it does not provide custom block functions. * 🌍 You can configure the library to generate ores in a specific dimension, or in all dimensions. * ⚡ It is working with custom overworld minimum height, a constant score is calculated for overworld only if needed. * 🌐 This library supports customs dimensions, but you must add them to the `denied_dimensions` function tag to prevent them from being scanned if you don't want them to be scanned. * ✨ The library will be working even if the world was generated before installing the library because it does not depend on world generation. 📦 This is an embedded library, so you package it inside your datapack as opposed to having a separate download. Requires [LanternLoad](https://github.com/LanternMC/load) to operate. 🔍 You can see on this image how ore patches are **always adjacent to air** blocks. ![image](https://cdn.modrinth.com/data/zpEM3sbc/images/51080a8f811cdd114653fd983c520fa1e210efb8.png)
# 📚 System explanation Every 5 seconds, the library run at the location of every player the following steps: * ⚡ Run a the function tag `denied_dimensions` to allow you to deny some dimensions from being scanned. * 🌍 If the dimension is allowed, 8 regions around players are scanned. (Default region size is 96x96) * 🔍 For each region, the library will check if is has already been scanned. If not, it will launch ore generation for this region. * 📍 Then, the function tag `generate_ores` is called at the origin of the region (0, 0, 0). * 💎 You can add your own ore generation function to this tag where you will be generating your ores depending on self-chosen conditions. (like dimensions, biomes, etc...) * 🎲 For every patch of ore you generate, you must use the random position function tag `random_position` to get a random position inside the region. This function tag will move the position to a random position and the nearest air block. Doing this way will prevent ores from being generated inside blocks and never be found by players (Adding lag to the server if the ore use an entity). So ores will be easier to find. * 🚫 And after every check, the library will save the region as "scanned" to prevent it from being scanned again by adding a `barrier block` at the origin of the region. * ✨ Finally, the function tag `post_generation` is called to allow you to do some post-generation tasks like running a function to all your newly generated ores to add some nbt tags to them or something else.
# 🔧 Function Tag ## 📥 Signals ### `#smart_ore_generation:v1/denied_dimensions` * 🔍 This function tag is called when the library want to scan a region. You can add which dimension you want to deny from being scanned by adding a function to this tag. * 📝 To use this signal, you must add a function to the tag list located in `data/smart_ore_generation/tags/function/v1/signals/denied_dimensions.json`. * 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.2/signals/denied_dimensions.mcfunction). ```mcfunction #> smart_ore_generation:v1.7.2/signals/denied_dimensions # # @within #smart_ore_generation:v1/signals/denied_dimensions # @executed as & at the player who triggered the event # @input score #authorized smart_ore_generation.data equals to 1 or 0 if another datapack has already denied generation # ## WARNING! # - You must check the #authorized score matching 1 before executing any commands to prevent reenable generation in a dimension that is disabled by another datapack. # - Putting the #authorized score to 0 will disable generation in the dimension for every datapack. ## Here is an example to disable generation in a dimension: execute if score #authorized smart_ore_generation.data matches 1 if predicate simplenergy:in_overworld run scoreboard players set #authorized smart_ore_generation.data 0 ## Another example: execute if score #authorized smart_ore_generation.data matches 1 if dimension minecraft:overworld run scoreboard players set #authorized smart_ore_generation.data 0 ``` ### `#smart_ore_generation:v1/generate_ores` * 🔍 This function tag is called when the library want to generate ores in a region. You can add your own ore generation function to this tag. * 📝 To use this signal, you must add a function to the tag list located in `data/smart_ore_generation/tags/function/v1/signals/generate_ores.json`. * 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.2/signals/example/generate_ores.mcfunction) ```mcfunction #> smart_ore_generation:v1.7.2/signals/generate_ores # # @within #smart_ore_generation:v1/signals/generate_ores # @executed as a special marker & at a position you shouldn't care about # ## WARNING! # - You must not use /kill @s in this file, or the entire library will stop working. # - Don't forget to edit #min_height and #max_height scores before trying to generate ores. # # @example from SimplEnergy datapack # This example generates 4 patches of Simplunium Ore in the overworld only # Per region and between world bottom (minecraft default: -64) and y=40 # Dimension score, 0 = overworld scoreboard players set #dimension smart_ore_generation.data -1 execute if predicate simplenergy:in_overworld run scoreboard players set #dimension smart_ore_generation.data 0 # Generate Simplunium Ore (x4) in the overworld only scoreboard players operation #min_height smart_ore_generation.data = _OVERWORLD_BOTTOM smart_ore_generation.data scoreboard players set #max_height smart_ore_generation.data 40 execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.2/signals/example/simplunium_ore execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.2/signals/example/simplunium_ore execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.2/signals/example/simplunium_ore execute if score #dimension smart_ore_generation.data matches 0 run function smart_ore_generation:v1.7.2/signals/example/simplunium_ore # See the template in the link for the content of the function smart_ore_generation:v1.7.2/signals/example/simplunium_ore.mcfunction ``` ### `#smart_ore_generation:v1/post_generation` * 🔄 This function tag is called when the library has finished generating ores in regions. You can add your own post-generation function to this tag. * 📝 To use this signal, you must add a function to the tag list located in `data/smart_ore_generation/tags/function/v1/signals/post_generation.json`. * 📖 Refer to this template for the content of the function [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.2/signals/example/post_generation.mcfunction) ```mcfunction #> smart_ore_generation:v1.7.2/signals/post_generation # # @within #smart_ore_generation:v1/signals/post_generation # @executed as none at none (default of a /schedule) # # This function is executed once after all the ore generation is done. # For example, if 6 regions are generated, this function will be executed 1 time after all the regions are generated. # It can be used to do some post-generation tasks, like running a function on all the ores you generated # instead of running it on each ore individually when you generate it. # Useful for optimisation. # # @example from SimplEnergy datapack # This example will edit entity nbt for simplunium ore and deepslate simplunium ore # if they have been generated all along the generation process. # This is useful for optimisation because you run the "secondary" function only once # instead of running it on each ore individually when you generate it. # Place simplunium ore if it has been generated execute if score #generated_ore simplenergy.data matches 1 as @e[tag=simplenergy.new_simplunium_ore] at @s run function simplenergy:place/simplunium_ore/secondary execute if score #generated_ore simplenergy.data matches 1 run scoreboard players reset #generated_ore simplenergy.data # Place deepslate simplunium ore if it has been generated execute if score #generated_deepslate_ore simplenergy.data matches 1 as @e[tag=simplenergy.new_deepslate_simplunium_ore] at @s run function simplenergy:place/deepslate_simplunium_ore/secondary execute if score #generated_deepslate_ore simplenergy.data matches 1 run scoreboard players reset #generated_deepslate_ore simplenergy.data ``` ## 📤 Slots ### `#smart_ore_generation:v1/slots/random_position` * This function tag should be called when you need a random position in the region. * To use properly this slot, see the template [here](https://github.com/Stoupy51/SmartOreGeneration/blob/main/build/datapack/data/smart_ore_generation/function/v1.7.2/signals/example/simplunium_ore.mcfunction) ```mcfunction #> smart_ore_generation:v1.7.2/signals/example/simplunium_ore # # @example from SimplEnergy datapack # Always launch the random position function tag before anything else # @TIP: The random position is not flat, is has a digit. # You can use the digit to generate ore on a specific way like below # It will try to place the ore patch depending on the digit # so on every line below, somes can fail making it more realistic # resulting in an ore patch containing between 2 and 6 ores (in this example) ## Try to find a random position adjacent to air in the region to generate the ore function #smart_ore_generation:v1/slots/random_position # Placing Simplunium Ore Patch execute at @s if block ~ ~ ~ #simplenergy:for_simplunium_ore run function simplenergy:calls/smart_ore_generation/simplunium_type execute at @s positioned ~0.8 ~0.8 ~0.8 if block ~ ~ ~ #simplenergy:for_simplunium_ore run function simplenergy:calls/smart_ore_generation/simplunium_type execute at @s positioned ~0.0 ~0.8 ~0.8 if block ~ ~ ~ #simplenergy:for_simplunium_ore run function simplenergy:calls/smart_ore_generation/simplunium_type execute at @s positioned ~0.8 ~0.8 ~0.0 if block ~ ~ ~ #simplenergy:for_simplunium_ore run function simplenergy:calls/smart_ore_generation/simplunium_type execute at @s positioned ~0.8 ~0.0 ~0.8 if block ~ ~ ~ #simplenergy:for_simplunium_ore run function simplenergy:calls/smart_ore_generation/simplunium_type execute at @s positioned ~0.0 ~0.8 ~0.0 if block ~ ~ ~ #simplenergy:for_simplunium_ore run function simplenergy:calls/smart_ore_generation/simplunium_type ``` ## ⭐ Star History