> For the complete documentation index, see [llms.txt](https://waverlycole.gitbook.io/easyadmin-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://waverlycole.gitbook.io/easyadmin-docs/getting-started.md).

# Getting Started

## Installation

1. Grab the model from here
2. Open Roblox Studio
3. Find the model inside Toolbox -> My Models
4. Insert the model into ServerScriptService or Workspace
5. Done!

{% hint style="info" %}
EasyAdmin will always use the latest published version. No need to update your loader.
{% endhint %}

## Configuration

### Permissions/Ranks

In the Ranks section of the Settings module, you are able to setup permissions for individual users and Roblox groups. By default, the owner of the game will be given owner permissions. (Level 4)

<pre class="language-lua"><code class="lang-lua">Ranks = {
<strong>    --Examples
</strong>    ["Roblox"] = 3, -- Roblox is the username and 3 is the permission level
    [1] = 3, -- 1 Is the UserId and 3 is the permission level
    ["12345:255"] = 3, -- 12345 is the roblox group ID, 255 is the group rank, and 3 is the permission level
},
</code></pre>

### Rank Names

In the RankLookup section of the Settings module, you are able to specify what the textual equivilent is to each of the numbered ranks. You can modify to fit your needs.

<pre class="language-lua"><code class="lang-lua">RankLookup = {
    [0] = "Player", -- Default rank
<strong>    [1] = "Temp-Mod",
</strong><strong>    [2] = "Mod",
</strong>    [3] = "Admin",
    [4] = "Owner"
},
</code></pre>

### Data Key

The DataStoreKey lets you set a custom key, which is used to store all of EasyAdmin's saved data. It is recommended that you change this key from the default value. It does not matter what the key is.

```lua
DataStoreKey = "EasyAdminDefault",
```

{% hint style="warning" %}
Changing this key will reset all of the admin's data.
{% endhint %}

### Prefix, Deliminator, Separator

{% tabs %}
{% tab title="Prefix" %}
The prefix is the character used that will signals a message to be run as a command. For example, to execute a command with the Prefix set to the default value of `;` you will need to chat `;kill waverlycole`

```lua
Prefix = ";",
```

{% endtab %}

{% tab title="Deliminator" %}
The deliminator is used to separate arguments in a command. For example, the `teleport` command accepts 2 arguments `<Player 1> <Player 2>`. The default deliminator is  (space) and can be used by saying `;teleport waverlycole roblox`\`
{% endtab %}
{% endtabs %}