Installation

Adding Dependency

ⓘ

WordWeaver depends on the Adventure library.

In order to use WordWeaver you will need to download it using a BuildTool like Maven or Gradle. We also highly recommend relocating/shading the library into your own package.

WordWeaver depends on Kyori’s Adventure library. Unless you are using a Platform that natively ships Adventure like Paper, Velocity or Fabric, you will need to add Adventure as a dependency as well.

Gradle Kotlin DSL

Add Repository

build.gradle.kts


repositories {
    mavenCentral()
}

Add Dependency

build.gradle.kts


dependencies {
    implementation("io.github.milkdrinkers:WordWeaver:VERSION")
}

Shade Dependency

build.gradle.kts


plugins {
    id("com.gradleup.shadow") version "8.3.6"
}
 
tasks {
    shadowJar {
        relocate("io.github.milkdrinkers.wordweaver", "yourpackage.wordweaver")
    }
}

Gradle Groovy

Add Repository

build.gradle


repositories {
    mavenCentral()
}

Add Dependency

build.gradle


dependencies {
    implementation 'io.github.milkdrinkers:wordweaver:VERSION'
}

Shade Dependency

build.gradle


plugins {
    id 'com.gradleup.shadow' version '8.3.6'
}
 
tasks {
    shadowJar {
        relocate 'io.github.milkdrinkers.wordweaver', 'yourpackage.wordweaver'
    }
}

Maven

Add Dependency

pom.xml


<dependency>
    <groupId>io.github.milkdrinkers</groupId>
    <artifactId>wordweaver</artifactId>
    <version>VERSION</version>
</dependency>

Shade Dependency

pom.xml


<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>3.5.0</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <createDependencyReducedPom>false</createDependencyReducedPom>
        <relocations>
            <relocation>
                <pattern>io.github.milkdrinkers.wordweaver</pattern>
                <shadedPattern>yourpackage.wordweaver</shadedPattern>
            </relocation>
        </relocations>
    </configuration>
</plugin>

Well done! Next up have a look at usage.