Personal Recyclers

About Personal Recyclers

This plugin allows for your players to receive or purchase personal recyclers that they can place inside of their base.

The primary benefit of this plugin vs other similar plugins, is that this plugin will restrict usage of the recyclers to only a user or their team (configurable), and has commands built in that will allow players to purchase it directly via payment gateways like Tebex etc.

It will also work with the VIP Token plugin, allowing for a token to be purchased and traded in game, providing the consumer with a redeemable recycler.

The plugin itself is fairly straight forward - players type the command into chat, which will provide them with a recycler item. This item is a reskinned box, and will be placed using the box prefab, but once deployed, it will spawn a recycler in with the same positioning as the box, then despawn the box. Recyclers can also be picked up using a hammer or toolgun by pressing mouse 3.

Features

Automatically clears data on map wipe. Allows players to keep their unredeemed recyclers between wipes (configurable).
Prevents other players from accessing the recycler (configurable).
Team mate support (configurable).
Configurable starting amount of recyclers. Additional recycler(s) are accrued upon a map wipe, if the player had not redeemed their recycler (configurable).
External payment gateway support, allowing for you to sell individual recyclers to your players.
VIP Tokens support. Check below for the configuration example.
Can pick up own recyclers using your hammer/toolgun and mouse 3.
Recyclers will lost max condition each time they are picked up to prevent players from deploying them while grinding the roads (configurable).

Permissions

personalrecycler.use
personalrecycler.admin
personalrecycler.place

personalrecycler.use commands

/recyclers - will print out how many recyclers a player has left to redeem.
/redeemrecycler - will spawn a recycler in the players inventory and deduct a recycler from their redeemable count.
/crecycler - Will pickup the targeted recycler (requires a hammer to be wielded) if the player has permission.

Players with this permission will automatically get the configured number of starting recyclers upon using the commands for the first time, and will have have recyclers added to their redemption pool at the start of each wipe (configurable).

personalrecycler.admin commands

/addrecycler <player name> - will increase the amount of redeemable recyclers a player has by 1.
/clearrecyclers <player name> - will remove all of the saved recycler IDs from the data file, making all of their recyclers publically accessible.
/clearrecyclerdata - removes all of the saved recycler IDs from the data file, making all recyclers publically accessible.

API

This plugin allows for you to add a command to a payment gateway such as Tebex, or via my VIP Tokens plugin.

The command is structured as below:

addrecycler <Steam ID> <quantity>

Most payment gateways required the player to log in with their steam ID. An example command using tebex would be:

addrecycler {id} 1

This would add 1 recycler for the steam ID of the account that logged into Tebex.

You can also add this as a VIP Token. See configuration options below:

	  "recycler": {
      "name": "Personal Recycler",
      "days_to_add": 0,
      "vip_group": null,
      "vip_description": "Allows you to place a personal recycler that only you can access.",
      "remove_tokens_on_wipe": false,
      "token_item": {
        "name": "Recycler Token",
        "skin": 2544601457,
        "item_shortname": "radiationresisttea.pure"
      },
      "_command": {
        "command": "addrecycler {id} 1",
        "message": "You redeemed a recycler token.",
        "public_message": null,
        "hook": false
      }
    }