NoRisk Client Server API Documentation¶
Overview¶
The NoRisk Client Server API enables server developers to create rich, interactive experiences for players using the NoRisk Client and to have more control over the API.
Supported Platforms¶
| Platform | Version | Status |
|---|---|---|
| Paper | 1.21+ | ✅ Supported |
| Spigot | 1.21+ | ✅ Supported |
| Fabric | 1.21+ | ✅ Supported |
| Velocity | 3.0+ | ✅ Supported |
| BungeeCord | Latest | ✅ Supported |
Getting Started¶
To use the NoRiskClient API, you need to add it as a dependency to your project.
Do not shade the API
It is important that you do not shade the NoRiskClient API into your plugin JAR. Doing so can cause conflicts.
Dependency Information¶
Add the following dependency to your project, replacing VERSION with the latest release (e.g., 0.1.1).
Choose the correct artifact for your platform: core, paper, velocity, spigot, bungeecord, or fabric.
<repository>
<id>norisk</id>
<url>https://maven.norisk.gg/repository/maven-releases/</url>
</repository>
<!-- Core (platform-agnostic) -->
<dependency>
<groupId>gg.norisk</groupId>
<artifactId>nrc-server-api-core</artifactId>
<version>VERSION</version>
</dependency>
<!-- Paper -->
<dependency>
<groupId>gg.norisk</groupId>
<artifactId>nrc-server-api-paper</artifactId>
<version>VERSION</version>
</dependency>
<!-- Velocity -->
<dependency>
<groupId>gg.norisk</groupId>
<artifactId>nrc-server-api-velocity</artifactId>
<version>VERSION</version>
</dependency>
<!-- Spigot -->
<dependency>
<groupId>gg.norisk</groupId>
<artifactId>nrc-server-api-spigot</artifactId>
<version>VERSION</version>
</dependency>
<!-- BungeeCord -->
<dependency>
<groupId>gg.norisk</groupId>
<artifactId>nrc-server-api-bungeecord</artifactId>
<version>VERSION</version>
</dependency>
<!-- Fabric -->
<dependency>
<groupId>gg.norisk</groupId>
<artifactId>nrc-server-api-fabric</artifactId>
<version>VERSION</version>
</dependency>
repositories {
maven {
url = uri("https://maven.norisk.gg/repository/maven-releases/")
}
}
dependencies {
// Core (platform-agnostic)
implementation "gg.norisk:nrc-server-api-core:VERSION"
// Paper
implementation "gg.norisk:nrc-server-api-paper:VERSION"
// Velocity
implementation "gg.norisk:nrc-server-api-velocity:VERSION"
// Spigot
implementation "gg.norisk:nrc-server-api-spigot:VERSION"
// BungeeCord
implementation "gg.norisk:nrc-server-api-bungeecord:VERSION"
// Fabric
implementation "gg.norisk:nrc-server-api-fabric:VERSION"
}
repositories {
maven("https://maven.norisk.gg/repository/maven-releases/")
}
dependencies {
// Core (platform-agnostic)
implementation("gg.norisk:nrc-server-api-core:VERSION")
// Paper
implementation("gg.norisk:nrc-server-api-paper:VERSION")
// Velocity
implementation("gg.norisk:nrc-server-api-velocity:VERSION")
// Spigot
implementation("gg.norisk:nrc-server-api-spigot:VERSION")
// BungeeCord
implementation("gg.norisk:nrc-server-api-bungeecord:VERSION")
// Fabric
implementation("gg.norisk:nrc-server-api-fabric:VERSION")
}
Note: Replace
VERSIONwith the latest release, e.g.0.1.1.Find the latest version:
Browse available versions ofnrc-server-api-corehere:
https://maven.norisk.gg/service/rest/repository/browse/maven-releases/gg/norisk/nrc-server-api-core/
Available Payloads¶
Toast Notifications¶
Display rich notifications with progress bars and player avatars.
Input Prompts¶
Create interactive text input dialogs with validation.
Action Wheel¶
Add custom commands to the client's action wheel.
Module Disabling¶
Dynamically enable/disable client modules.
Beacon Beams¶
Create colored beacon beams at specific coordinates.
Gamemode Override¶
Customize gamemode display in the client.
Support¶
For questions or support, join our Discord.