Merge branch 'main' into update-order-and-refactor

Author: oskarscot

.prettierignore

@@ -1,2 +1,3 @@
 /content/docs/**/*.mdx
+!/content/docs/en/official-documentation/**
 /messages/*-*.json

.prettierrc

@@ -1,3 +1,4 @@
 {
-  "plugins": ["prettier-plugin-tailwindcss"]
+  "plugins": ["prettier-plugin-tailwindcss"],
+  "embeddedLanguageFormatting": "auto"
 }

content/docs/en/guides/plugin/item-interaction.mdx

@@ -7,7 +7,7 @@ authors:
 ---
 import { File, Folder, Files } from 'fumadocs-ui/components/files';
 
-Creating a custom item follows the same setup than the [Creating custom blocks](./creating-block.mdx).
+Creating a custom item follows the same setup than the [Creating custom blocks](./creating-block).
 
 ## Setup
 

content/docs/en/guides/plugin/store-persistant-data.mdx

@@ -14,7 +14,7 @@ Here is how to store persistent data using a custom component on a Player.
 
 ## Build your Component Class
 
-Creating a custom component class leverages the Component system made with the ECS architecture in mind. For more information on Components, check out the [ECS Guide](../ecs/hytale-ecs-theory.mdx#components).
+Creating a custom component class leverages the Component system made with the ECS architecture in mind. For more information on Components, check out the [ECS Guide](../ecs/hytale-ecs-theory#components).
 
 Start by creating your custom component class. This will be extremely similar to how regular components are created, however we'll setup a custom Codec so the server can translate this data to BSON, or the server's internal json encoder.
 

content/docs/en/meta.json

@@ -3,6 +3,8 @@
     "index",
     "quick-start",
     "established-information",
+    "---Official Documentation---",
+    "...official-documentation",
     "---Guides---",
     "...guides",
     "---Documentation---",

content/docs/en/official-documentation/npc-doc.mdx

@@ -0,0 +1,5 @@
+{
+  "title": "{meta.official_documentation.worldgen.title}",
+  "icon": "Earth",
+  "pages": ["pack-tutorial", "worldgen-tutorial", "technical-hytale-generator"]
+}

content/docs/en/official-documentation/worldgen/meta.json

@@ -0,0 +1,101 @@
+---
+title: Asset Packs
+description: Covers how to create and install Asset Packs
+icon: Bookmark
+authors:
+  - name: "Hypixel Studios Canada Inc."
+    url: "https://hytale.com"
+---
+
+<OfficialDocumentationNotice />
+
+# How to modify Hytale
+
+## What's an Asset Pack
+
+Hytales gameplay is driven by assets in the game that can be modified by creators. Asset Packs are our solution to let you override or add features to the base game with your own work. These can in the form of zip files of folders, which contain a custom set of assets. This is not the only way for a creator to change Hytale but this is the most accessible form.;
+
+### How do I make an Asset Pack
+
+<video controls className="my-6 aspect-video w-full rounded-lg border">
+  <source
+    src="https://cdn.internal.hytalemodding.dev/guides/official/how-to-asset-pack.mp4"
+    type="video/mp4"
+  />
+</video>
+{/* {% include "../.gitbook/includes/requirements.md" %} */}
+
+An asset pack is typically a zip or folder, with a `manifest.json` inside. This can be created either using our ingame asset editor, or in your file browser. All Asset Packs require a manifest and the assets must be located in the correct folders. For this reason we recommend using the Asset Editor.
+
+```json title="manifest.json"
+{
+  "Group": "My Group",
+  "Name": "Pack Example",
+  "Version": "1.0.0",
+  "Description": "An Example Asset Pack",
+  "Authors": [
+    {
+      "Name": "Me",
+      "Email": "",
+      "Url": ""
+    }
+  ],
+  "Website": "",
+  "Dependencies": {},
+  "OptionalDependencies": {},
+  "LoadBefore": {},
+  "DisabledByDefault": false,
+  "IncludesAssetPack": false,
+  "SubPlugins": []
+}
+```
+
+### Where are they stored
+
+Asset Packs are stored with other mods in the Mods folder.
+
+```
+C:\Users\<user>\AppData\Roaming\Hytale\UserData\Mods
+```
+
+Mods and Asset Packs are also stored per world, this is where Asset Packs land when created with the Asset Editor.;
+
+```
+C:\Users\<user>\AppData\Roaming\Hytale\UserData\Saves\New World 5\mods
+```
+
+<Callout type="warning">
+  When creating an Asset Pack in-game with the Asset Editor, they are currently
+  stored in that world. This means to access the pack in other worlds you need
+  to copy the pack into your Mods folder.
+</Callout>
+
+---
+
+<video controls className="my-6 aspect-video w-full rounded-lg border">
+  <source
+    src="https://cdn.internal.hytalemodding.dev/guides/official/how-to-install.mp4"
+    type="video/mp4"
+  />
+</video>
+
+When you have Asset Packs or Mods installed, these will appear in the New World menu under the Options menu.;
+
+### How do I change an existing asset
+
+<video controls className="my-6 aspect-video w-full rounded-lg border">
+  <source
+    src="https://cdn.internal.hytalemodding.dev/guides/official/how-to-asset.mp4"
+    type="video/mp4"
+  />
+</video>
+
+<Callout type="warning">You must create an Asset Pack</Callout>
+
+All creators are free to modify our existing assets, to do so you must create an Asset Pack. Assets that exist inside of Asset Packs override the asset from the base game. You are also able to add new assets the same way.;
+
+### Notes
+
+- Can be downloaded from hosting sites such as CurseForge.
+- Exist entirely on the server.
+  - Only the server or world host has to download Asset Packs and Mods.;

content/docs/en/official-documentation/worldgen/pack-tutorial/asset-packs.mdx

@@ -0,0 +1,4 @@
+{
+  "title": "{meta.official_documentation.worldgen.pack_tutorial.title}",
+  "icon": "Package"
+}

content/docs/en/official-documentation/worldgen/pack-tutorial/meta.json

@@ -0,0 +1,137 @@
+---
+title: Assignments
+description: Assigns Props to each position in a Positions field.
+authors:
+  - name: "Hypixel Studios Canada Inc."
+    url: "https://hytale.com"
+---
+
+<OfficialDocumentationNotice />
+
+### Constant
+
+Assigns a Prop to all positions.
+
+#### Parameters:
+
+<ParameterList
+  parameters={[
+    {
+      name: "Prop",
+      description: "Prop slot",
+    },
+  ]}
+/>
+
+---
+
+### FieldFunction
+
+Allows you to select which props to assign based on a Density field and your configured delimiters. The Density's value at each position determines which delimiter's Prop to assign.;
+
+#### Parameters:
+
+<ParameterList
+  parameters={[
+    {
+      name: "FieldFunction",
+      description: "Density slot.",
+    },
+    {
+      name: "Delimiters",
+      description:
+        "list of noise value delimiters attaching Props to value ranges of the Density field.",
+    },
+    {
+      name: "Min",
+      description: "decimal number. Lower inclusive bound of the delimiter.",
+    },
+    {
+      name: "Max",
+      description: "decimal number. Higher exclusive bound of the delimiter.",
+    },
+    {
+      name: "Assignments",
+      description:
+        "Assignments asset slot. The assignment provigint he Props to use.",
+    },
+  ]}
+/>
+
+---
+
+### Sandwich
+
+Allows you to select which props to assign based on their vertical (world Y) position and your configured delimiters. Depending on each position’s height in the world the Prop of the matching delimiter will be assigned.
+
+![Image showcasing sandwich tool](/assets/official-documentation/worldgen/technical-hytale-generator/assignments/sandwich.png)
+
+#### Parameters:
+
+<ParameterList
+  parameters={[
+    {
+      name: "Delimiters",
+      description: "list of world height delimiter assets.",
+    },
+    {
+      name: "MinY",
+      description: "decimal number. Lower inclusive bound of the delimiter.",
+    },
+    {
+      name: "MaxY",
+      description: "decimal number. Higher exclusive bound of the delimiter.",
+    },
+    {
+      name: "Assignments",
+      description: "Assignments asset slot.",
+    },
+  ]}
+/>
+
+---
+
+### Weighted
+
+Picks which Prop to assign randomly based on weights and a seed.
+
+#### Parameters:
+
+<ParameterList
+  parameters={[
+    {
+      name: "Seed",
+      description: "string.",
+    },
+    {
+      name: "SkipChance",
+      description:
+        "decimal number between 0.0 and 1.0. Determines the chance to skip a position completely without assigning it a Prop.",
+    },
+    {
+      name: "WeightedAssignments",
+      description: "List of weighted Assignments slots.",
+    },
+    {
+      name: "Assignments",
+      description: "Assignments asset slot.",
+    },
+  ]}
+/>
+
+---
+
+### Imported
+
+Imports an exported Assignments.
+
+#### Parameters:
+
+<ParameterList
+  parameters={[
+    {
+      name: "Name",
+      description: "string. The exported Assignments.",
+    },
+  ]}
+/>