Introduction
If you want to some features will be added to this plugin you can suggest it, I will try to add it if it will be interesting and useful.
If you have any questions about using of this plugin or you faced with any bugs you can contact with me, my available contacts are in the end of this post.
Features
- Choose time when to start to give payday, interval of payments, amount of salary.
- Possibility to configure all messages to players in configuration file however you want.
- Regulation of players who and what can receive by permissions.
- Salary by groups. It’s easy to configure payday different amount of salary for different groups.
- Customizable money format that players see.
- Possibility to disable periodic salary and use command to give payday whenever you want.
- Give salary for offline players too at payday time.
- Use groups salary for offline payday and put any reduce percent for offline salary if you want.
- Possibility to disable salary for online players and give it only for offline players.
- Ignore AFK players at payday time.
- Customizable title message and sound at payday time.
- A lot of placeholders with information about payday which you can use wherever you want.
- HEX and gradient colors support.
Dependencies
- Vault(Optional)
- LuckPerms(Recommended) - only to use salary by groups.
- EssentialsX(Recommended) - only to use AFK ignore function.
- PlaceholderAPI(Recommended) - only if you want to use placeholders.
Commands
- /payday reload | reload plugin configuration.
- /payday give | give payday once. (It doesn’t affect on periodic payday).
Permissions
- puzzlepayday.admin - use commands for admins.
- puzzlepayday.receive - receive salary at payday time.(Is enabled for default group).
- puzzlepayday.receive.afk - receive salary even if ignore AFK function is enabled and you are AFK.
- puzzlepayday.receive.offline - receive offline payday.
- puzzlepayday.receive.offline.groups - receive group salary in offline payday.
Placeholders
- %puzzlepayday_salary% - standard salary amount.
- %puzzlepayday_salary_with_group% - total salary amount for player (standard + group).
- %puzzlepayday_group_salary% - player’s group salary amount.
- %puzzlepayday_offline_salary% - player’s offline salary amount.
- %puzzlepayday_pastsalary% - standard salary amount from last payday.
- %puzzlepayday_pastsalary_with_group% - total salary amount for player from last payday.
- %puzzlepayday_group_pastsalary% - player’s group salary amount from last payday.
- %puzzlepayday_offline_pastsalary% - player’s offline salary amount from last payday.
- %puzzlepayday_time% - time of next payday in format HH:mm:ss.
- %puzzlepayday_time_left% - time left for next payday in format HH:mm:ss.
Configuration file
You can find description to all features in configuration file here:
Code (YAML):
Payday
:
#↓ Enable/disable to give payday by schedule
Enable : true
#↓ Amount of money which all players will receive
Amount : 100.0
#↓ Enable/disable salary by groups
Groups : false
#| These are messages for every player at payday time
#| In messages you can use some special words to get values from plugin to messages:
#| [group_only] - use it if you want to sent this message only
#| for players who will receive salary by group
#| {time} - server time in format HH:mm:ss
#| {payday} - money amount formatted by this config
#| {player_group} - name of player_group
#↓ {group_payday} - formatted amount of money to player's group
Messages :
- ''
- '&b=========&5Pay&dday&b========='
- '&3Time : &b{time}'
- '&3Salary : {payday }'
- '[group_only]&3Add salary(&f{player_group}&3) : {group_payday }'
- '&b========================'
- ''
Period :
#| You can choose the time when you want to give first payday after server start
#| It's only 2 available types: "AT-XX-minutes" and "AT-XX-hours" where XX it's minutes/hours
#| For example, if put here AT-20-minutes and start your server at 10:05:00, it means
#| that next payday will be given at 10:20:00.
#| If you will put here AT-11-hours and start your server at same time(10:05:00), it means
#↓ that next payday will be given at 11:00:00.
Type : AT-00-minutes
#| It's time to repeat payday in minutes.
#| For example, if you will set here 120 and payday were given at 11:00:00, the next Payday
#↓ will be given in 2hours(120minutes) at 13:00:00
Time : 60
AFKPayday :
#↓ Enable/disable ignoring afk players when payday
IgnoreAFK : false
#↓ Messages which player will receive if he was ignored at salary time
IgnoreAFKMessages :
- ''
- '&b=========&5Pay&dday&b========='
- '&3You are afk and that is why you can not receive your salary'
- '&b========================'
- ''
OfflinePayday :
#↓ Enable/disable payday for offline players
Enable : false
#↓ Amount of money which offline players will receive at payday time
Amount : 100.0
#| Percent to reduce offline salary. You can set 0 to disable reducing
#↓ It will reduce total salary with groups salary included(if it enabled)
ReducePercent : 40
#↓ Enable/disable additional salary by groups for offline players
Groups : false
TitleMessage :
#↓ Enable/disable title message(message at center of screen) at payday time
Enable : false
#↓ Message with big letters at the top of title message
Title : '&5Pay&dday'
#↓ Message with normal letters at the bottom of title message
Subtitle : + %puzzlepayday_salary_with_group%
Sound :
#↓ Enable/disable sound when player receive salary
Enable : false
#| Here you can put any sounds from minecraft
#↓ You can find its here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html
Name : UI_TOAST_CHALLENGE_COMPLETE
#↓ Here you can choose volume of this sound (between 0.1 - 1.0)
Volume : 1.0
#| Here you can choose how fast the sound will be played (between 0.1 - 2.0)
#| 1.0 - normal speed
#| 0.5 - half speed
#↓ 2.0 - 2x speed
Pitch : 1.0
#| Settings of money format
#| Colors available: BLACK, DARK_BLUE, DARK_GREEN, DARK_AQUA, DARK_RED, DARK_PURPLE, GOLD,
#↓ GRAY, DARK_GRAY, BLUE, GREEN, AQUA, RED, LIGHT_PURPLE, YELLOW, WHITE.
Economy :
#↓ You can put currency symbol here
Currency : $
#↓ Here you can set color for currency symbol
CurrencyColor : DARK_GREEN
#↓ Here you can set color for amount of money. It can be differ from symbol color
AmountColor : GREEN
#| Format of money amount symbol place. It will be look like:
#| if true - 100$
#↓ if false - $100
SymbolAfterAmount : false
#| Format of money amount dot. It will be look like:
#| if true - $100.0
#↓ if false - $100
AmountWithDot : true
#↓ Enable/disable to give payday by schedule
Enable : true
#↓ Amount of money which all players will receive
Amount : 100.0
#↓ Enable/disable salary by groups
Groups : false
#| These are messages for every player at payday time
#| In messages you can use some special words to get values from plugin to messages:
#| [group_only] - use it if you want to sent this message only
#| for players who will receive salary by group
#| {time} - server time in format HH:mm:ss
#| {payday} - money amount formatted by this config
#| {player_group} - name of player_group
#↓ {group_payday} - formatted amount of money to player's group
Messages :
- ''
- '&b=========&5Pay&dday&b========='
- '&3Time : &b{time}'
- '&3Salary : {payday }'
- '[group_only]&3Add salary(&f{player_group}&3) : {group_payday }'
- '&b========================'
- ''
Period :
#| You can choose the time when you want to give first payday after server start
#| It's only 2 available types: "AT-XX-minutes" and "AT-XX-hours" where XX it's minutes/hours
#| For example, if put here AT-20-minutes and start your server at 10:05:00, it means
#| that next payday will be given at 10:20:00.
#| If you will put here AT-11-hours and start your server at same time(10:05:00), it means
#↓ that next payday will be given at 11:00:00.
Type : AT-00-minutes
#| It's time to repeat payday in minutes.
#| For example, if you will set here 120 and payday were given at 11:00:00, the next Payday
#↓ will be given in 2hours(120minutes) at 13:00:00
Time : 60
AFKPayday :
#↓ Enable/disable ignoring afk players when payday
IgnoreAFK : false
#↓ Messages which player will receive if he was ignored at salary time
IgnoreAFKMessages :
- ''
- '&b=========&5Pay&dday&b========='
- '&3You are afk and that is why you can not receive your salary'
- '&b========================'
- ''
OfflinePayday :
#↓ Enable/disable payday for offline players
Enable : false
#↓ Amount of money which offline players will receive at payday time
Amount : 100.0
#| Percent to reduce offline salary. You can set 0 to disable reducing
#↓ It will reduce total salary with groups salary included(if it enabled)
ReducePercent : 40
#↓ Enable/disable additional salary by groups for offline players
Groups : false
TitleMessage :
#↓ Enable/disable title message(message at center of screen) at payday time
Enable : false
#↓ Message with big letters at the top of title message
Title : '&5Pay&dday'
#↓ Message with normal letters at the bottom of title message
Subtitle : + %puzzlepayday_salary_with_group%
Sound :
#↓ Enable/disable sound when player receive salary
Enable : false
#| Here you can put any sounds from minecraft
#↓ You can find its here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html
Name : UI_TOAST_CHALLENGE_COMPLETE
#↓ Here you can choose volume of this sound (between 0.1 - 1.0)
Volume : 1.0
#| Here you can choose how fast the sound will be played (between 0.1 - 2.0)
#| 1.0 - normal speed
#| 0.5 - half speed
#↓ 2.0 - 2x speed
Pitch : 1.0
#| Settings of money format
#| Colors available: BLACK, DARK_BLUE, DARK_GREEN, DARK_AQUA, DARK_RED, DARK_PURPLE, GOLD,
#↓ GRAY, DARK_GRAY, BLUE, GREEN, AQUA, RED, LIGHT_PURPLE, YELLOW, WHITE.
Economy :
#↓ You can put currency symbol here
Currency : $
#↓ Here you can set color for currency symbol
CurrencyColor : DARK_GREEN
#↓ Here you can set color for amount of money. It can be differ from symbol color
AmountColor : GREEN
#| Format of money amount symbol place. It will be look like:
#| if true - 100$
#↓ if false - $100
SymbolAfterAmount : false
#| Format of money amount dot. It will be look like:
#| if true - $100.0
#↓ if false - $100
AmountWithDot : true
Group salary
In this plugin you can manage amount of salary by groups. You can use it to give different salary for different privileges. To use this feature you need to use LuckPerms like permission plugin and enable salary by groups in config.yml.If you want to add an group and set the special salary for that group you can put it in the file groups.yml. You just need to write the name(not display name) of group which you give to this group in LuckPerms. There are some example groups in groups.yml:
Code (YAML):
Groups:
premium : 350
vip : 50
lux : 150
premium : 350
vip : 50
lux : 150
Code (YAML):
Groups:
vip : 50
diamond : 500
vip : 50
diamond : 500
HEX and gradient colors tutorial
If you want
to use HEX and gradient colors on your server you must be sure that
version of your server is 1.16 or newer. If it will be
below 1.16 and you will try to use these colors that
text will be just white. Use this tutorial for my plugins only because in other plugins it can be differ. You can use these colors in all messages of this plugin. Remember that you still can use all standard colors if you want.
To use gradient colors, you need to put your text between ‘<>’ and ‘</>’, for example:
HEX gradients:
<#ffffff>Your text</#000000> - where ‘ #ffffff’ is your start gradient color and ‘ #000000’ is end of your gradient color. Instead ‘ Your text’ you can write any text. You need to put all colors by HEX standard(You can choose HEX color which you need here).
Standard colors gradients:
<&c>Your text</&4> - where ‘ &c’ is your start gradient color and ‘ &4’ is end of your gradient color. Instead ‘ Your text’ you can write any text. You need to put all standard colors.
In gradient colors you can continue use formatting text like ‘&b’ , ‘&n’ and another. You also can break your gradient for some words with another color and after this word continue that gradient. You can use any color for word that you need and after, to continue gradient use ‘&r’. (You can find examples below in spoiler)
To use HEX colors, you need to put your text after ‘&<>’, for example:
&<#ffffff>Your text - where ‘ #ffffff’ is your HEX color. Instead ‘ Your text’ you can write any text.
Contacts
- Here on spigot - NobleDeer
- Patreon - patreon.com/PuzzleMc
- Email: [email protected]
- Discord - [soon]- Patreon - patreon.com/PuzzleMc
- Email: [email protected]
Resource Information
Author:
----------
Total Downloads:
379
First Release:
Jul 24, 2023
Last Update:
Aug 23, 2023
Category:
---------------
All-Time Rating:
1 ratings
Version
-----
Released:
--------------------
Downloads:
------
Version Rating:
----------------------
-- ratings