Simple Kits

Works with

About Simple Kits

Simple Kits is a Kits plugin for Rust that offers a simple and easy to navigate UI while maintaining good server performance.

Key Features

GUI for Kit Management: The plugin provides a custom, in-game user interface for players to view and redeem available kits. Admins can also use the GUI to create and edit kits without manually editing the config file.
Highly Customizable Kits: Each kit can be configured with a specific name, short name, description, image, and items. It also supports item attachments, allowing for pre-modded weapons and tools. Autokit support.
Built-in Cooldown and Usage Limits: You can define cooldown periods (global and per-player) and set a maximum number of uses for each kit, providing a balanced experience. There is also an option to automatically clear all cooldowns and use counts upon a server wipe.
Permission-Based Access: Kits can be restricted to specific players or groups using permissions, allowing for VIP kits or donor perks.
API: The plugin exposes a comprehensive API that is compatible with the uMod Kits plugin's API. It allows other plugins to interact with the kit system, including giving kits, checking their existence, retrieving kit data, and managing player cooldowns and uses.
Lightweight: stripped down features and more optimized to guarantee good performance.

Performance Overview:

Commands

/kit - open the kits menu

/kit shortname - redeem any kit via it's shortname without opening the menu

Permissions

No admin permission, must have moderatorid or ownerid to access the admin menu

Config:

{
  "VIP Store URL (Wthout https://)": "",
  "Enable Auto-Kits": true,
  "Clear Cooldowns and Redeem Limits on wipe": true,
  "Main Color RGBA (Use https://colors.misticos.dev/ (RUST Color))": "0 1 1 1",
  "Kits": {
    "starter": {
      "Name": "STARTER",
      "ShortName": "starter",
      "Description": "A simple kit to get your <color=#00ceff>base</color> going! \n24 Hour cooldown between redeems.",
      "Image": "https://files.tryhard.cloud/s/RygdtjDamAXHKwQ/preview",
      "Cooldown": 86400.0,
      "WipeCooldown": 0.0,
      "MaxUses": -1,
      "Perm": "",
      "Items": [
        {
          "Id": 1079279582,
          "ShortName": "medkit",
          "Amount": 2,
          "SkinId": 0,
          "Slot": 1,
          "Container": 1,
          "Attachments": null
        },
        {
          "Id": 1079279582,
          "ShortName": "bandage",
          "Amount": 2,
          "SkinId": 0,
          "Slot": 2,
          "Container": 1,
          "Attachments": null
        }
      ],
      "Hide": false
    }
  }
}

API:

// Attempts to give a kit to the specified player.
// Returns a string containing a failure message, otherwise returns the result of the internal GiveLoadout method.
object GiveKit(BasePlayer player, string name);

// Checks if a kit with the given name exists.
// Returns a boolean value.
bool IsKit(string name);

// Populates a provided list with the names of all available kits.
// This method does not return a value.
void GetKitNames(List<string> list);

// Retrieves the image URL for the specified kit.
// Returns an empty string if no URL is set.
string GetKitImage(string name);

// Retrieves the description text for the specified kit.
// Returns an empty string if no description is set.
string GetKitDescription(string name);

// Returns the maximum number of uses for a kit per player.
// Returns 0 if no maximum is set.
int GetKitMaxUses(string name);

// Returns the cooldown period (in seconds) for a kit.
// Returns 0 if there is no cooldown.
int GetKitCooldown(string name);

// Gets the number of times a specific player has used a specific kit.
// Returns 0 if the player or kit data is not found.
int GetPlayerKitUses(ulong playerId, string name);

// Sets the number of uses for a specific kit for the given player.
// This method does not return a value.
void SetPlayerKitUses(ulong playerId, string name, int amount);

// Retrieves the remaining cooldown time (in seconds) for a player's kit.
// Returns 0 if the kit is not on cooldown.
double GetPlayerKitCooldown(ulong playerId, string name);

// Sets a new cooldown time (in seconds) for the specified kit for a player.
// This method does not return a value.
void SetPlayerCooldown(ulong playerId, string name, double seconds);