Skip to content

Commit

Permalink
Add NeoForge and Fabric dependency info
Browse files Browse the repository at this point in the history
  • Loading branch information
jpenilla committed Jan 24, 2024
1 parent 9ca084e commit 118687b
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/minecraft/modded/fabric.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## Installation

Cloud for Fabric is available through [Maven Central](https://central.sonatype.com/artifact/cloud.commandframework/cloud-fabric).

=== "Gradle (Kotlin)"

```kotlin
val cloudFabric = "cloud.commandframework:cloud-fabric:VERSION"
modImplementation(cloudFabric)
include(cloudFabric)
```

=== "Gradle (Groovy)"

```groovy
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": "*"
}
}
```
2 changes: 2 additions & 0 deletions docs/minecraft/modded/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@
| ----------------------- | -------------------------------- |
| 1.19.4+ | 2.0.0-SNAPSHOT |

Keep in mind only the latest release is supported.

## Common
60 changes: 60 additions & 0 deletions docs/minecraft/modded/neoforge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
## Installation

Cloud for NeoForge is available through [Maven Central](https://central.sonatype.com/artifact/cloud.commandframework/cloud-neoforge).

=== "Gradle (Kotlin, NeoGradle)"

```kotlin
jarJar.enable()

dependencies {
val cloudFabric = "cloud.commandframework:cloud-neoforge:VERSION"
implementation(cloudFabric)
jarJar(cloudFabric)
}
```

=== "Gradle (Groovy, NeoGradle)"

```groovy
jarJar.enable()

dependencies {
def cloudFabric = 'cloud.commandframework:cloud-neoforge:VERSION'
implementation(cloudFabric)
jarJar(cloudFabric)
}
```

=== "Gradle (Kotlin, Architectury Loom)"

```kotlin
val cloudFabric = "cloud.commandframework:cloud-neoforge:VERSION"
modImplementation(cloudFabric)
include(cloudFabric)
```

=== "Gradle (Groovy, Architectury Loom)"

```groovy
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"
```

0 comments on commit 118687b

Please sign in to comment.