> For the complete documentation index, see [llms.txt](https://walksy.gitbook.io/walksylib-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://walksy.gitbook.io/walksylib-docs/setup/installing-walksylib.md).

# Installing WalksyLib

{% stepper %}
{% step %}

## Add the Modrinth Maven

In `build.gradle`:

```groovy
repositories {
    exclusiveContent {
        forRepository {
            maven {
                name = "Modrinth"
                url = "https://api.modrinth.com/maven"
            }
        }
        filter {
            includeGroup "maven.modrinth"
        }
    }
}
```

{% endstep %}

{% step %}

## Find the version for your Minecraft version

Open the [Versions tab](https://modrinth.com/mod/walksylib/versions) on Modrinth, filter by your Minecraft version, and copy the **version number** of the latest release. Version numbers look like:

```
2.0.0+26.2
2.0.0+26.1
```

```properties
walksylib_version=2.0.0+26.2
```

{% endstep %}

{% step %}

## Add the dependency

```groovy
dependencies {
    modImplementation "maven.modrinth:walksylib:${project.walksylib_version}"
}
```

Refresh Gradle.
{% endstep %}

{% step %}

## Declare it in `fabric.mod.json`

Add WalksyLib as a dependency, and register your config class under the `walksylib` entrypoint:

```json
{
  "entrypoints": {
    "main": [
      "com.example.mymod.MyMod"
    ],
    "walksylib": [
      "com.example.mymod.config.MyModConfig"
    ]
  },
  "depends": {
    "fabric-api": "*",
    "walksylib": ">=2.0.0"
  }
}
```

{% endstep %}
{% endstepper %}
