Getting Started

This guide will cover the basics of CheckMeIn's Plugin system.

The API functions are designed for programmers. If you do not know Lua, consider learning it through the Developer Hub.

Make sure you have set up your system and that it is working before you start programming Plugins. Manual

CheckMeIn has a rich API that can be accessed through Plugins. Making a plugin is quite simple.

1. Create a ModuleScript under Workspace.CheckMeIn.Plugins

2. Name it what you want

3. Paste the following template into the script

return{
['Enabled'] = true; -- Is this plugin enabled?
['Function'] = function(API)
-- Your code goes here
end}

At the start of the game, Function is called by the server, it will pass the API value which you can use to call API functions. To find out what functions there are, proceed to the next page.