Home - TWilsonRead/DailyRewards GitHub Wiki

Welcome to the DailyRewards wiki!

Current Minecraft Compatibility: 1.16.5 (Spigot & CraftBukkit Servers)

Changelog

  • 30/Jan/21 - Released DailyRewards Wiki
  • 29/Jan/21 - Released Version 1.1
  • 28/Jan/21 - Uploaded Project to Github (Version 1.0)

About this Plugin

This is a Daily Rewards plugin designed for Minecraft: Java Edition servers. It provides a method to reward players for logging in daily, with escalating rewards depending on how many days they log in during a particular week.

The rewards are fully customisable, currently supporting vanilla items, economy (through vault) and server commands (e.g giving a player crate keys). A detailed description of the customisation can be found on the Configuration Format page.

Commands

  • '/dailyrewards claim' - Claim today's daily reward.
  • '/dailyrewards status' - Display how many days you have logged in this week, and the date of your next reward due.

Implementation

Installing the Plugin

Download the DailyRewards.zip and place both the DailyRewards folder (containing the config file) and DailyRewards.jar in the plugin folder of your minecraft server. Other folders/files will be created in the DailyRewards folder at runtime.

The configuration file is setup with default values - be sure to change this if you want your own values, but please follow the formatting instructions.

By default, players will not have permissions. They need permission "DailyRewards.dailyrewards" to use the basic commands. There are currently no admin-only commands in this plugin.

The plugin will automatically create the DailyRewards folder and DailyRewards.txt file if they do not already exist.

If you ever want to reset the player data, simply delete the DailyRewards.txt file from the DailyRewards folder.

Future Development

This plugin is in no way perfect. There are certain limitations that you will face, such as some rewards (such as XP) not being currently accepted. I hope to address these in future updates, once I know what server owners want to add.

I am also hoping to add admin commands to reset a certain player's rewards, set a player's login streak etc. so that these can all be "hotfixed".

If you encounter any bugs, crashes, limitations, or want to put forward a suggestion, please either use the "Issues" section of this repository, or send me a message on Discord: Westbourne#6012