ParadoxUnboxing

Features

1. Configure as many crates and keys you want in the configuration.
2. Data is saved in MySQL so it can be shared cross-servers.
3. You can set crates to use keys or not in the configuration.
4. You can change any text on the whole UI to your liking and rich text is supported in translations.
5. All cache based so no performance issues. (Due to this, there might be a small delay when buying from store to appear in inventory)
6. All external connections to database done on different threads.
7. Commands to give crates and keys to players.
8. Module to get all of the item icons in the game. (Modded or Vanilla)
9. You can set ingame items to give crates and keys when picked up.
10. A file server with all of the vanilla icons + some modded ones to be used on the plugin.
11. Example crate icons and key icons ready to use!
12. Having a MySQL database is required for this plugin to work, if you are using a dedicated machine, then setup a MySQL database. If you are using a hosting service, your hosting usually provides a database. I won't be entertaining any requests asking as to how you setup a MySQL database on a dedicated machine, or how you don't have a request.

Usage

• You can set an item to reward items, crates, keys, permission group or money.
• You can choose if you want to use experience, uconomy. (Banking System is supported)
• You can set crates and keys to be available to be bought on the UI or not.
• You can also set if crates are to be opened by a key or not. (Set the Key ID to 0 if no key is needed to open the crate)
• You have to set the icons for the crates, keys and items. (Recommended Size: 250x250)
• You also have to install this mod on your server for the plugin to work.

Commands

• /unbox OR /cases (Permission: unbox)
• /crate ([a]dd/[r]emove) (SteamID/Name) (CrateID) [amount] (Permission: crate)
• /key ([a]dd/[r]emove) (SteamID/Name) (KeyID) [amount] (Permission: key)

File Server

Here's the link to the file server which contains all vanilla item icons and some modded ones that lyhme servers uses. Thanks to Uncle LYHME for allowing me to share this with you guys. If you want to search for an item, just press ctrl + f and type in the item id and it should pop up if it's available. You can copy the link and paste it in the icon field in the configuration to make the icon show up.

Example Crate and Key Icons

Here's the link for the example crate and key icons to use if you don't have any custom made or don't want to get any made. They work with unturned item rarities, thanks to NullBlank for allowing me to share them with you guys!

Examples

• Configuration
• Translation
• Database

Whitelisting:

If you bought the plugin and ran it on your server for the first time, no whitelisting is required. For any other servers that you use it on after that, you will need to create a whitelist ticket for it to work. Rules & procedure for requesting a whitelist ticket can be found here.

Default waiting time for any whitelist ticket to be processed is 3 days (usually I check all tickets every 3 days). If you are in an emergency and require urgent whitelisting, please dm me on discord or create a ticket here and ping me. If it takes more than 3 days, then please dm me or ping me on that discord, situations arise where I am unable to check tickets regularly.

Support

If you have any bugs, support, questions then join this discord and create a ticket!

Module

To get all of the item icons in unturned, read the tutorial section over here and use this module to get all of the item icons in unturned (Modded or Vanilla).

Configuration

Values

• ConnectionString = The connection credentials to connect to the database.
• CacheRefreshSeconds = Seconds after which the cache will refresh.
• CratesTableName = The table name for where crates will be stored.
• KeysTableName = The table name for where keys will be stored.
• DataTableName = The table name for where data will be stored of players.
• UseExp = If you want the plugin to use exp as a currency.
• UseUconomy = If you want the plugin to use uconomy as a currency. (Banking System is supported)
• SortPreviewByRarity = Sort the items shown in preview by the rarity.
• EconomyPrefix = Currency prefix which is shown in the UI.
• EconomySuffix = Currency suffix which is shown in the UI.

Crate

• CrateID = ID of the crate which can be used to give crates to players by doing /crate([a]dd/[r]emove) (SteamID/Name) (CrateID) [amount] to players, no 2 crates can have the same ID.
• CrateName = Name of the crate, can be rich text (eg. [color=red]Test Crate[/color]). Rich text will only apply wherever the crate name is used in the UI not in chat.
• Icon = Link of the icon to be used on the UI. (eg. https://i.imgur.com/vYbOZay.png)
• IsBuyable = If the crate should show up in the store and available to be bought by players through ingame money.
• Cost = Cost of the crate if it has to be shown on the store.
• KeyID = Key used to open the crate (if no key is needed set it to 0)

CrateItem

• Name = Name of the item, can be rich text (eg. [color=red]MapleStrike[/color). Rich text will only apply wherever the item name is used in the UI not in chat.
• Icon = Link of the icon to be used on the UI.
• Chance = Chance can be from 1-100 (decimals are not supported), the chance to unbox the item is Item's Chance/Total Chance Of Items In Box * 100
• BroadcastWin = A message will be broadcasted which can be set in translations when this item is won by a player.
• RewardItems = If no items has to be given to the player when he wins set this to
• RewardCommands = Run commands when this item is won player id can be get by having in the command.
• RewardGroup = Set this to empty if you don't want any group to be given to the player when he wins this item.
• RewardMoney = Set this to 0 if you don't want any money to be given to the player when he wins this item.
• RewardCrateID = Set this to 0 if you don't want any crate to be given to the player when he wins this item.
• RewardCrateAmount = Amount of crates a player should be given when he wins this item.
• RewardKeyID = Set this to 0 if you don't want any key to be given to the player when he wins this item.
• RewardKeyAmount = Amount of keys a player should be given when he wins this item.

CrateKey

• KeyID = ID of the key, it is used to give keys to players by doing /key ([a]dd/[r]emove) (SteamID/Name) (KeyID) [amount] and also this is the ID you will put in the crate configuration to set if this key is needed to open that crate.
• KeyName = Name of the key, can be rich text (eg. [color=red]Test Key[/color]). Rich text will only apply wherever the key name is used in the UI not in chat.
• Icon = Link of the icon to be used on the UI.
• IsBuyable = If the key should show up in the store and available to be bought by players through ingame money.
• Cost = Cost of the key if it has to be shown on the store.

ItemCrate

• ItemID = The item that will give the specific crate ID to player when picked up.
• CrateID = The crate that will be given when a player picks up that specific ItemID.

ItemKey

• ItemID = The item that will give the specific key ID to player when picked up.
• KeyID = The key that will be given when a player picks up that specific ItemID.

The item will be removed when picked up and the correct crate/key will be given, it's not recommended to make items that are used by a player to be a crate or key. Make different items for them that aren't used for anything else except the plugin.

Translation

Everything in the translation is rich text except the CorrectUsage message.