KittsInfractionSystem 0.3.1

KittsInfractionSystem

LabAPI Infraction Tool

KittsInfractionSystem is a tool that adds warning, tempmuting and infraction tracking to 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 KittsInfractionSystem:

There are two options when it comes to installing KittsInfractionSystem, 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 KittsInfractionSystem on your server, you will need:

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

To install KittsInfractionSystem 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.6.0 or later.
• MongoDB.Driver v3.6.0 or later.
• Newtonsoft.Json v13.0.4 or later.
• KittsInfractionSystem 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.
• 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 warn command
warning_permission: kts.warn
# Permission for temp muting command
temp_mute_permission: kts.tempmute
# Permission for viewing infraction command
view_infraction_permission: kts.viewinfractions
# Permission for jail and unjail command
jail_permissions: kts.jail

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: KittsInfractionSystem
# MongoDB collection name
mongo_d_b_collection_name: InfractionData
# Permission for warn command
warning_permission: kts.warn
# Permission for temp muting command
temp_mute_permission: kts.tempmute
# Permission for viewing infraction command
view_infraction_permission: kts.viewinfractions
# Permission for jail and unjail command
jail_permissions: kts.jail

Want to use in your own project?

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

KittsInfractionSystem.dll is mainly a tool and does not have much to offer when referencing, the most important part is the InfractionAdded action which is called when an infraction is added.

InfractionManager Class

I have decided to not include an exmaple as it's VERY easy to use, just attach your own function to the action as shown below

public void OnInfractionAdded(InfractionData data)
{
    // Do something when infraction added
    // For exmaple you can log the data to the console
}

// Make sure to attach the function to the action somewhere
InfractionManager.InfractionAdded += OnInfractionAdded;

Or you can use the functions that the InfractionManager has to offer.

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!