# Setup Guide

URL: https://zerodev.ca/docs/emoji-locker/setup

> Install Emoji Locker on AthenaBot and activate your license.



Emoji Locker is a plugin for AthenaBot by Iynx Development. It runs inside your AthenaBot install and is set up through its config files.

## Requirements

| Requirement       | Details                                                                                                       |
| ----------------- | ------------------------------------------------------------------------------------------------------------- |
| AthenaBot         | **2.5.0** or newer                                                                                            |
| AthenaBot plugins | `core`. These come with AthenaBot. Make sure none of them are disabled.                                       |
| npm packages      | None                                                                                                          |
| License key       | From the [Zero Development Discord](https://discord.zerodev.ca). Open a ticket with your BuiltByBit username. |

Emoji Locker does not need ZDLibrary or any other Zero Development plugin.

## Install

1. Stop AthenaBot.
2. Extract the download and put the `emojilocker` folder in AthenaBot's `plugins/` folder, so you have `plugins/emojilocker/main.js`.
3. Start AthenaBot once. It creates `configuration/emojilocker.json5` and `configuration/emojilocker-lang.json5`, then disables the plugin because there is no license key yet.
4. Open `configuration/emojilocker.json5` and paste your key into `LICENSE_KEY`.
5. Restart AthenaBot.

When the license is accepted, the console prints the Emoji Locker banner. If it is not, the console says why and the plugin stays off:

| Console message                                        | Fix                                                                     |
| ------------------------------------------------------ | ----------------------------------------------------------------------- |
| `[emojilocker] No license key found in configuration.` | `LICENSE_KEY` is empty.                                                 |
| `[emojilocker] License verification failed: ...`       | The key is wrong, revoked or for another product. Check it in a ticket. |
| `Plugin emojilocker requires Athena version 2.5.0`     | Update AthenaBot.                                                       |

The license is checked against `api.zerodev.ca` each time AthenaBot starts, so the server needs internet access.

## Channels

Set this channel with AthenaBot's `/setup` command:

| Channel            | What it is for                                        |
| ------------------ | ----------------------------------------------------- |
| `emojiLocker-logs` | A log entry every time emojis are locked or unlocked. |

## Permissions

Commands and buttons use AthenaBot's permission levels from `configuration/permission.json5`, such as `admin`, `staff` or `everyone`. A level also lets in anyone with a higher role. Set the level for each action under `permissions` in `emojilocker.json5`.

## Next

Run `/emojilocker` in your server. See [Usage](/docs/emoji-locker/usage).