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.

ⓘ

The core wordweaver artifact ships with a .properties parser. JSON/JSONC support lives in the optional wordweaver-json (you provide GSON) or wordweaver-json-shaded (GSON bundled and relocated) modules. Add one to your classpath and it registers automatically. Pick only one of the two JSON modules.

Gradle Kotlin DSL

Add Repository

build.gradle.kts


repositories {
    mavenCentral()
}

Add Dependency

The core only ships a .properties parser. Add a JSON parser module if you want JSON/JSONC support.

build.gradle.kts


dependencies {
    implementation("io.github.milkdrinkers:wordweaver:VERSION")
 
    // Option A, bring your own GSON
    implementation("io.github.milkdrinkers:wordweaver-json:VERSION")
    implementation("com.google.code.gson:gson:x.x.x")
 
    // Option B, uses bundled GSON (do NOT combine with Option A)
    implementation("io.github.milkdrinkers:wordweaver-json-shaded:VERSION")
}

Shade Dependency

When shading, merge service files so that every parser module stays registered.

build.gradle.kts


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

Gradle Groovy

Add Repository

build.gradle


repositories {
    mavenCentral()
}

Add Dependency

The core only ships a .properties parser. Add a JSON parser module if you want JSON/JSONC support.

build.gradle


dependencies {
    implementation 'io.github.milkdrinkers:wordweaver:VERSION'
 
    // Option A, bring your own GSON
    implementation 'io.github.milkdrinkers:wordweaver-json:VERSION'
    implementation 'com.google.code.gson:gson:x.x.x'
 
    // Option B, uses bundled GSON (do NOT combine with Option A)
    implementation 'io.github.milkdrinkers:wordweaver-json-shaded:VERSION'
}

Shade Dependency

When shading, merge service files so that every parser module stays registered.

build.gradle


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

Maven

Add Dependency

The core only ships a .properties parser. Add a JSON parser module if you want JSON/JSONC support.

pom.xml


<dependency>
    <groupId>io.github.milkdrinkers</groupId>
    <artifactId>wordweaver</artifactId>
    <version>VERSION</version>
</dependency>
 
<!-- Option A, bring your own GSON -->
<dependency>
    <groupId>io.github.milkdrinkers</groupId>
    <artifactId>wordweaver-json</artifactId>
    <version>VERSION</version>
</dependency>
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>x.x.x</version>
</dependency>
 
<!-- Option B, uses bundled GSON (do NOT combine with Option A) -->
<dependency>
    <groupId>io.github.milkdrinkers</groupId>
    <artifactId>wordweaver-json-shaded</artifactId>
    <version>VERSION</version>
</dependency>

Shade Dependency

When shading, merge service files so that every parser module stays registered. The ServicesResourceTransformer handles this.

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>
        <transformers>
            <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
        </transformers>
    </configuration>
</plugin>

Well done! Next up have a look at usage.