> For the complete documentation index, see [llms.txt](https://docs.jackf.red/jackfredlib/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.jackf.red/jackfredlib/setup-with-gradle.md).

# Setup with Gradle

How to use JackFredLib in your projects

## Adding the repository

JackFredLib is available on my [Maven](https://maven.jackf.red/#/releases) repository. In your buildscript:

{% tabs %}
{% tab title="Gradle (Kotlin)" %}

```kts
repositories {
	maven {
		name = "JackFredMaven"
		url = uri("https://maven.jackf.red/releases/")
	}
}
```

{% endtab %}

{% tab title="Gradle (Groovy)" %}

```gradle
repositories {
	maven {
		name "JackFredMaven"
		url "https://maven.jackf.red/releases/"
	}
}
```

{% endtab %}
{% endtabs %}

## Adding modules

{% hint style="warning" %}
JackFredLib depends on [Fabric API](https://github.com/FabricMC/fabric) for all of it's modules.
{% endhint %}

{% hint style="info" %}
It's recommended to bundle JackFredLib in your mod via Gradle's `include` directive.
{% endhint %}

JackFredLib can either be included as a whole (excluding Config):

{% tabs %}
{% tab title="Gradle (Kotlin)" %}

```kts
dependencies {
        include(modImplementation("red.jackf.jackfredlib:jackfredlib:<VERSION>")!!)
}
```

{% endtab %}

{% tab title="Gradle (Groovy)" %}

```gradle
dependencies {
        include modImplementation "red.jackf.jackfredlib:jackfredlib:<VERSION>"
}
```

{% endtab %}
{% endtabs %}

Or, on a per-module basis:

{% tabs %}
{% tab title="Gradle (Kotlin)" %}

```kts
dependencies {
        include(modImplementation("red.jackf.jackfredlib:jackfredlib-base:<VERSION>")!!)
        include(modImplementation("red.jackf.jackfredlib:jackfredlib-colour:<VERSION>")!!)
        include(modImplementation("red.jackf.jackfredlib:jackfredlib-lying:<VERSION>")!!)
}
```

{% endtab %}

{% tab title="Gradle (Groovy)" %}

```gradle
dependencies {
        include modImplementation("red.jackf.jackfredlib:jackfredlib-base:<VERSION>")
        include modImplementation("red.jackf.jackfredlib:jackfredlib-colour:<VERSION>")
        include modImplementation("red.jackf.jackfredlib:jackfredlib-lying:<VERSION>")
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
You can find the latest versions for each modue on the [GitHub release feed](https://github.com/JackFred2/JackFredLib/releases).
{% endhint %}

{% hint style="warning" %}
Make sure you include any module dependencies - for example, the Lying module requires both the Colour and Base modules.
{% endhint %}