KittsCEventSystem 0.1.1

KittsCEventSystem

LabAPI Custom Events Framework

KittsCEventSystem is a framework that makes adding event easy 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 KittsCEventSystem:

To install KittsCEventSystem on your server, you will need:

• KittsCEventSystem latest version.

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

Once you have these:

• Place KittsCEventSystem.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
# Whether in-built example events are enabled
enable_examples: true
# Permission for clear cevent queue command
clear_c_event_queue: kts.clearceventqueue
# Permission for list cevents command
list_c_events: kts.listcevents
# Permission for queue cevent command
queue_c_event: kts.queuecevent
# Permission for remove queued cevent command
remove_queued_c_event: kts.removequeuedcevent
# Permission for stop current cevent command
stop_current_c_event: kts.stopcurrentcevent
# Permission for view queued cevent command
view_c_event_queue: kts.viewqueuedcevent

Want to use in your own project?

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

Create a new class inheriting the CEvent class.

Example CEvent

public class Test : CEvent
{
    public override string Name { get; } = "Name Here";

	public override string Description { get; } = "Description Here";

	public override int Id { get; } = 1;
	
	// Your custom events below
}

CEvent Class

GlobalCEvent Class

Works the same as a CEvent however the parameters are already set and configs don't get used if defined, they are only for puttint in override of events.

CEventManager Class

You can look at the Examples folder to get a better idea of how to create a CEvent, CEvent with a config and a GlobalCEvent.

When you enable your plugin, simply run:

CEventManager.RegisterAllEvents();

This will register all CEvents in your assembly. It is important to keep KittsCEventSystem.dll in the plugins folder, as it must run as a plugin in order to register menus from all assemblies with KittsCEventSystem.dll.

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!