From b0f6ff225ddf6a2466e7d6d2079ebf26185c3653 Mon Sep 17 00:00:00 2001 From: Jason Penilla <11360596+jpenilla@users.noreply.github.com> Date: Tue, 23 Jan 2024 23:39:48 -0700 Subject: [PATCH 1/2] Add NeoForge and Fabric dependency info --- docs/minecraft/modded/fabric.md | 47 ++++++++++++++++++ docs/minecraft/modded/index.md | 2 + docs/minecraft/modded/neoforge.md | 80 +++++++++++++++++++++++++++++++ 3 files changed, 129 insertions(+) diff --git a/docs/minecraft/modded/fabric.md b/docs/minecraft/modded/fabric.md index e69de29..41e4ebc 100644 --- a/docs/minecraft/modded/fabric.md +++ b/docs/minecraft/modded/fabric.md @@ -0,0 +1,47 @@ +## 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 index 8cd3451..cb06e96 100644 --- 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 index e69de29..c5699f0 100644 --- a/docs/minecraft/modded/neoforge.md +++ b/docs/minecraft/modded/neoforge.md @@ -0,0 +1,80 @@ +## 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" +``` From a3d2c5d73789b5e13f7b66ed8a9ecf8b9090eaf9 Mon Sep 17 00:00:00 2001 From: Jason Penilla <11360596+jpenilla@users.noreply.github.com> Date: Tue, 23 Jan 2024 23:59:21 -0700 Subject: [PATCH 2/2] Add headers --- docs/minecraft/modded/fabric.md | 2 ++ docs/minecraft/modded/neoforge.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/minecraft/modded/fabric.md b/docs/minecraft/modded/fabric.md index 41e4ebc..1a95198 100644 --- a/docs/minecraft/modded/fabric.md +++ b/docs/minecraft/modded/fabric.md @@ -1,3 +1,5 @@ +# cloud-fabric + ## Installation Cloud for Fabric is available through [Maven Central](https://central.sonatype.com/artifact/cloud.commandframework/cloud-fabric). diff --git a/docs/minecraft/modded/neoforge.md b/docs/minecraft/modded/neoforge.md index c5699f0..56c1e19 100644 --- a/docs/minecraft/modded/neoforge.md +++ b/docs/minecraft/modded/neoforge.md @@ -1,3 +1,5 @@ +# cloud-neoforge + ## Installation Cloud for NeoForge is available through [Maven Central](https://central.sonatype.com/artifact/cloud.commandframework/cloud-neoforge).