KittsBadgeSystem 0.1.0

KittsBadgeSystem

LabAPI Badge Tool

KittsBadgeSystem is a tool that tracks when players join, leave, etc for SCP Secret Laboratory using LabAPI.

Consider Supporting?

If you enjoy this project and would like to support future development, I would greatly appreciate it if you considered donating via my Ko-Fi.

How to use KittsBadgeSystem:

There are two options when it comes to installing KittsBadgeSystem, normal and MongoDB. The difference between the two is that normal stores everything in a .JSON and MongoDB stores everything in a Mongo database.

To install KittsBadgeSystem on your server, you will need:

• Newtonsoft.Json v13.0.4 or later.
• KittsBadgeSystem latest verion.

To install KittsBadgeSystem with MonogDB on your server, you will need:

• DnsClient v1.6.1 or later.
• Microsoft.Extensions.Logging.Abstractions v2.0.0 or later.
• MognoDB.Bson v3.10.0 or later.
• MongoDB.Driver v3.10.0 or later.
• Newtonsoft.Json v13.0.4 or later.
• KittsBadgeSystem latest verion.

All of these files can be found in the latest release.

Once you have these:

• Place DnsClient.dll in the dependencies folder, if applicable.
• Place Microsoft.Extensions.Logging.Abstractions.dll in the dependencies folder, if applicable.
• Place MognoDB.Bson.dll in the dependencies folder, if applicable.
• Place MognoDB.Driver.dll in the dependencies folder, if applicable.
• Place Newtonsoft.Json.dll in the dependencies folder, if applicable.
• Place KittsInfractionSystem.dll in the plugins folder.

Run the server and you're set!

Configurations:

Default YML Config File

# Is plugin enabled
is_enabled: true
# Sends debug logs to console
debug: false
# Permission for player badge command
player_badge_permission: kts.badge
# Permission for admin badge command
admin_badge_permission: kts.badgeadmin
# Formatting for badges with no text, {group} = groupName
default_badge_format: '{group}'
# Formatting for badges, {group} = groupName, {text} = badgeText
badge_format: '{group} | {text}'

MongoDB YML Config File

# Is plugin enabled
is_enabled: true
# Sends debug logs to console
debug: false
# MongoDB URI
mongo_d_b_u_r_i: mongodb://username:password@ip:port/
# MongoDB name
mongo_d_b_name: KittsPlayerAnalyticsSystem
# MongoDB collection name
mongo_d_b_collection_name: PlayerAnalyticsData
# Permission for player badge command
player_badge_permission: kts.badge
# Permission for admin badge command
admin_badge_permission: kts.badgeadmin
# Formatting for badges with no text, {group} = groupName
default_badge_format: '{group}'
# Formatting for badges, {group} = groupName, {text} = badgeText
badge_format: '{group} | {text}'

Want to use in your own project?

To install in your project, simply reference the KittsBadgeSystem.dll file, found in the latest release.

KittsBadgeSystem.dll is really easy to use, if you would like to change someone's badge data you can do Player.GetBadgeData() and change what you want, it will automatically update. You cna also use the command if you're only using this as a standalone plugin.

A really simple example of using this plugin could be the colour being changed to a random colour when jumping as shown below.

public override void OnPlayerJumped(PlayerJumpedEventArgs ev)
{
    ev.Player.GetBadgeData().BadgeColour = ColourTypes.Random().EnumColour;

    // If you're not using MonogoDB you will need to update the JsonCache as shown below
    DatabaseJson.SaveJsonCache();
}

Found a bug or have feedback?

If you have found a bug please make an issue on GitHub or the quickest way is to message me on discord at kittscloud.

Also message me on discord if you have feedback for me, I'd appreciate it very much. Thank you!