⚙️ Features

• 📅 Daily streaks — a reward per day, a cooldown in hours or an unlock at midnight in the timezone you choose, and a streak that resets when a player stays away too long.
• ⌨️ Reward actions — [console], [player], [message], [actionbar], [title], [sound], [permission], [luck] and [close], with PlaceholderAPI placeholders in every line.
• 🧰 Configurable menu — slot, item and lore for every state of a day (available, claimed, next, locked), a live countdown, filler and custom buttons. Items support custom model data, item models (1.21.4+) and custom heads.
• 🔔 Join events — auto-claim after a delay, open the menu or remind the player when a reward is waiting.
• 🌈 MiniMessage — every message supports MiniMessage tags and legacy & color codes, side by side.
• 📝 Self-updating configs — new options appear in your config.yml and lang.yml after an update, and invalid values are rejected with a clear message instead of breaking a reload.
• 📇 SQLite and MariaDB — local storage out of the box, a shared database for networks.
• 🧵 Paper and Folia — one jar for Paper 1.16 and newer, including Folia.

...and more!

📥 Downloading & Installing

Download the latest release from Modrinth or Hangar and put it into your server's plugins folder. The server needs Java 17 or newer. On the first start NDailyRewards downloads the libraries it needs into plugins/NDailyRewards/libs and writes its config.yml and lang.yml.

Every option is explained in the documentation.

🧪 API

NDailyRewards fires events when a player claims a reward, gets one automatically and receives a reminder. Add the repository and the API to your project:

repositories {
    maven("https://repo.bxteam.org/releases")
}

dependencies {
    compileOnly("org.bxteam:ndailyrewards:3.4.0")
}

<repositories>
    <repository>
        <id>bx-team-releases</id>
        <url>https://repo.bxteam.org/releases</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>org.bxteam</groupId>
        <artifactId>ndailyrewards</artifactId>
        <version>3.4.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Then listen to them like any other Bukkit event:

@EventHandler
public void onClaim(PlayerClaimRewardEvent event) {
    event.getPlayer().sendMessage("You claimed the reward of day " + event.getDay());
}

🔨 Build from source

NDailyRewards needs JDK 17 or newer to build.

git clone https://github.com/BX-Team/NDailyRewards.git
cd NDailyRewards
./gradlew build             # the plugin jar lands in build/libs
./gradlew runServer         # start a Paper test server with the plugin, LuckPerms and PlaceholderAPI
./gradlew runFoliaServer    # the same on Folia
./gradlew runLegacyServer   # Paper 1.16.5, the oldest supported version

🤝 Contributing

Read the contributing guidelines first. Every pull request runs ./gradlew build, and the build is the only automated check, so test your change on a real server before opening one.

⚖️ License

This project is licensed under the GPL-3.0 License — see the LICENSE file for details.

💛 Credits

• BX-Team/Quark: Runtime libraries, configs, the scheduler and update checks.
• Revxrsal/Lamp: The command framework.
• j256/ormlite-core and brettwooldridge/HikariCP: Storage and connection pooling.
• PaperMC/adventure: Text components and MiniMessage.
• deanveloper/SkullCreator: The basis of the custom head support.