Prizes can come in the form of items, kits, or Economics / ServerRewards points. You can manually run a giveaway event with the prize of your choice using the provided commands, or you can opt to run giveaway events automatically using prizes you dictate in the config.
When the event starts players will be notified that a giveaway event is about to begin, then 10 seconds later it will randomly select a player and give them the prize.
If the prize is currency it will be automatically added to the players account, else if the prize is a item or a kit then the user will be prompted to claim the item/kit when they are ready at a later time using the commands provided.
The are 4 types of notification systems in place to choose from which can be changed in the config;
Chat
UI
GameTip
Old demo video, still partially relevant
Chat Commands
/giveaway - Show help text
/giveaway claim - Claims any outstanding prizes
Admin Commands
/giveaway create - Start a new give away with the prize being randomly selected from the config
/giveaway create item - Create a new give away with the prize being the item in your hands
/giveaway create item <shortname> <amount> <opt:skinID> - Create a new give away with the prize being the item specified
/giveaway create inventory - Create a new give away with the prize being your current inventory
/giveaway create kit <kitname> - Create a new give away with the prize being the specified kit
/giveaway create sr <amount> - Create a new give away with the prize being the specified amount of RP
/giveaway create eco <amount> - Create a new give away with the prize being the specified amount of Eco
Console Commands
giveaway create item <shortname> <amount> <opt:skinID> - Create a new give away with the prize being the item specified
giveaway create kit <kitname> - Create a new give away with the prize being the specified kit
giveaway create sr <amount> - Create a new give away with the prize being the specified amount of RP
giveaway create eco <amount> - Create a new give away with the prize being the specified amount of Eco
Creating Rewards
You can create various rewards via the config file. These rewards will only be used in the automated giveaway events.
Each reward type has different values that must be entered in the config
Example prize config with all 5 reward types
C#:
"Prizes": [
{
"Amount": 10,
"Currency type (ServerRewards, Economics)": "ServerRewards"
},
{
"Amount": 10,
"Currency type (ServerRewards, Economics)": "Economics"
},
{
"Kit": "kitname"
},
{
"Shortname": "rifle.ak",
"Amount": 1,
"Skin ID": 0
},
{
"Command": " example.command",
"Custom Name": "Example command"
}
]
To add a
currency prize the prize entry must look like the following. Set the amount and which type of currency it should use (ServerRewards or Economics)
C#:
{
"Amount": 10,
"Currency type (ServerRewards, Economics)": "ServerRewards"
},
To add a
kit prize the entry must look like the following. You only set the kit name for this prize
C#:
{
"Kit": "kitname"
},
To add a
item prize the prize entry must look like the following. You must set a item shortname, the amount of the item and the skin ID (default skin can be set to 0)
C#:
{
"Shortname": "rifle.ak",
"Amount": 1,
"Skin ID": 0
}
You can also specify a custom name for the item by adding the "Custom Name" field
C#:
{
"Shortname": "rifle.ak",
"Amount": 1,
"Skin ID": 0,
"Custom Name": "Custom Item Name"
}
To add a
command prize, use the "Command" field. It is recommended to add the "Custom Name" field so players can see what the command is for.
There are 5 variables you can add to your command string to fill in additional data.
$player.id - Gets converted to the players user ID
$player.name - Gets converted to the players display name
$player.x, $player.y and $player.z - Get converted to the players position on the specified axis
C#:
{
"Command": "example.command $player.id $player.name $player.x $player.y $player.z",
"Custom Name": "Example Command Name"
}
Config
C#:
{
"Exclude admins from give aways": true,
"Include sleepers in give aways": false,
"Automated Give Away": {
"Enabled automated give aways": true,
"Interval between give aways (seconds)": 3600,
"Minimum players required to run automated give away": 5,
"Prizes": [
{
"Amount": 10,
"Currency type (ServerRewards, Economics)": "ServerRewards"
},
{
"Amount": 10,
"Currency type (ServerRewards, Economics)": "Economics"
},
{
"Kit": "kitname"
},
{
"Shortname": "rifle.ak",
"Amount": 1,
"Skin ID": 0
}
]
},
"Notifications": {
"Notification mode (Chat, UI, Hint, UINotify)": "Hint",
"Information interval (seconds)": 1800,
"UI Settings": {
" FontSize": 15,
"Horizontal start position (left)": 0.15,
"Vertical start position (bottom)": 0.8,
"Horizontal dimensions": 0.65,
"Vertical dimensions": 0.05
}
},
"Version": {
"Major": 2,
"Minor": 0,
"Patch": 0
}
}
