build: use modified installation advancement

Author: 2mal3

beet.yaml

@@ -15,7 +15,7 @@ data_pack:
 pipeline:
   - mecha
   - plugins.remove_empty_functions
-  - beet.contrib.installation_advancement
+  - plugins.installation_advancement
 require:
   - bolt
 

plugins/installation_advancement.py

@@ -0,0 +1,121 @@
+"""Plugin that generates an installation advancement.
+
+Installation advancements replace installation messages in an easily viewable
+and non-obstructive way by putting them on a single advancement page.
+
+Reference: https://mc-datapacks.github.io/en/conventions/datapack_advancement.html
+"""
+
+
+__all__ = [
+    "InstallationAdvancementOptions",
+    "installation_advancement",
+]
+
+
+from typing import Optional
+
+from beet import Advancement, Context, PluginOptions, configurable
+from beet.core.utils import JsonDict, TextComponent, normalize_string
+
+
+class InstallationAdvancementOptions(PluginOptions):
+    icon: JsonDict = {"item": "minecraft:apple"}
+    author_namespace: Optional[str] = None
+    author_description: str = ""
+    author_skull_owner: Optional[str] = None
+    project_namespace: Optional[str] = None
+    project_advancement_path: Optional[str] = None
+
+
+def beet_default(ctx: Context):
+    ctx.require(installation_advancement)
+
+
+@configurable(validator=InstallationAdvancementOptions)
+def installation_advancement(ctx: Context, opts: InstallationAdvancementOptions):
+    author_namespace = opts.author_namespace or normalize_string(ctx.project_author)
+    project_namespace = opts.project_namespace or ctx.project_id
+    project_advancement_path = (
+        opts.project_advancement_path
+        or f"{author_namespace}:{project_namespace}/installed"
+    )
+    skull_owner = opts.author_skull_owner or ctx.project_author
+
+    if not author_namespace:
+        raise ValueError(
+            "Missing author namespace. Either author or author_namespace need to be configured"
+        )
+
+    if not skull_owner:
+        raise ValueError(
+            "Missing skull owner. Either author or author_skull_owner need to be configured"
+        )
+
+    ctx.data["global:root"] = create_root_advancement()
+    ctx.data[f"global:{author_namespace}"] = create_author_advancement(
+        ctx.project_author, opts.author_description, skull_owner
+    )
+    ctx.data[project_advancement_path] = create_project_advancement(
+        f"{ctx.project_name} {ctx.project_version}", ctx.project_description, author_namespace, opts.icon
+    )
+
+
+def create_root_advancement():
+    return Advancement(
+        {
+            "display": {
+                "title": "Installed Datapacks",
+                "description": "",
+                "icon": {"item": "minecraft:knowledge_book"},
+                "background": "minecraft:textures/block/gray_concrete.png",
+                "show_toast": False,
+                "announce_to_chat": False,
+            },
+            "criteria": {"trigger": {"trigger": "minecraft:tick"}},
+        }
+    )
+
+
+def create_author_advancement(
+    author: TextComponent,
+    author_description: TextComponent,
+    skull_owner: str,
+):
+    return Advancement(
+        {
+            "display": {
+                "title": author,
+                "description": author_description,
+                "icon": {
+                    "item": "minecraft:player_head",
+                    "nbt": f"{{'SkullOwner': '{skull_owner}'}}",
+                },
+                "show_toast": False,
+                "announce_to_chat": False,
+            },
+            "parent": "global:root",
+            "criteria": {"trigger": {"trigger": "minecraft:tick"}},
+        }
+    )
+
+
+def create_project_advancement(
+    project_name: TextComponent,
+    project_description: TextComponent,
+    author_namespace: str,
+    icon: JsonDict,
+):
+    return Advancement(
+        {
+            "display": {
+                "title": project_name,
+                "description": project_description,
+                "icon": icon,
+                "announce_to_chat": False,
+                "show_toast": False,
+            },
+            "parent": f"global:{author_namespace}",
+            "criteria": {"trigger": {"trigger": "minecraft:tick"}},
+        }
+    )