# Setup Guide

URL: https://zerodev.ca/docs/product-panel/setup

> Install Product Panel on AthenaBot and activate your license.



Product Panel 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`, `web_api`. These come with AthenaBot. Make sure none of them are disabled.                            |
| npm packages      | `archiver`. AthenaBot installs these for you on the next start.                                               |
| License key       | From the [Zero Development Discord](https://discord.zerodev.ca). Open a ticket with your BuiltByBit username. |

Product Panel does not need ZDLibrary or any other Zero Development plugin.

## Install

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

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

| Console message                                         | Fix                                                                     |
| ------------------------------------------------------- | ----------------------------------------------------------------------- |
| `[productpanel] No license key found in configuration.` | `LICENSE_KEY` is empty.                                                 |
| `[productpanel] License verification failed: ...`       | The key is wrong, revoked or for another product. Check it in a ticket. |
| `Plugin productpanel 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                  |
| ------------------- | ------------------------------- |
| `productPanel-logs` | A log entry for every download. |

## 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 `productpanel.json5`.

## Next

Add a panel and its products in `productpanel.json5`, put each product's files in its folder, then post the panel with `/productpanel panel`. See [Usage](/docs/product-panel/usage).