feat: generate datapack overlays

Author: BPR02

TODO.md

@@ -0,0 +1,167 @@
+from typing import Any
+
+from beet import Context, NamespaceProxy
+
+
+def gen_dp_overlays(ctx: Context, ctx_overlay: Context, overlay_dir: str) -> None:
+    """
+    Generates overlays between two datapacks.
+
+    Keyword arguments:</br>
+    `ctx` -- the build context</br>
+    `ctx_overlay` -- the overlay context</br>
+    `overlay_dir` -- the directory of the overlay</br>
+    """
+    # create list of all datapack file types
+    file_types: list[tuple[NamespaceProxy[Any], NamespaceProxy[Any]]] = [
+        (ctx.data.advancements, ctx_overlay.data.advancements),
+        (ctx.data.functions, ctx_overlay.data.functions),
+        (ctx.data.item_modifiers, ctx_overlay.data.item_modifiers),
+        (ctx.data.loot_tables, ctx_overlay.data.loot_tables),
+        (ctx.data.predicates, ctx_overlay.data.predicates),
+        (ctx.data.recipes, ctx_overlay.data.recipes),
+        (ctx.data.trim_pattern, ctx_overlay.data.trim_pattern),
+        (ctx.data.trim_material, ctx_overlay.data.trim_material),
+        (ctx.data.structures, ctx_overlay.data.structures),
+        (ctx.data.chat_type, ctx_overlay.data.chat_type),
+        (ctx.data.damage_type, ctx_overlay.data.damage_type),
+        (ctx.data.banner_patterns, ctx_overlay.data.banner_patterns),
+        (ctx.data.wolf_variants, ctx_overlay.data.wolf_variants),
+        (ctx.data.enchantments, ctx_overlay.data.enchantments),
+        (ctx.data.enchantment_providers, ctx_overlay.data.enchantment_providers),
+        (ctx.data.jukebox_songs, ctx_overlay.data.jukebox_songs),
+        (ctx.data.painting_variants, ctx_overlay.data.painting_variants),
+        (ctx.data.block_tags, ctx_overlay.data.block_tags),
+        (ctx.data.entity_type_tags, ctx_overlay.data.entity_type_tags),
+        (ctx.data.fluid_tags, ctx_overlay.data.fluid_tags),
+        (ctx.data.function_tags, ctx_overlay.data.function_tags),
+        (ctx.data.game_event_tags, ctx_overlay.data.game_event_tags),
+        (ctx.data.item_tags, ctx_overlay.data.item_tags),
+        (ctx.data.chat_type_tags, ctx_overlay.data.chat_type_tags),
+        (ctx.data.damage_type_tags, ctx_overlay.data.damage_type_tags),
+        (ctx.data.banner_pattern_tags, ctx_overlay.data.banner_pattern_tags),
+        (ctx.data.cat_variant_tags, ctx_overlay.data.cat_variant_tags),
+        (ctx.data.enchantment_tags, ctx_overlay.data.enchantment_tags),
+        (ctx.data.instrument_tags, ctx_overlay.data.instrument_tags),
+        (ctx.data.painting_variant_tags, ctx_overlay.data.painting_variant_tags),
+        (
+            ctx.data.point_of_interest_type_tags,
+            ctx_overlay.data.point_of_interest_type_tags,
+        ),
+    ]
+    # for each file type, check for required overlays
+    for registry, registry_overlay in file_types:
+        check_registry(ctx, ctx_overlay, overlay_dir, registry, registry_overlay)
+
+    # get pack.mcmeta overlay entries
+    mcmeta: dict[str, dict[str, list[dict[str, Any]]]] = ctx.data.mcmeta.data.copy()
+    if "overlays" not in mcmeta:
+        mcmeta["overlays"] = {}
+    if "entries" not in mcmeta["overlays"]:
+        mcmeta["overlays"]["entries"] = []
+    entries = mcmeta["overlays"]["entries"]
+
+    # add overlays to pack.mcmeta
+    for overlay in ctx.data.overlays:
+        # check if it's the top-level overlay
+        if overlay == ctx.meta["observer"]["default_dir_dp"]:
+            # delete pack.mcmeta from overlay (requuired for tests)
+            default_dir = ctx.meta["observer"]["default_dir_dp"]
+            if ctx.data.overlays[default_dir].mcmeta:
+                del ctx.data.overlays[default_dir].mcmeta
+
+            # get pack format from build context
+            if "default_format" in ctx.meta["observer"]:
+                formats = ctx.meta["observer"]["default_format"]
+            else:
+                formats = ctx.data.mcmeta.data["pack"]["pack_format"]
+        else:
+            # get formats from overlay pack
+            if "supported_formats" in ctx_overlay.data.mcmeta.data["pack"]:
+                formats = ctx_overlay.data.mcmeta.data["pack"]["supported_formats"]
+            else:
+                formats = ctx_overlay.data.mcmeta.data["pack"]["pack_format"]
+
+        # update pack.mcmeta overlay entries
+        entries.append(
+            {
+                "formats": formats,
+                "directory": overlay,
+            }
+        )
+
+    # save overlay entries in pack.mcmeta
+    ctx.data.mcmeta.data.update({"overlays": {"entries": entries}})
+
+
+def check_registry(
+    ctx: Context,
+    ctx_overlay: Context,
+    overlay_dir: str,
+    registry: NamespaceProxy[Any],
+    registry_overlay: NamespaceProxy[Any],
+) -> None:
+    """
+    Generates overlays for each namespace proxy.
+
+    Keyword arguments:</br>
+    `ctx` -- the build context</br>
+    `ctx_overlay` -- the overlay context</br>
+    `overlay_dir` -- the directory of the overlay</br>
+    `registry` -- the namespace proxy from the build context</br>
+    `registry_overlay` -- the namespace proxy from the overlay context</br>
+    """
+    # check each file in the build pack
+    for name in list(registry):
+        if name in registry_overlay:
+            # exists in both, so check if an overlay is needed
+            gen_registry_overlay(ctx, overlay_dir, name, registry, registry_overlay)
+        else:
+            # exists only in overlay, so create a deletion overlay
+            gen_registry_overlay(
+                ctx, overlay_dir, name, registry, registry_overlay, "deletion"
+            )
+
+    # for all remaining files (of this type) in the overlay pack, add to build pack as an overlay
+    for name in list(registry_overlay):
+        gen_registry_overlay(
+            ctx, overlay_dir, name, registry, registry_overlay, "addition"
+        )
+
+
+def gen_registry_overlay(
+    ctx: Context,
+    overlay_dir: str,
+    name: str,
+    registry: NamespaceProxy[Any],
+    registry_overlay: NamespaceProxy[Any],
+    type: str = "",
+) -> None:
+    """
+    Checks if two functions have the same contents and generate an overlay if they don't.
+
+    Keyword arguments:</br>
+    `ctx` -- the build context</br>
+    `overlay_dir` -- the directory of the generated overlay</br>
+    `name` -- the name of the file</br>
+    `registry` -- the namespace proxy from the build context</br>
+    `registry_overlay` -- the namespace proxy from the overlay context</br>
+    `type` -- either "deletion" or "addition" (default: `""`)</br>
+    """
+    if type == "deletion":
+        # move file from build pack to overlay in build pack
+        default_dir = ctx.meta["observer"]["default_dir_dp"]
+        ctx.data.overlays[default_dir][name] = registry[name]
+        del registry[name]
+    elif type == "addition":
+        # move function from overlay pack to overlay in build pack
+        ctx.data.overlays[overlay_dir][name] = registry_overlay[name]
+    else:
+        # check if files are exactly the same
+        if registry[name] != registry_overlay[name]:
+            # move function from overlay pack to overlay in build pack
+            ctx.data.overlays[overlay_dir][name] = registry_overlay[name]
+
+    # remove file from overlay pack
+    if name in registry_overlay:
+        del registry_overlay[name]

beet_observer/data_pack.py

@@ -1,5 +1,44 @@
-from beet import Context
+from beet import Context, run_beet
+
+from .data_pack import *
+from .resource_pack import *
 
 
 def beet_default(ctx: Context):
-    return
+    if "observer" not in ctx.meta:
+        return
+    # get default directories
+    if "default_dir" not in ctx.meta["observer"]:
+        # default dir not defined
+        ctx.meta["observer"]["default_dir_dp"] = "default_overlay"
+        ctx.meta["observer"]["default_dir_rp"] = "default_overlay"
+    elif isinstance(ctx.meta["observer"]["default_dir"], str):
+        # default dir is the same for dp and rp
+        ctx.meta["observer"]["default_dir_dp"] = ctx.meta["observer"]["default_dir"]
+        ctx.meta["observer"]["default_dir_rp"] = ctx.meta["observer"]["default_dir"]
+    else:
+        # default dir is different for dp and rp
+        ctx.meta["observer"]["default_dir_dp"] = ctx.meta["observer"]["default_dir"][
+            "dp"
+        ]
+        ctx.meta["observer"]["default_dir_rp"] = ctx.meta["observer"]["default_dir"][
+            "rp"
+        ]
+    # loop through all overlays
+    for overlay in ctx.meta["observer"]["overlays"]:
+        # create relative path
+        path = f"{ctx.directory}/{overlay['process']}"
+        # generate context for overlay pack
+        with run_beet(
+            config={"data_pack": {"load": "."}, "resource_pack": {"load": "."}},
+            directory=path,
+        ) as ctx_overlay:
+            if "directory" not in overlay:
+                dp_dir = f"overlay_{ctx_overlay.data.pack_format}"
+                rp_dir = f"overlay_{ctx_overlay.assets.pack_format}"
+            else:
+                dp_dir = overlay["directory"]
+                rp_dir = overlay["directory"]
+            # compare build pack and overlay pack
+            gen_dp_overlays(ctx, ctx_overlay, dp_dir)
+            gen_rp_overlays(ctx, ctx_overlay, rp_dir)

beet_observer/plugin.py

@@ -0,0 +1,5 @@
+from beet import Context
+
+
+def gen_rp_overlays(ctx: Context, ctx_overlay: Context, directory: str):
+    return

beet_observer/resource_pack.py

@@ -0,0 +1,12 @@
+data_pack:
+  load: src
+  pack_format: 57
+  supported_formats: [48,57]
+
+pipeline:
+  - beet_observer
+
+meta:
+  observer:
+    overlays:
+      - process: nested/proc

examples/nested_overlay1/beet.yaml

@@ -0,0 +1 @@
+say an overlay is created for this

examples/nested_overlay1/nested/proc/data/demo/function/demo.mcfunction

@@ -0,0 +1 @@
+say this is the same in both

examples/nested_overlay1/nested/proc/data/demo/function/foo.mcfunction

@@ -0,0 +1,6 @@
+{
+  "pack": {
+    "pack_format": 48,
+    "description": ""
+  }
+}

examples/nested_overlay1/nested/proc/pack.mcmeta

@@ -0,0 +1 @@
+say this remains in the normal data folder

examples/nested_overlay1/src/data/demo/function/demo.mcfunction

@@ -0,0 +1 @@
+say this is the same in both