Documentation

Posted 2026-05-03T03:32:55+00:00 • Updated 2026-05-03T03:32:55+00:00

Written By

Palm

Wayfarer implements a waypoint rendering system and extends upon the locator bar in a way that can utilized by mod developers for their projects.

Depending on Wayfarer¶

To make Wayfarer a dependency for your project, you will need to add it to your build.gradle (or build.gradle.kts for Kotlin).

It should look something like this:

repositories {
    maven {
        url "https://api.modrinth.com/maven"
    }
}

dependencies {
    // Example for Fabric
    modImplementation "maven.modrinth:wayfarerlib:1.0.0-beta.1-fabric"

    // Example for NeoForge
    implementation "maven.modrinth:wayfarerlib:1.0.0-beta.1-neoforge"
}

repositories {
    maven {
        url = uri("https://api.modrinth.com/maven")
    }
}

dependencies {
    // Example for Fabric
    modImplementation("maven.modrinth:wayfarerlib:1.0.0-beta.1-fabric")

    // Example for NeoForge
    implementation("maven.modrinth:wayfarerlib:1.0.0-beta.1-neoforge")
}

Best of Luck!¶

If you have further questions about the API, you can join our Discord Server.