# Getting Started

{% hint style="warning" %}
The API functions are designed for programmers. If you do not know Lua, consider learning it through the [Developer Hub](https://developer.roblox.com/en-us/).
{% endhint %}

{% hint style="danger" %}
Make sure you have set up your system and that it is working before you start programming Plugins. [Manual](https://devforum.roblox.com/t/checkmein-3-1-manual/236337)
{% endhint %}

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

```lua
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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api.checkmein.cloud/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
