Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add NeoForge and Fabric dependency info #25

Merged
merged 3 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/minecraft/modded/fabric.md
Original file line number Diff line number Diff line change
@@ -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": "*"
}
}
```
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
82 changes: 82 additions & 0 deletions docs/minecraft/modded/neoforge.md
Original file line number Diff line number Diff line change
@@ -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"
```
Loading