![\"\"](\"https:\/\/raw.githubusercontent.com\/ElectroBrine\/QuillNotifications\/master\/src\/main\/resources\/icon.png\"){kind=icon}
<\/p>\n
\n<\/p>\n
<\/p>\n
# Quill Notifications
\nA small Library mod to handle sending notifications to players both online and offline with style!<\/p>\n
# Usage
\nThis mod requires both Fabric API, and SQLib.<\/p>\n
Use of Adventure API is not required but encouraged.<\/p>\n
Once the mod is installed on your server, a config will be generated after the first launch. Be sure to edit this config and point it to a file path or a my sql database.<\/p>\n
# For Developers<\/p>\n
### Getting Started
\nTo include this mod in your project simply add it as a dependency:
\n“` gradle
\nrepositories {
\n maven { url “https:\/\/api.modrinth.com\/maven” }
\n \/\/ adventure api is not strictly necessary but is helpful and will allow you to use Component messages
\n maven {
\n name = “sonatype-oss-snapshots1”
\n url = “https:\/\/s01.oss.sonatype.org\/content\/repositories\/snapshots\/”
\n mavenContent { snapshotsOnly() }
\n }
\n}<\/p>\n
dependencies {
\n modImplementation(“maven.modrinth:quill:1.2.3”)
\n \/\/ adventure api is not strictly necessary but is helpful and allow you to use Component messages
\n modImplementation include(“net.kyori:adventure-platform-fabric:6.4.0”)
\n}
\n“`<\/p>\n
### General Usage
\n“` java
\nNotification notification = NotificationBuilder.Notification(receiverUUID) \/\/ Initalize a new notification to be sent
\n .setMessage(message) \/\/ setMessage() accepts String, MutableText, or Component variables (note that the notification will only save the last message set)
\n .setStyle(Scribe.INFO) \/\/ setStyle() only works for String messages
\n .setMetadata(jsonData) \/\/ inject json data into a message to be used with the event system
\n .setSound(SoundEvents.BLOCK_BELL_USE) \/\/ set a soundevent to be played when notification is received
\n .setCommands(commandString, commandString2) \/\/ set commands to be run when the notification is received
\n .setCommandDelay(10, TimeUnit.SECONDS) \/\/ set a delay that your commands will delayed for after the notification is sent (you can also pass in just a number for the ammount of millies to delay by)
\n .setExpiry(15, TimeUnit.MINUTES) \/\/ set a time from a message to expire, if the player doesnt come online before the expiry time elapes the notificaion will not be sent (you can also pass in just a number for the ammount of millies till expiry)
\n .build();
\nPigeon.send(notification); \/\/ send the notification to the player<\/p>\n
for (Notification message: QuillNotifications.getNotifications(receiverUUID)) { \/\/ get all pending notifications for a player (notifications are in order of oldest to newest)
\n if (notification.getMessage().toString().equals(“Test message plz delete”)) message.cancel() \/\/ cancel a notification before it gets sent to the player
\n}
\n“`<\/p>\n
### Event System
\n“` java
\n\/\/the event system gives you a notification object to modify the notification data before it gets sent
\nQuillEvents.PRE_SEND_NOTIFICATION.register((notification) -> {
\n System.out.println(notification.getPlayerEntity().getName().getString());
\n \/\/returning true allows the message to be sent, returning false will stop the
\n \/\/returning false will stop the message from being seen
\n return true;
\n \/\/ Do cool things with metadata or the other varibles idk the event system is your oyster.
\n});
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"
A small Library mod to handle sending notifications to players both online and offline with style!<\/p>\n","protected":false},"featured_media":127989,"template":"","meta":{"_minecraft_slug":"quill","_minecraft_project_id":"8dnqxlyA","_minecraft_author":"electrobrine","_minecraft_license":"CC0-1.0","_minecraft_downloads":2106,"_minecraft_follows":11,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"quill.zip","_minecraft_size_bytes":18052111,"_minecraft_version_count":50,"_minecraft_updated_at":"2026-05-16T00:06:33.466632Z","_minecraft_date_created":"2023-10-10T02:58:57.889755Z","_minecraft_date_modified":"2025-07-20T00:11:53.470712Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/quill","_minecraft_icon_attachment_id":127989,"_minecraft_imported_at":"2026-06-07T12:49:01+00:00","_minecraft_import_hash":"5f3172a567cc43abe67f59a3ccc3af0d","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,873,126,98,867,123,92],"mod_loader":[99,100],"minecraft_version":[48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,73,74,38,78],"class_list":["post-127988","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-library","mod_category-management","mod_category-quilt","mod_category-social","mod_category-technology","mod_category-utility","mod_loader-fabric","mod_loader-quilt","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5"],"yoast_head":"\n