Add NeoForge and Fabric dependency info (#25)

Incendo · Jan 24, 2024 · a04f71a · a04f71a
1 parent c04a512
commit a04f71a
Show file tree

Hide file tree

Showing 3 changed files with 133 additions and 0 deletions.
diff --git a/docs/minecraft/modded/fabric.md b/docs/minecraft/modded/fabric.md
@@ -0,0 +1,49 @@
+# cloud-fabric
+
+## Installation
+
+Cloud for Fabric is available through [Maven Central](https://central.sonatype.com/artifact/cloud.commandframework/cloud-fabric).
+
+=== "Gradle (Kotlin)"
+
+    ```kotlin
+    repositories {
+      mavenCentral()
+    }
+
+    dependencies {
+      val cloudFabric = "cloud.commandframework:cloud-fabric:VERSION"
+      modImplementation(cloudFabric)
+      include(cloudFabric)
+    }
+    ```
+
+=== "Gradle (Groovy)"
+
+    ```groovy
+    repositories {
+      mavenCentral()
+    }
+
+    dependencies {
+      def cloudFabric = 'cloud.commandframework:cloud-fabric:VERSION'
+      modImplementation(cloudFabric)
+      include(cloudFabric)
+    }
+    ```
+
+### Versions
+
+See [here](./index.md#compatibility) for Minecraft version compatibility.
+
+### `fabric.mod.json`
+
+Merge the following into your `fabric.mod.json`:
+
+```json
+{
+  "depends": {
+    "cloud": "*"
+  }
+}
+```
diff --git a/docs/minecraft/modded/index.md b/docs/minecraft/modded/index.md
@@ -16,4 +16,6 @@
 | ----------------------- | -------------------------------- |
 | 1.19.4+                 | 2.0.0-SNAPSHOT                   |
 
+Keep in mind only the latest release is supported.
+
 ## Common
diff --git a/docs/minecraft/modded/neoforge.md b/docs/minecraft/modded/neoforge.md
@@ -0,0 +1,82 @@
+# cloud-neoforge
+
+## Installation
+
+Cloud for NeoForge is available through [Maven Central](https://central.sonatype.com/artifact/cloud.commandframework/cloud-neoforge).
+
+=== "Gradle (Kotlin, NeoGradle)"
+
+    ```kotlin
+    repositories {
+      mavenCentral()
+    }
+
+    jarJar.enable()
+
+    dependencies {
+      val cloudFabric = "cloud.commandframework:cloud-neoforge:VERSION"
+      implementation(cloudFabric)
+      jarJar(cloudFabric)
+    }
+    ```
+
+=== "Gradle (Groovy, NeoGradle)"
+
+    ```groovy
+    repositories {
+      mavenCentral()
+    }
+
+    jarJar.enable()
+
+    dependencies {
+      def cloudFabric = 'cloud.commandframework:cloud-neoforge:VERSION'
+      implementation(cloudFabric)
+      jarJar(cloudFabric)
+    }
+    ```
+
+=== "Gradle (Kotlin, Architectury Loom)"
+
+    ```kotlin
+    repositories {
+      mavenCentral()
+    }
+
+    dependencies {
+      val cloudFabric = "cloud.commandframework:cloud-neoforge:VERSION"
+      modImplementation(cloudFabric)
+      include(cloudFabric)
+    }
+    ```
+
+=== "Gradle (Groovy, Architectury Loom)"
+
+    ```groovy
+    repositories {
+      mavenCentral()
+    }
+
+    dependencies {
+      def cloudFabric = 'cloud.commandframework:cloud-neoforge:VERSION'
+      modImplementation(cloudFabric)
+      include(cloudFabric)
+    }
+    ```
+
+### Versions
+
+See [here](./index.md#compatibility) for Minecraft version compatibility.
+
+### `mods.toml`
+
+Add the following to your `mods.toml`:
+
+```toml
+[[dependencies.your_mod_id]]
+modId = "cloud"
+type = "required"
+versionRange = "[1.0,)"
+ordering = "NONE"
+side = "BOTH"
+```