From fe6c5e915fc42a28a0e8906248d0c69e650aa855 Mon Sep 17 00:00:00 2001
From: C4 <29991504+TheIllusiveC4@users.noreply.github.com>
Date: Tue, 23 Jan 2024 22:08:56 -0800
Subject: [PATCH] Add Curios example datapack

---
 docs/assets/curios_example.zip  | Bin 0 -> 1986 bytes
 docs/curios/datapack-example.md | 139 ++++++++++++++++++++++++++++++++
 docs/curios/slot-register.md    |   4 +-
 3 files changed, 141 insertions(+), 2 deletions(-)
 create mode 100644 docs/assets/curios_example.zip
 create mode 100644 docs/curios/datapack-example.md

diff --git a/docs/assets/curios_example.zip b/docs/assets/curios_example.zip
new file mode 100644
index 0000000000000000000000000000000000000000..1a9027377e611df4a5a126349594a9c0373a6759
GIT binary patch
literal 1986
zcmWIWW@Zs#00H&MJ>g&ml;8o<DTyVC`pKn5nfb-~0dSRnCZVbnL{nLkn2xOcG@8NU
z*pz3Mq~;<taWHtSHjh}(zh=7~P_Y{jE8x~tl$n>VmsOmfxBA)Bpnw1^FWnQKK7OH_
zf;_y>X!>1c<esMbY|1h*=A(-oV-`5%rNw0x1tvvxhI*wX<<-S?33(_@o4#6%0pUON
zkN|}bQb@$7RwU*Y<fI~n$hTGI5kN(7APr<;(}59`#{`>D0$l~a#?-u$%#zGh<bZmz
z#yrB)aPgydpw90=Y)GUDFr&aB7ux5`b;v-#?YdY|yTR)@3&I5_8cOD7)SXIU@&5SE
zZ8c}w_kE4ix36@}UZ4_ZBP#JVke9u~Zer@5Q#)8<IuHI?f5PzdP7XEp{DUWJOjJ{T
zT9womI9fOVbS%qe=epE*F=&C^jg@s5UY@gi&-&%S4wkItE7_*_wXAdWo$LH{TVw66
zw;Qu6_8~>VMWC;M9)SZzAPY}`7U$%bAP35Ap!QHpt_$iwZCXIAON@4Cv?3>^b8EbS
z>B!&;<7c7ZphuHGcNYhH8%=Ipr0TkK<(`<Wa0hcRd;+Fd%OIvwn2jJ?2|5@(<wC8y
zMA*7?pmo3fl->set;q*sZXhm5OwQKJP0md%Nd)Bt2BxJ=N1o)UYPV)_i0e$56g4Mi
zN@T#Kne*AF1QwkM_E_t22AEMoJv?<hSuz7WPU{C1=;@w1qaSw3@e=2xZuV18)uu6&
zO3id!l2y4gi!s2Pkx7IBcToX!01ya3C}gh#vk5{cwxR=~1*8)#(Db1N2|_!zq6DEm
z639dfbBK0W!2&Y`d(i?igb`fG^x-xH9$m;j!d6&-OoN047bA+3kctkNdl(q76&?r^
zY;c$WFG>&wVJl1!29@GB2v!~-MHdGHw!#HuA|$A`6KNvMXmHL#4m)hQ9O2+zChTDc
z^*Joh!~D;|fGyV}TziHX<B-b$giEn!Z-miy%tW{pOX}fZz?P2@=B@>ri<GMayjj^m
Ok~~1z43yGj0r3EU#1#qv

literal 0
HcmV?d00001

diff --git a/docs/curios/datapack-example.md b/docs/curios/datapack-example.md
new file mode 100644
index 0000000..84fb8a8
--- /dev/null
+++ b/docs/curios/datapack-example.md
@@ -0,0 +1,139 @@
+---
+sidebar_position: 11
+---
+
+# Example Datapack
+
+An example datapack for configuring various curio mechanics, including adding slot types to entities and modifying
+existing slot types.
+
+## Getting Started
+
+First, download the [example datapack](../assets/curios_example.zip).
+
+Unzip the file and there will be the following folder structure:
+
+```
+|data
+--|curios
+  --|tags
+    --|items
+      --|ring.json
+--|curios_example
+  --|curios
+    --|entities
+      --|entities.json
+    --|slots
+      --|ring.json
+|pack.mcmeta
+```
+
+The `.mcmeta` file and `.json` files can be opened and edited in any text editor, such as Notepad.
+
+:::note
+
+**Why are there two folders for *curios* and *curios_example*?**
+
+The namespace used for this datapack is `curios_example`. The `curios_example` folder has a sub-folder called `curios`
+which houses the `entities` and `slots` folder. This is the custom data that is specifically for the Curios mod. On the
+other hand, the `curios` folder that houses the `tags` folder is using the name as a separate namespace for the purposes
+of adding item tags, which are read by vanilla.
+
+:::
+
+## Registering a New Slot Type
+
+Adding a new slot type is controlled by the `data/curios_example/curios/slots/example.json` file:
+
+```json
+{
+  "size": 1,
+  "add_cosmetic": true
+}
+```
+The file and file name specifies these properties for the slot type:
+* The identifier for the slot type is `example`, as denoted by the file name
+* The number of slots available is `1`, as denoted by the `"size"` field
+* Each slot of this slot type has an associated cosmetic slot, as denoted by the `"add_cosmetic"` field
+
+For more information on the fields and customization of slot types, please refer to [the slot types page](slot-register.md).
+
+## Modifying an Existing Slot Type
+
+Modifying an existing slot type is controlled by the `data/curios_example/curios/slots/ring.json` file:
+
+```json
+{
+  "size": 2,
+  "add_cosmetic": true
+}
+```
+The file and file name specifies these properties for the slot type:
+* The identifier for the slot type to change is `ring`, as denoted by the file name
+* The number of slots available is `2`, as denoted by the `"size"` field
+* Each slot of this slot type has an associated cosmetic slot, as denoted by the `"add_cosmetic"` field
+
+Note that this is exactly the same syntax as registering a new slot type. This is because modifying and registering a
+slot type both have the exact same process, the difference solely being whether multiple files exist for the same slot
+type or not.
+
+For more information on how slot types are modified from multiple files, please refer to [the slot types page](slot-register.md).
+
+## Adding Slot Types to One or More Entities
+
+Just creating the slot type isn't enough, as now it has to be added to one or more entities in order to appear anywhere.
+This is configured by the `data/curios_example/curios/entities/entities.json` file:
+
+```json
+{
+  "entities": [
+    "minecraft:player",
+    "minecraft:armor_stand"
+  ],
+  "slots": [
+    "back",
+    "body",
+    "belt",
+    "bracelet",
+    "charm",
+    "curio",
+    "example",
+    "hands",
+    "head",
+    "necklace",
+    "ring"
+  ]
+}
+```
+The file specifies these properties:
+* The slots being given are all the [preset slot types](preset-slots.md) and the `example` slot type created by this
+datapack, as denoted by the `"slots"` list
+* The entities being given slots are all players and armor stands, as denoted by the `"entities"` list
+
+For more information on the fields and customization of entity slots, please refer to [the entity slots page](entity-register.md).
+
+## Adding an Item to a Curio Slot
+
+Items are added to slot types by adding them to the relevant item tag. In the example datapack, an item tag for the
+`ring` slot type is created at `data/curios/tags/items/ring.json`:
+
+```json
+{
+  "replace": false,
+  "values": [
+    "minecraft:diamond"
+  ]
+}
+```
+
+The file name is the same as the identifier for the slot type and will be the name of the tag that is created. By
+setting `replace` to `false`, the values are added to the tag instead of replacing them. Listing `minecraft:diamond` in
+the `values` array will add the diamond item to the tag and consequently diamonds will be equippable in the `ring` slots.
+
+For more information on tags and item tags, please refer to the [page on the Minecraft wiki](https://minecraft.wiki/w/Tag).
+
+## Activating the Datapack
+
+Datapacks are created on a per-world basis and need to be placed in the `datapacks` folder of the `world` folder on a
+dedicated server or the `saves/(World Name)` folder in single player. They should automatically be enabled upon loading
+the datapack for the first time in the world.
diff --git a/docs/curios/slot-register.md b/docs/curios/slot-register.md
index 0164820..516d3dd 100644
--- a/docs/curios/slot-register.md
+++ b/docs/curios/slot-register.md
@@ -2,9 +2,9 @@
 sidebar_position: 1
 ---
 
-# Registering Slot Types
+# Registering and Editing Slot Types
 
-A tutorial on how to register slot types that are recognized by Curios.
+A tutorial on how to register and modify slot types that are recognized by Curios.
 
 ## Overview
 ---