DailyClaim configuration
The DailyClaim config.json controls how the plugin runs on your Ark Survival Ascended server. Every setting is listed below with what it does and its default value.
Where it lives
Drop the file on your server at ArkApi/Plugins/DailyClaim/config.json then reload the plugin or restart the server. Keep a backup before large changes.
Every setting
General
- Debug togglefalse
- Debug: set to true to write extra lines to ArkApi.log. Turn it on when something is not working. Leave it false for normal play.
- AutosaveSeconds number30
- AutosaveSeconds: how often the plugin saves player data to disk. 30 means every 30 seconds. A smaller number saves more often but touches the disk more. 30 is fine for most servers.
Commands
Commands: the words players type in chat. Rename them or set one to "" to turn it off.
- ClaimCMD text"/daily"
- claim today's reward.
- InfoCMD text"/dailyinfo"
- show your streak and time to the next claim.
- TopCMD text"/dailytop"
- show the best streaks on the server.
Daily
Daily: the reward rules.
- BasePoints number250
- BasePoints: the points a player gets for a normal claim, before any bonus.
- CooldownHours number24
- CooldownHours: how long between claims. 24 means once a day.
- StreakResetHours number48
- StreakResetHours: the grace window to keep a streak. If a player claims within this many hours of their last claim, the streak keeps growing. If they wait longer, the streak drops back to 1. 48 gives players a full extra day to not lose their streak, which keeps people from quitting over one missed day. Keep this equal to or larger than CooldownHours.
- StreakBonusPerDay number25
- StreakBonusPerDay: extra points per day of streak. 25 means day 5 gives 4 times 25, which is 100 extra points. Day 1 gets no streak bonus.
- MaxStreakBonus number500
- MaxStreakBonus: the most the streak bonus can ever add. This caps the daily reward so a very long streak does not print endless points.
- Milestones list[7,30,100]
- Milestones and MilestoneBonus: big one time bonuses at set streak days. The two lists line up. Day 7 gives 1000, day 30 gives 5000, day 100 gives 25000. Hitting a milestone also tells the whole server and posts to Discord. Keep the two lists the same length and in the same order.
- MilestoneBonus list[1000,5000,25000]
- WeeklyBonusDay text"Sunday"
- WeeklyBonusDay: one weekday that pays extra. Use a full day name like "Sunday", or set it to "" to turn the bonus day off. It uses the server's local day.
- WeeklyBonusMultiplier number2
- WeeklyBonusMultiplier: how much the bonus day multiplies the reward. 2.0 means double points on the bonus day. 1.5 means one and a half times.
- LuckyChancePct decimal0.05
- LuckyChancePct: the chance each claim to hit a lucky bonus. 0.05 means 5 percent. Set it to 0 to turn the lucky bonus off. A lucky hit tells the whole server.
- LuckyBonus number1000
- LuckyBonus: the extra points a lucky claim adds on top of the normal reward.
- TopCount number10
- TopCount: how many players the /dailytop list shows.
Tiers
Tiers: extra perks by permission node. A player in a group that has the "DailyClaim.VIP" node gets these. Needs the Permissions plugin.
- DailyClaim.VIP group
- Multiplier number2
- Multiplier: multiplies a VIP player's whole reward. 2.0 is double.
- CooldownHours number20
- CooldownHours: a shorter cooldown for VIP. 20 lets them claim a bit sooner.
Permissions
Permissions: gate who can claim. Needs the Permissions plugin to do anything.
- Enabled toggletrue
- Enabled: set to false to skip Permissions and let everyone claim. When it is true and the Permissions plugin is installed, a player needs the "DailyClaim.Use" node to claim. Grant "DailyClaim.Use" to your Default group, or normal players will not be able to claim. Admin groups with a wildcard already have it.
- AdminPermission text"DailyClaim.Admin"
- AdminPermission: the node for admin actions. Not required for v1.
ArkShop
ArkShop: the points economy. When it is on and ArkShop.dll is loaded, rewards are paid as ArkShop points. When it is off or ArkShop is missing, the plugin keeps its own point count per player instead, so it still runs.
- Enabled toggletrue
Discord
Discord: post big moments to a webhook. Off by default.
- Enabled togglefalse
- Enabled: turn Discord posting on. You must also set a WebhookURL.
- WebhookURL textempty
- WebhookURL: paste your Discord channel webhook URL here.
- Username text"DailyClaim"
- Username: the name the webhook posts under.
- ServerName text"My ARK Server"
- ServerName: shows in the embed footer. Handy when you run more than one server.
- LogEveryClaim togglefalse
- LogEveryClaim: set to true to post a small embed for every claim. Most owners leave this false and only get the big moments (milestones and lucky hits), which keeps the channel clean and stays under the Discord rate limit.
The full commented config
This is a reading copy with notes. It is not valid JSON, so do not load it. Use the editor or the plain config.json instead.
{
// This file explains every setting in config.json.
// It has notes in it, so it is NOT valid JSON. Do not load this file.
// Edit config.json instead. This file is just here to help you.
"General": {
// Debug: set to true to write extra lines to ArkApi.log. Turn it on when
// something is not working. Leave it false for normal play.
"Debug": false,
// AutosaveSeconds: how often the plugin saves player data to disk.
// 30 means every 30 seconds. A smaller number saves more often but touches
// the disk more. 30 is fine for most servers.
"AutosaveSeconds": 30
},
// Commands: the words players type in chat. Rename them or set one to "" to turn it off.
"Commands": {
"ClaimCMD": "/daily", // claim today's reward.
"InfoCMD": "/dailyinfo", // show your streak and time to the next claim.
"TopCMD": "/dailytop" // show the best streaks on the server.
},
// Daily: the reward rules.
"Daily": {
// BasePoints: the points a player gets for a normal claim, before any bonus.
"BasePoints": 250,
// CooldownHours: how long between claims. 24 means once a day.
"CooldownHours": 24,
// StreakResetHours: the grace window to keep a streak. If a player claims within
// this many hours of their last claim, the streak keeps growing. If they wait
// longer, the streak drops back to 1. 48 gives players a full extra day to not
// lose their streak, which keeps people from quitting over one missed day.
// Keep this equal to or larger than CooldownHours.
"StreakResetHours": 48,
// StreakBonusPerDay: extra points per day of streak. 25 means day 5 gives
// 4 times 25, which is 100 extra points. Day 1 gets no streak bonus.
"StreakBonusPerDay": 25,
// MaxStreakBonus: the most the streak bonus can ever add. This caps the daily
// reward so a very long streak does not print endless points.
"MaxStreakBonus": 500,
// Milestones and MilestoneBonus: big one time bonuses at set streak days.
// The two lists line up. Day 7 gives 1000, day 30 gives 5000, day 100 gives 25000.
// Hitting a milestone also tells the whole server and posts to Discord.
// Keep the two lists the same length and in the same order.
"Milestones": [7, 30, 100],
"MilestoneBonus": [1000, 5000, 25000],
// WeeklyBonusDay: one weekday that pays extra. Use a full day name like
// "Sunday", or set it to "" to turn the bonus day off. It uses the server's
// local day.
"WeeklyBonusDay": "Sunday",
// WeeklyBonusMultiplier: how much the bonus day multiplies the reward.
// 2.0 means double points on the bonus day. 1.5 means one and a half times.
"WeeklyBonusMultiplier": 2.0,
// LuckyChancePct: the chance each claim to hit a lucky bonus. 0.05 means 5 percent.
// Set it to 0 to turn the lucky bonus off. A lucky hit tells the whole server.
"LuckyChancePct": 0.05,
// LuckyBonus: the extra points a lucky claim adds on top of the normal reward.
"LuckyBonus": 1000,
// TopCount: how many players the /dailytop list shows.
"TopCount": 10
},
// Tiers: extra perks by permission node. A player in a group that has the
// "DailyClaim.VIP" node gets these. Needs the Permissions plugin.
"Tiers": {
"DailyClaim.VIP": {
// Multiplier: multiplies a VIP player's whole reward. 2.0 is double.
"Multiplier": 2.0,
// CooldownHours: a shorter cooldown for VIP. 20 lets them claim a bit sooner.
"CooldownHours": 20
}
},
// Permissions: gate who can claim. Needs the Permissions plugin to do anything.
"Permissions": {
// Enabled: set to false to skip Permissions and let everyone claim.
// When it is true and the Permissions plugin is installed, a player needs the
// "DailyClaim.Use" node to claim. Grant "DailyClaim.Use" to your Default group,
// or normal players will not be able to claim. Admin groups with a wildcard
// already have it.
"Enabled": true,
// AdminPermission: the node for admin actions. Not required for v1.
"AdminPermission": "DailyClaim.Admin"
},
// ArkShop: the points economy. When it is on and ArkShop.dll is loaded, rewards
// are paid as ArkShop points. When it is off or ArkShop is missing, the plugin
// keeps its own point count per player instead, so it still runs.
"ArkShop": {
"Enabled": true
},
// Discord: post big moments to a webhook. Off by default.
"Discord": {
// Enabled: turn Discord posting on. You must also set a WebhookURL.
"Enabled": false,
// WebhookURL: paste your Discord channel webhook URL here.
"WebhookURL": "",
// Username: the name the webhook posts under.
"Username": "DailyClaim",
// ServerName: shows in the embed footer. Handy when you run more than one server.
"ServerName": "My ARK Server",
// LogEveryClaim: set to true to post a small embed for every claim. Most owners
// leave this false and only get the big moments (milestones and lucky hits),
// which keeps the channel clean and stays under the Discord rate limit.
"LogEveryClaim": false
}
}