Skip to content

BX-Team/NDailyRewards

Repository files navigation

readme-banner.png

Available on Modrinth

Chat on Discord Read the Docs Available on BStats

Welcome to NDailyRewards

NDailyRewards is a simple and lightweight plugin that allows you to reward your players for playing on your server every day.

ℹ️ Information

  • NDailyRewards fully supports Minecraft from 1.16 through 1.21.
  • Requires Java 17 or later to work properly. For older versions of Java, this may affect the functionality of the plugin.

✨ Features

  • 📇 MariaDB and SQLite support
  • ⚙️ High adjustable and simple configuration
  • 🌈 HEX Colors with gradient support
  • ⌨️ Various action types for rewards
  • 📄 PlaceholderAPI Support
  • 📝 Customizable and Translatable Messages
  • 😎 Custom model data support
  • 🔁 Auto claim rewards
  • 🔔 Join notifications and auto-GUI opening
  • ...and more!

🛠️ Development Builds

Get the latest development builds from our GitHub Actions.

👷 Developer API

To use NDailyRewards API, you first need to add NDailyRewards to your project. To do that follow these steps:

Add repository:

For Gradle projects use:

repositories {
    maven("https://repo.bx-team.space/releases")
}

For Maven projects use:

<repository>
    <id>bx-team-releases</id>
    <url>https://repo.bx-team.space/releases</url>
</repository>

Add dependency:

For Gradle projects use:

dependencies {
    compileOnly("space.bxteam.ndailyrewards:VERSION")
}

For Maven projects use:

<dependency>
    <groupId>space.bxteam</groupId>
    <artifactId>ndailyrewards</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>

You can check the latest version number here.

🏗️ Building

To build NDailyRewards, follow these steps (Make sure you have JDK 17 or higher):

./gradlew shadowJar
  • The output file will be located at build/libs.

📚 Contributing

If you want to contribute to NDailyRewards, see CONTRIBUTING.md to find out more.

📑 Dependencies & License

For NDailyRewards to work properly, we use the following dependencies:

NDailyRewards is licensed under the GPL-3.0 License.