project(structure, docs): Redo docs and move around some files

Author: Jsinco

README.md

@@ -27,10 +27,10 @@ Please be aware that BiomesAPI is in active development, and some features may n
 
 ## Getting Started ⭐
 
-BiomesAPI is built using Gradle and is hosted on my repository (rep.jsinco.dev). To get started with BiomesAPI,
+BiomesAPI is built using Gradle and is hosted on my repository (repo.jsinco.dev). To get started with BiomesAPI,
 follow the instructions below to add BiomesAPI to your project.
 
-1. Find the latest version of BiomesAPI [HERE](https://repo.jsinco.dev/#/releases/me/outspending/biomesapi/BiomesAPI). Versions with a git commit has at the end are snapshot builds and may be unstable.
+1. Find the latest version of BiomesAPI [HERE](https://repo.jsinco.dev/#/releases/me/outspending/biomesapi/BiomesAPI). Versions with a git commit hash at the end are snapshot builds and may be unstable.
 2. Add the repository to your `build.gradle.kts`, `build.gradle`, or `pom.xml` file.
 
 And example for Gradle Kotlin DSL is provided below:

docs/src/content/docs/guides/components/biome-resource-key.mdx

@@ -0,0 +1,43 @@
+---
+title: BiomeResourceKey
+description: NamespacedKeys for custom biomes
+---
+
+import { Tabs, TabItem } from "@astrojs/starlight/components";
+
+The `BiomeResourceKey` is a common component in BiomesAPI that is used to identify biomes.
+It is used extensively throughout the interfaces in BiomesAPI and is functionally identical to Namespaced keys along with beind a wrapper around Minecraft's internal **Identifier** (or **ResourceLocation** in older versions).
+
+
+## Usage
+
+<Tabs syncKey="language">
+    <TabItem label="Java">
+```java
+public class ExampleClass {
+    public boolean exampleUsage() {
+        BiomeResourceKey resourceKey1 = BiomeResourceKey.of("example", "fancybiome");
+        String resourceKey1AsString = resourceKey1.toString();
+
+        BiomeResourceKey resouceKey2 = BiomeResourceKey.fromString(resourceKey1AsString);
+
+        return resourceKey1.equals(resouceKey2);
+    }
+}
+```
+    </TabItem>
+        <TabItem label="Kotlin">
+```kotlin
+class ExampleClass {
+    fun exampleUsage(): Boolean {
+        val resourceKey1 = BiomeResourceKey.of("example", "fancybiome")
+        val resourceKey1AsString = resourceKey1.toString()
+
+        val resourceKey2 = BiomeResourceKey.fromString(resourceKey1AsString)
+
+        return resourceKey1 == resourceKey2
+    }
+}
+```
+    </TabItem>
+</Tabs>

docs/src/content/docs/guides/components/block-replacement.mdx

@@ -0,0 +1,42 @@
+---
+title: BlockReplacement
+description: Block replacements for phony custom biomes
+---
+
+import { Tabs, TabItem } from "@astrojs/starlight/components";
+
+A `BlockReplacement` is a record of two materials. The first material **points** to what it should become.
+This component is only used when working with the [`PacketHandler`](/guides/components/packet-handler).
+A `BlockReplacement` makes a specific block type appear as another block without changing it on the server.
+
+
+## Usage
+
+<Tabs syncKey="language">
+    <TabItem label="Java">
+```java
+public class ExampleClass {
+    public boolean exampleUsage(@NotNull CustomBiome customBiome) {
+        // Makes all grass blocks appear as diamond blocks in the biome
+        BlockReplacement blockReplacement = BlockReplacement.of(Material.GRASS_BLOCK, Material.DIAMOND_BLOCK);
+
+        // Let's add it to our custom biome
+        customBiome.setBlockReplacements(blockReplacement);
+    }
+}
+```
+    </TabItem>
+        <TabItem label="Kotlin">
+```kotlin
+class ExampleClass {
+    fun exampleUsage(customBiome: CustomBiome) {
+        // Makes all grass blocks appear as diamond blocks in the biome
+        val blockReplacement = BlockReplacement.of(Material.GRASS_BLOCK, Material.DIAMOND_BLOCK);
+
+        // Let's add it to our custom biome
+        customBiome.setBlockReplacements(blockReplacement);
+    }
+}
+```
+    </TabItem>
+</Tabs>

docs/src/content/docs/guides/components/chunk-location.mdx

@@ -0,0 +1,42 @@
+---
+title: ChunkLocation
+description: Represents a chunk's x and z coordinates
+---
+
+import { Tabs, TabItem } from "@astrojs/starlight/components";
+
+A `ChunkLocation` simply represents a specific chunk's x and z coordinates.
+
+
+## Usage
+
+<Tabs syncKey="language">
+    <TabItem label="Java">
+```java
+public class ExampleClass {
+    public boolean exampleUsage(@NotNull Block block) {
+        // Get the chunk at 0, 0
+        ChunkLocation chunkLocation = ChunkLocation.of(0, 0);
+        ChunkLocation chunkLocation2 = ChunkLocation.fromBlockCoords(block.getX(), block.getZ());
+
+        // Check if the second chunk location is within a 4 chunk radius of the first one
+        return chunkLocation.isWithinRadius(chunkLocation2, 4);
+    }
+}
+```
+    </TabItem>
+        <TabItem label="Kotlin">
+```kotlin
+class ExampleClass {
+    fun exampleUsage(block: Block): Boolean {
+        // Get the chunk at 0, 0
+        val chunkLocation = ChunkLocation.of(0, 0)
+        val chunkLocation2 = ChunkLocation.fromBlockCoords(block.x, block.z)
+
+        // Check if the second chunk location is within a 4 chunk radius of the first one
+        return chunkLocation.isWithinRadius(chunkLocation2, 4)
+    }
+}
+```
+    </TabItem>
+</Tabs>

docs/src/content/docs/guides/creating-custom-biomes.mdx

@@ -0,0 +1,68 @@
+---
+title: The BiomeRegistry
+description: All about BiomesAPI's BiomeRegistry
+---
+
+import { Tabs, TabItem } from "@astrojs/starlight/components";
+
+The `BiomeRegistry` is abstraction of Minecraft's `worldgen/biome` registry.
+When using **BiomesAPI**, the `BiomeRegistry` is available to use, but is not generally needed since BiomeRegistry actions can be performed directly from `CustomBiome`s.
+(e.g. `CustomBiome#register` or `CustomBiome#modify`.)
+
+
+### Registry De-sync
+
+Adding biomes to the registry can be done at any point during your plugin's lifecycle, but players **must** relog because of registry de-sync!
+If you try to send a newly created `CustomBiome` either through the `BiomeSetter` or `BiomeHandler` to a player, their client will disconnect itself or crash!
+Minecraft's **worldgen/biome** registry is synced between the server and the client during the configuration phase and that phase **MUST** be repeated before a player can see a new biome!
+
+If you are using the `PacketHandler` to send biomes to players, you may include additional logic in your **conditional** to ensure players which have not yet re-logged do not see your newly created biome.
+If you are using the `BiomeSetter`, you will need to forcefully disconnect the client or intercept the biome packets yourself, less the client will disconnect or crash itself when rendering your biome.
+
+
+### Unregistering Biomes
+
+CustomBiomes, and by extension **Minecraft biomes in general** can not be unregistered (at least not easily). There is no limit to how many biomes you can register, but you cannot unregister them without
+fully restarting the server.
+
+
+## Examples
+
+<Tabs syncKey="language">
+    <TabItem label="Java">
+```java
+public class ExampleClass {
+
+    private static final BiomeRegistry BIOME_REGISTRY = BiomeRegistry.newRegistry();
+
+    public void exampleUsage(@NotNull CustomBiome customBiome) {
+        BIOME_REGISTRY.register(customBiome); // Registered!
+
+        // Let's change the color of our biome's foliage and modify it:
+        int red = 0xFF0000;
+        customBiome.setFoliageColor(red);
+        BIOME_REGISTRY.modify(customBiome);
+    }
+}
+```
+    </TabItem>
+        <TabItem label="Kotlin">
+```kotlin
+class ExampleClass {
+
+    companion object {
+        private val BIOME_REGISTRY: BiomeRegistry = BiomeRegistry.newRegistry()
+    }
+
+    fun exampleUsage(customBiome: CustomBiome) {
+        BIOME_REGISTRY.register(customBiome) // Registered!
+
+        // Let's change the color of our biome's foliage and modify it:
+        val red = 0xFF0000
+        customBiome.foliageColor = red
+        BIOME_REGISTRY.modify(customBiome)
+    }
+}
+```
+    </TabItem>
+</Tabs>