Configuration Format - TWilsonRead/DailyRewards GitHub Wiki

This is a guide to help you edit your DailyRewardsConfig.txt file - to set it up with your own values.

Important: Please do not change the fundamental layout of this file (adding new lines, trailing/leading spaces etc.) as this will mess up the plugin and cause it to not run correctly.

Requirements

You should already have the DailyRewards.jar and the DailyRewards folder (containing the DailyRewardsConfig.txt file) in the plugins folder of your Minecraft 1.16.5 server. Check to see if the plugin runs correctly without amending the config file first.

This should also create the DailyRewards.txt file in the DailyRewards folder.

If this is all working, then continue to the next section.

General Information

This file should be used to specify the items, economy and server commands you want to give the player when they log in, depending on how many days they have logged in this week.

The information is written in a specific way, so that the plugin knows where to look to get a reward.

[Day <Number>] Type: <Type> Item: <Item> Amount: <Amount> Description: <Description>

Type denotes the type of reward that will be given to the player. Currently there are three types that can be specified - ITEM, ECONOMY and COMMAND_CRATEKEY.

  • ITEM - This tells the plugin to give the player a vanilla item. For a list of the accepted items, check out the Bukkit Materials page at https://dev.bukkit.org/projects/supplies/pages/material-list
  • ECONOMY - This tells the plugin to give the player money, through whichever economy plugin your server uses, connecting through Vault.
  • COMMAND_CRATEKEY - This tells the plugin to send a command to be executed by the server - for example to give the player a crate key. (This is still in development and so only works in certain cases, where the command follows the format " PLAYERNAME ".

Examples

[Item Example]

Type: ITEM -- This tells the plugin that you want to give the player a vanilla item.
Item: IRON_INGOT -- This is a material from the bukkit materials list. This will be given to the player.
Amount: 64 -- This is how many of the item you want to give the player.
Description: Iron Ingots -- This formulates part of the confirmation message players receive.

[Economy Example]

Type: ECONOMY -- This tells the plugin that you want to give the player money.
Item: 500 -- This is the amount of money to give them.
Amount: 500 -- This is the amount shown on the confirmation message players receive.
Description: Economy -- This formulates part of the confirmation message players receive.

[Crate Key Example]

For this example, we assume that on your server, the command to give a player a crate key is:
/givekey [KeyType] [Player] [Amount]
/givekey legendary_crate Westbourne 64
Note: You do NOT need to specify the player, this is done automatically by the plugin.
Type: COMMAND_CRATEKEY -- This tells the plugin you want to run a command that gives the player a cratekey.
Item: givekey legendary_crate -- This tells the plugin the first 2 arguments of the command.
Amount: 64 -- This tells the plugin the last argument of the command.
Description: Legendary Crate Keys -- This formulates part of the confirmation message players receive.

Further Information

  • This plugin was designed by Westbourne.
  • Do not change the number of lines in this file, the plugin requires the information in specific places.
  • Please only change the information after the colon (:) on each line.
  • Do not put extra leading/trailing spaces before/after your entries. (1 space only between : and YourEntry).
  • Type must be one of the three types: ITEM, COMMAND_CRATEKEY or ECONOMY.
  • If Type is ITEM, Item should be one of the items on the bukkit Materials webpage (see top of this page).
  • If Type is COMMAND_CRATEKEY, Item should be the first part of the command (before the playername).
  • If Type is ECONOMY, Item should be the amount of money you want to give the player.
  • Amount should be an integer only, in all cases.
  • If your crate key syntax is not supported by the above limitations, let me know and I will try and add this in a future update.
  • Description should be a short description (string).
  • This is one of the first plugins I have created and is no where near perfect, however a lot of time and effort has been put in to make sure there are as little bugs as possible.
  • Further functionality may be added in the future depending on the demand of users.
  • Chat messages, including the colours, may be customisable in future updates.
  • Error messages have been added, which will be available in your server's console if things go wrong.
  • Please check these errors to make sure your syntax of this file is correct before messaging.
  • If you identify a critical bug, have any suggestions, or have a query, please use the Issues section of this repository or messsage me on Discord at Westbourne#6012.
⚠️ **GitHub.com Fallback** ⚠️