CourierAPI

Quick rating

CourierAPI

No reviews yet

CourierAPI is a Fabric mod library that lets any mod send animated HUD notification cards to players — via the Java API, JSON files, or in-game commands. Supports server-to-client broadcasting and client-side local display.

QoL & Tweaks
API/Library
Mod Loaders
Fabric
Minecraft

Community voices

Reviews

Versions
Loading versions…
Match includes

Click once to include, again to exclude, again to clear

Rating Any
Any 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0
Min
Max
Play Status
Reviews
Time Played
hrs+
Verified developers only
Has developer response
List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Delete this review?

This removes your review from the project. You can write a new review after.

Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

Compatibility

Supported Environments

Dev Environment
Client Required
Server Optional

About

Project Details

Type
Mod
License
MIT License
Latest Version
CourierAPI 0.1-26.1.2
Authors
CurseForge
Modrinth

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

CurseForge ID
Modrinth ID

Resources

External Links

Source Issues Wiki Discord

About

Description

CourierAPI Logo.

CourierAPI is a Fabric mod library that lets any mod send animated HUD notification cards to players — via the Java API, JSON files, or in-game commands. Supports server-to-client broadcasting and client-side local display.


Features

  • Animated slide-in / slide-out cards in the top-right corner of the HUD
  • Fully customizable colors — title, description, background, and border accent (ARGB)
  • Configurable display duration per notification
  • Up to 4 notifications visible at once; extras queue automatically
  • Description wraps to a second line when text is too long
  • Server → Client — send notifications via Java API or JSON files, no coding required
  • Client-only — display notifications locally from another client mod without a server
  • Drop-in /courier command for operators
  • Auto-creates a sample couriernotifications.json on first server start

For Developers

Add to your gradle.properties:

courierapi_version=0.1

Then in build.gradle:

repositories {
    maven {
        name = "LunazStudios"
        url  = "https://maven.lunazstudios.com/releases"
    }
}

dependencies {
    modImplementation "com.lunazstudios:CourierAPI:${project.minecraft_version}-${project.courierapi_version}"
}

Full documentation and API usage examples are available on the GitHub repository.


Server API

Notification n = Notification.builder("Event Started!", "Head to the arena.")
        .durationSeconds(6)
        .borderColor(0xFFFF4444)
        .build();

CourierAPI.send(player, n);        // single player
CourierAPI.broadcast(server, n);   // all online players

Client API

// Client-side only — do not call on a dedicated server
CourierClientAPI.showLocal(n);

JSON — No Coding Required

Place couriernotifications.json in your server root to define reusable notifications:

{
  "restart_warning": {
    "title": "Server Restart",
    "description": "The server restarts in 5 minutes.",
    "duration": 8,
    "border_color": "#FF5555"
  }
}

Trigger them in-game with /courier send restart_warning, or drop entries into couriernotifications_queue.json to dispatch from external scripts or RCON — no restart needed.


Commands

Command Description
/courier send <id> Broadcast a notification to all online players
/courier reload Reload couriernotifications.json from disk

Requires permission level 2 (operator).

CourierAPI Logo.

CourierAPI is a Fabric mod library that lets any mod send animated HUD notification cards to players — via the Java API, JSON files, or in-game commands. Supports server-to-client broadcasting and client-side local display.


Features

  • Animated slide-in / slide-out cards in the top-right corner of the HUD
  • Fully customizable colors — title, description, background, and border accent (ARGB)
  • Configurable display duration per notification
  • Up to 4 notifications visible at once; extras queue automatically
  • Description wraps to a second line when text is too long
  • Server → Client — send notifications via Java API or JSON files, no coding required
  • Client-only — display notifications locally from another client mod without a server
  • Drop-in /courier command for operators
  • Auto-creates a sample couriernotifications.json on first server start

For Developers

Add to your gradle.properties:

courierapi_version=0.1

Then in build.gradle:

repositories {
    maven {
        name = "LunazStudios"
        url  = "https://maven.lunazstudios.com/releases"
    }
}

dependencies {
    modImplementation "com.lunazstudios:CourierAPI:${project.minecraft_version}-${project.courierapi_version}"
}

Full documentation and API usage examples are available on the GitHub repository.


Server API

Notification n = Notification.builder("Event Started!", "Head to the arena.")
        .durationSeconds(6)
        .borderColor(0xFFFF4444)
        .build();

CourierAPI.send(player, n);        // single player
CourierAPI.broadcast(server, n);   // all online players

Client API

// Client-side only — do not call on a dedicated server
CourierClientAPI.showLocal(n);

JSON — No Coding Required

Place couriernotifications.json in your server root to define reusable notifications:

{
  "restart_warning": {
    "title": "Server Restart",
    "description": "The server restarts in 5 minutes.",
    "duration": 8,
    "border_color": "#FF5555"
  }
}

Trigger them in-game with /courier send restart_warning, or drop entries into couriernotifications_queue.json to dispatch from external scripts or RCON — no restart needed.


Commands

Command Description
/courier send <id> Broadcast a notification to all online players
/courier reload Reload couriernotifications.json from disk

Requires permission level 2 (operator).

Screenshots

Gallery

  • Notifications in action
    Notifications in action
  • Up to 4 notifications
    Up to 4 notifications
  • Notifications on Screen
    Notifications on Screen
  • Notifications Animation
    Notifications Animation

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

<1,000
Total Downloads
CurseForge
<1,000
Modrinth
<1,000
Last Updated
CurseForge
Created
CurseForge
Modrinth
Last synced
When ModDex last fetched this project from CurseForge or Modrinth. Every project is re-checked on a schedule, and any project that ships a new file is synced automatically within hours of the release.
New file updates sync automatically
How syncing works