Allows titles to be set when certain criteria are met, with a UI Leader board

Supported Games
GameServerKingsGameServerKings
used by

This plugin will allow you to keep track of various statistics and set Titles to players when certain criteria have been met or when they are a leader of something.

At current there are 20 different categories each with their own tag that can be changed in the config.

  • Animal kills [Hunter]
  • Bow kills [Archer]
  • Clothes crafted [Tailor]
  • Headshots [Assassin]
  • Plants Gathered [Farmer]
  • Players healed [Medic]
  • Players killed [Murderer]
  • Melee kills [Fighter]
  • Revolver kills [Gunslinger]
  • Rockets fired [Rocketeer]
  • Ore gathered [Miner]
  • Blade kills [Swordsman]
  • Structures built [Architect]
  • Structures repaired [Handyman]
  • Explosives thrown [Bomb-tech]
  • Weapons crafted [Gunsmith]
  • Wood gathered [Lumberjack]
  • Quests completed [Adventurer]
  • PVP Kill distance [Sniper]
  • PVE Kill distance [Deadshot]
  • APC Kills [TankHunter]
  • Helicopter Kills [HeliHunter]
  • NPC Kills [BotHunter]

Each different category can be toggled on/off in the config. By default as soon as somebody tops the leader board they will be issued the appropriate tag. This can be swapped out for a timer based system in the config.

Tags can be stacked, if a player is good enough it is possible for him/her to take every tag

Better Chat

This plugin integrates in with BetterChat if you use it. To display player titles in chat you must have BetterChat 5.0.0 or higher!

Groups

Since the API has changed in BetterChat there are no longer oxide groups created by it for each title type. Now you have the option to have this plugin create oxide groups for each challenge type. If enabled when a player takes a title from another the old player will be removed from the group and the new player will be added. This may be useful for some who wish to grant certain permissions to various title holders, however, it is de-activated by default as I imagine there are not many users who will use this feature

Kills

Head shots will override any specific weapon kills. If you get a head shot with a revolver you will get a point towards head shots and will not receive a point for revolver kill

Chat Commands

  • /pc - Opens the leader board which will display the top 25 users from each category
  • /pc_wipe - Wipes all player statistics

Console Commands

  • pc_wipe - Same as above but in console

Managing Settings

Example:

"AnimalKills": {
      "Enable this challenge": true,
      "Title priority": 5,
      "Title for name tag": "Hunter",
      "Position in the UI leaderboard": 0
    },

The first line is the challenge type, do NOT change this

Enable this challenge: This will activate/deactivate this challenge type. Disabling this will also disable it in the UI

Title priority: This is only relevant when you have set a maximum number of titles to be shown in chat. If for example a player has 5 titles and you have the maximum set to 2 this will prioritize which titles will be displayed

Title for name tag: This is the text of the title that will be displayed in chat

Position in the UI leaderboard: This is the position in which the challenge type will be displayed on the leader board (UI)

Note When changing Priority or Position, your numbers though out all the challenge types must be consecutive! If you double or skip a number this will cause issues. The UI will disable itself if it detects your have done this and a message will be printed to console

Configuration

{
  "Challenge Settings": {
    "AnimalKills": {
      "Title for name tag": "Hunter",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 0,
      "Title priority": 5
    },
    "ArrowKills": {
      "Title for name tag": "Archer",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 1,
      "Title priority": 11
    },
    "StructuresBuilt": {
      "Title for name tag": "Architect",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 2,
      "Title priority": 12
    },
    "ClothesCrafted": {
      "Title for name tag": "Tailor",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 3,
      "Title priority": 19
    },
    "ExplosivesThrown": {
      "Title for name tag": "Bomb-tech",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 4,
      "Title priority": 10
    },
    "Headshots": {
      "Title for name tag": "Assassin",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 5,
      "Title priority": 1
    },
    "PlayersHealed": {
      "Title for name tag": "Medic",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 6,
      "Title priority": 18
    },
    "PlayersKilled": {
      "Title for name tag": "Murderer",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 7,
      "Title priority": 2
    },
    "MeleeKills": {
      "Title for name tag": "Fighter",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 8,
      "Title priority": 3
    },
    "PlantsGathered": {
      "Title for name tag": "Harvester",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 9,
      "Title priority": 17
    },
    "PVEKillDistance": {
      "Title for name tag": "Deadshot",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 10,
      "Title priority": 6
    },
    "PVPKillDistance": {
      "Title for name tag": "Sniper",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 11,
      "Title priority": 4
    },
    "StructuresRepaired": {
      "Title for name tag": "Handyman",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 12,
      "Title priority": 13
    },
    "RevolverKills": {
      "Title for name tag": "Gunslinger",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 13,
      "Title priority": 7
    },
    "RocketsFired": {
      "Title for name tag": "Rocketeer",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 14,
      "Title priority": 8
    },
    "RocksGathered": {
      "Title for name tag": "Miner",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 15,
      "Title priority": 16
    },
    "BladeKills": {
      "Title for name tag": "BladeKillsman",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 16,
      "Title priority": 9
    },
    "WeaponsCrafted": {
      "Title for name tag": "Gunsmith",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 17,
      "Title priority": 14
    },
    "WoodGathered": {
      "Title for name tag": "Lumberjack",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 18,
      "Title priority": 15
    },
    "HelicopterKills": {
      "Title for name tag": "HeliHunter",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 19,
      "Title priority": 20
    },
    "APCKills": {
      "Title for name tag": "TankHunter",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 20,
      "Title priority": 21
    },
    "NPCKills": {
      "Title for name tag": "BotHunter",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 21,
      "Title priority": 22
    },
    "QuestsCompleted": {
      "Title for name tag": "Adventurer",
      "Enable this challenge": true,
      "Position in the UI leaderboard": 22,
      "Title priority": 23
    }
  },
  "Options": {
    "Ignore kills against sleeping players (Players killed)": true,
    "Ignore explosive kill distance": false,
    "Kills against NPC players are counted seperate to player kills": true,
    "NPC kill distance counts as PVE distance": true,
    "Show challenge leader title tags (Requires BetterChat)": true,
    "Ignore all statistics recorded by admins": true,
    "Ignore kills for event players (Players killed)": true,
    "Ignore supply signals thrown (Explosives thrown)": false,
    "Ignore survey charges thrown (Explosives thrown)": false,
    "Ignore flares thrown (Explosives thrown)": true,
    "Broadcast new challenge leaders to chat": false,
    "Update leaders on a timer (Recommended)": false,
    "Create and use Oxide groups for each challenge type": false,
    "Update timer (hours)": 168,
    "Maximum tags to display (Requires BetterChat)": 2,
    "Format of tags displayed (Requires BetterChat)": "[{TAG}]"
  },
  "Colors": {
    "Primary message color (hex)": "#ce422b",
    "Secondary message color (hex)": "#939393",
    "Title color (hex) (Requires BetterChat)": "#ce422b",
    "UI Color - Background": {
      "Color (hex)": "#2b2b2b",
      "Alpha (0.0 - 1.0)": 0.98
    },
    "UI Color - Panel": {
      "Color (hex)": "#404141",
      "Alpha (0.0 - 1.0)": 1.0
    },
    "UI Color - Button": {
      "Color (hex)": "#393939",
      "Alpha (0.0 - 1.0)": 1.0
    }
  },
  "Version": {
    "Major": 2,
    "Minor": 0,
    "Patch": 40
  }
}

Credits

smoosher - The original author of this plugin

MIT License


Copyright (c) 2020 k1lly0u


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.