Lucky Crates 1.1.3

Add a whole new level of excitement to your Rust server with Lucky Crates! This customizable loot crate plugin randomly spawns crates around the map, giving players a shot at discovering unique items and valuable loot. Whether you're aiming for thrilling high-stakes loot runs or just want to drop some fun surprises, Lucky Crates is designed to fit seamlessly into your server.

With easy-to-tweak settings, you have full control over how often the crates spawn, what kind of loot they contain, and how long they stick around. You can even set it up so the whole server gets notified when a crate spawns, turning it into a server-wide event that gets everyone racing for the prize. Lucky Crates not only reward players with valuable loot but also create hot spots for potential PvP encounters, making every crate spawn a thrilling event.

Want to make it easier for players to find the crates? No problem—just enable map markers! Whether your server is all about intense PvP action or focuses more on community-driven PvE, Lucky Crates will keep things fresh and fun for your players.

Config:

The configuration is fully customizable to fit your preferences and performance needs. Please note that these values have been tested on a 1000x1000 'small' map, so be sure to adjust them as needed for different map sizes.

• Log player looting to file - Logs Lucky Crate's loot interaction to file for admins.
• Destroy Lucky Crate on looting - Instantly destroy the Lucky Crate after it has been looted, or allow it to remain for the entire duration.
• Max number of slots in a container - The number of item slots available in each Lucky Crate.
• Always fill all container slots - This will always fill all container slots in the Lucky Crate.
• Prevent duplicate items - This will make sure each item is unique in the Lucky Crate.
  Note: this will override "always fill container slots", meaning it's best to use if you have a large loot table. If the loot table length is lower than the container size, it will result in empty slots.
• Container type to use - Choose whether to spawn Lucky Crate in large or small wooden boxes.
• Large box skin id - The skin ID for the large wooden box. By default, this uses a custom-made Lucky Crate skin.
• Small box skin id - The skin ID for the small wooden box. By default, this uses a custom-made Lucky Crate skin.
• Debug mode - Enables detailed feedback in the console for troubleshooting.
• Broadcast Lucky Crate spawn to all player - Sends a global message to all players when a Lucky Crate spawns.
• Broadcast message - This customizable global message uses placeholders: {x}, {y}, {z} for coordinates, {grid} for the grid location, {distance} for how far the player is from the Lucky Crate, and {direction} for the direction in compass terms.
• Total maximum number of Lucky Crates that can exist: Defines the overall maximum Lucky Crates allowed across the server. Set to -1 for unlimited.
• Number of Lucky Crates to spawn each interval - Controls how many Lucky Crates are spawned per spawn interval.
• Maximum number of Lucky Crates on the map at any given time: The maximum number of Lucky Crates that can exist simultaneously on the map.
• Duration of Lucky Crates in seconds - The lifespan of each Lucky Crate before it is automatically removed.
• Lucky Crate spawn frequency in seconds - How often the system will attempt to spawn new Lucky Crates. If a player loots a crate, this will trigger a new spawn attempt after one minute (up to the maximum number of crates allowed). 
• Lucky Crate spawn attempts - The number of attempts the system will make to find a valid spawn location for each Lucky Crate.
• Enable map marker - Displays a map icon at the spawn location of each Lucky Crate to encourage PvP or help players find the crates.
• Map marker duration in seconds - The lifespan of the map marker. If "Destroy Lucky Crate on looting" is set to false, the marker can encourage PvP by keeping players aware of crate locations.
• Check Lucky Crates to destroy interval in seconds - The interval at which the plugin checks to see if crates should be destroyed. Higher intervals can improve performance, but the interval should not exceed the crate's lifespan.

Default config:

{
  "Log player looting to file": true,
  "Destroy Lucky Crate on looting": true,
  "Max number of slots in a container": 1,
  "Always fill all container slots": true,
  "Prevent duplicate items": true,
  "Container type to use": "box.wooden.large",
  "Large box skin id": 3346528269,
  "Small box skin id": 3346533967,
  "Debug mode": false,
  "Broadcast Lucky Crate spawn to all players": true,
  "Broadcast message": "<color=#FF9900>[LuckyCrate]</color> A Lucky Crate has spawned at {x}, {y}, {z} in grid {grid}, {distance}m away to the {direction}!",
  "Total maximum number of Lucky Crates that can exist": 50,
  "Number of Lucky Crates to spawn each interval": 1,
  "Maximum number of Lucky Crates on the map at any given time": 10,
  "Duration of the Lucky Crate in seconds": 300.0,
  "Lucky Crate spawn frequency in seconds": 60,
  "Lucky Crate spawn attempts": 10,
  "Maximum allowed slope angle for crate spawning": 45.0,
  "Enable map marker": true,
  "Show Lucky Crates items on the map marker": true,
  "Map marker duration in seconds": 300.0,
  "Check Lucky Crates to destroy interval in seconds": 60.0
}

Loot table:
You can keep the standard setup or use your imagination to add a wide variety of items that fit your server's theme. Whether it's high-tier weapons, rare resources, or fun and quirky surprises, the choice is yours! Add more items to make every Lucky Crate spawn feel unique and rewarding for players.

The weight system determines the likelihood of each item appearing in a Lucky Crate. Items with higher weights are more likely to spawn compared to items with lower weights. For example, if an item has a weight of 50 and another item has a weight of 1, the item with weight 50 is much more likely to appear. This allows you to control the rarity of specific items, creating a balanced and engaging loot experience for your players.

{
  "LootTable": [
    {
      "ItemName": "rifle.ak",
      "Weight": 1,
      "AmountMin": 1,
      "AmountMax": 1
    },
    {
      "ItemName": "weapon.mod.holosight",
      "Weight": 5,
      "AmountMin": 1,
      "AmountMax": 1
    },
    {
      "ItemName": "ammo.pistol",
      "Weight": 50,
      "AmountMin": 10,
      "AmountMax": 10
    },
    {
      "ItemName": "scrap",
      "Weight": 75,
      "AmountMin": 50,
      "AmountMax": 100
    },
    {
      "ItemName": "metal.fragments",
      "Weight": 50,
      "AmountMin": 200,
      "AmountMax": 250
    },
    {
      "ItemName": "supply.signal",
      "Weight": 3,
      "AmountMin": 1,
      "AmountMax": 1
    },
    {
      "ItemName": "wood",
      "Weight": 100,
      "AmountMin": 500,
      "AmountMax": 500
    },
    {
      "ItemName": "metal.refined",
      "Weight": 15,
      "AmountMin": 50,
      "AmountMax": 100
    },
    {
      "ItemName": "rifle.bolt",
      "Weight": 2,
      "AmountMin": 1,
      "AmountMax": 1
    },
    {
      "ItemName": "explosive.timed",
      "Weight": 1,
      "AmountMin": 1,
      "AmountMax": 1
    },
    {
      "ItemName": "weapon.mod.silencer",
      "Weight": 10,
      "AmountMin": 1,
      "AmountMax": 1
    },
    {
      "ItemName": "leather",
      "Weight": 50,
      "AmountMin": 100,
      "AmountMax": 100
    },
    {
      "ItemName": "sulfur.ore",
      "Weight": 75,
      "AmountMin": 200,
      "AmountMax": 300
    }
  ]
}

The logging format:

Each time a player loots a Lucky Crate, the plugin logs the event in a file, making it easy for admins to track interactions. Here’s an example of what the log file might look like:
 

[
  "Matt looted a Lucky Crate at (1262.12, 10.45, 522.40) on 10/11/2024 03:40:00",
  "Matt looted a Lucky Crate at (782.73, 8.85, 1693.96) on 10/11/2024 03:40:14",
  "Matt looted a Lucky Crate at (754.21, 22.18, 79.26) on 10/11/2024 03:53:53",
  "Matt looted a Lucky Crate at (314.68, 48.28, -224.63) on 10/11/2024 03:54:06",
  "Matt looted a Lucky Crate at (-1121.76, 11.11, -240.14) on 10/11/2024 03:57:48",
  "Matt looted a Lucky Crate at (-475.64, 16.85, -208.04) on 10/11/2024 03:57:57",
  "Matt looted a Lucky Crate at (-236.99, 32.97, 349.00) on 10/11/2024 03:58:07"
]

Hooks

SpawnLuckyCrate
This hook allows you to spawn a crate at any given location. It takes a Vector3 position and spawns a container at those coordinates. Server owners can use this to manage custom crate placement.

        [HookMethod("SpawnLuckyCrate")]
        private BaseEntity SpawnLuckyCrate(Vector3 position)
        {
            return SpawnContainer(position);
        }

With Lucky Crates, server owners have a powerful tool to inject excitement and unpredictability into their world, keeping players engaged and eager for the next crate to appear.