kjs-ori: add deep drill registration event docs

Author: rlnt

wikis/kubejs-oritech/.vitepress/config.mts

@@ -45,6 +45,7 @@ export default defineConfig({
             {
                 text: "Events",
                 items: [
+                    { text: "Deep Drill Registration", link: "event/deepdrill_registration" },
                     { text: "Soul Collection", link: "event/soulcollection" },
                     { text: "Tags", link: "event/tags" },
                 ],

wikis/kubejs-oritech/docs/event/deepdrill_registration.md

@@ -0,0 +1,67 @@
+# Deep Drill Registration Event
+
+This event is a utility event to allow registering new materials and recipes mined by the
+[Bedrock Extractor](../recipe/machine/bedrock_extractor.md) also known as the Deep Drill. Because the deep drill mechanic depends on a
+recipe and a tag, this event handles both of these registrations at the same time.
+
+If you prefer registering both of these separately, check out the Bedrock Extractor recipe page and the
+[tag documentation](tags.md#resource-nodes).
+
+**It is a server event and reloadable!**
+Keep in mind that server events have to be located inside the `kubejs/server_scripts` folder.
+
+## Overview
+
+Oritech uses the tag `oritech:resource_nodes` to determine which blocks can be mined from by the Bedrock Extractor. The item result
+is determined by a recipe. This event allows you to register new resource nodes and recipes for the Bedrock Extractor at the same time.
+
+-   access in a server script via: `EnderIOEvents.deepDrillRegistration`
+-   functions
+    -   `add(...)`
+        -   description: registers the input block as resource node and adds the recipe for the Bedrock Extractor
+        -   parameters:
+            -   `inputBlock`
+                -   type: `Block`
+                -   required: yes
+                -   description: the block that should be mined as a resource node; this block will be tagged with `oritech:resource_nodes` automatically
+            -   `outputItem`
+                -   type: `ItemStack`
+                -   required: yes
+                -   description: the item that should be the result of mining the resource node; can include count
+            -   `time`
+                -   type: `Integer`
+                -   required: no
+                -   default: `60`
+                -   description: time in ticks for a single extraction operation; can mine multiple ores at once occasionally
+            -   `id`
+                -   type: `ResourceLocation`
+                -   required: yes
+                -   description: the recipe ID for the recipe; this must be unique
+
+## Event Listener
+
+To access the event, the first thing you need to do is to open an event listener for the `deepDrillRegistration` event in a server script.
+
+```js
+EnderIOEvents.deepDrillRegistration(event => {
+    // ...
+})
+```
+
+After that, you can use the `add` function to register new resource nodes and recipes.
+
+## Example
+
+```js
+OritechEvents.soulCollection(event => {
+    // registers the glass block as a resource node
+    // adds a recipe that converts a glass block into a cobblestone
+    // defaults to 60 ticks / 3 seconds
+    event.add("glass", "cobblestone", "mymodpack:deep_drill/cobblestone")
+
+    // registers the dirt block as a resource node
+    // adds a recipe that converts a dirt block into 4 iron ingots
+    // requires 100 ticks / 5 seconds
+    event.add("dirt", "4x iron_ingot", 100, "mymodpack:deep_drill/iron_ingot")
+})
+```

wikis/kubejs-oritech/docs/event/tags.md

@@ -60,6 +60,10 @@ ServerEvents.tags("block", event => {
 
 ## Resource Nodes
 
+> [!DANGER] WARNING
+> Because the functionality of the Bedrock Extractor relies on a recipe **and** a tag, it is highly recommended to use the
+> [dedicated event](deepdrill_registration.md) for registering new recipes and resource nodes.
+
 Oritech uses the block tag `oritech:resource_nodes` to determine which blocks can be used as resource nodes for the
 [Bedrock Extractor](../recipe/machine/bedrock_extractor.md). Tagging a block is required if it's used as an input for the
 extractor recipe.
@@ -82,7 +86,7 @@ is captured inside the unstable container. There are 3 different levels of insta
 -   `oritech:unstable_container/medium` -> 1.0
 -   `oritech:unstable_container/high` -> 5.0
 
-Assigning these tags is also required to even capture a block inside of the safe.
+Assigning these tags is also required to capture a block inside of the safe.
 
 ```js
 ServerEvents.tags("block", event => {

wikis/kubejs-oritech/docs/recipe/machine/bedrock_extractor.md

@@ -4,6 +4,10 @@ Internally, this machine is called the Deep Drill.
 
 The Bedrock Extractor can mine ores from resource nodes that act as infinite sources of ores. These are usually found at Bedrock level.
 
+> [!DANGER] WARNING
+> Because the functionality of this machine relies on a recipe **and** a tag, it is highly recommended to use the
+> [dedicated event](../../event/deepdrill_registration.md) for registering new recipes and resource nodes.
+
 > [!WARNING] NOTE
 > This recipe inherits from the Oritech base recipe. [Read about it first](../basics.md) before reading this page.