API Documentation Getting Started

Gradle Setup

To get stared with developing with Shoulder Surfing Reloaded you need to add it as a dependency to your build.gradle[.kts]. The following sections will explain you how to that using either Modrinth Maven or Curse Maven. All examples use the Gradle Kotlin DSL.

Repository Configuration

Using Modrinth Maven

repositories {
    exclusiveContent {
        forRepository {
            maven("https://api.modrinth.com/maven")
        }
        forRepositories(fg.repository) // Only add this if you're using ForgeGradle, otherwise remove this line
        filter {
            includeGroup("maven.modrinth")
        }
    }
}

Using Curse Maven

repositories {
    maven("https://www.cursemaven.com") {
        content {
            includeGroup("curse.maven")
        }
    }
}

Dependency Configuration

The latest API version of Shoulder Surfing Reloaded can be found here.

Using Modrinth Maven

You can view the documentation for Modrinth Maven here.

dependencies {
    // Fabric
    modImplementation("maven.modrinth:shoulder-surfing-reloaded:${shouldersurfing_version}")
    // Forge and NeoForge
    implementation("maven.modrinth:shoulder-surfing-reloaded:${shouldersurfing_version}")
}

Using Curse Maven

Please note that Curse Maven requires the file ID and not the version of Shoulder Surfing Reloaded. You can view the documentation for Curse Maven here.

dependencies {
    // Fabric
    modImplementation("curse.maven:shoulder-surfing-reloaded-243190:${shouldersurfing_api_version}")
    // Forge and NeoForge
    implementation("curse.maven:shoulder-surfing-reloaded-243190:${shouldersurfing_api_version}")
}