> For the complete documentation index, see [llms.txt](https://cozy-1.gitbook.io/dev-example2/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cozy-1.gitbook.io/dev-example2/currency/setup-guide.md).

# Setup Guide

#### Step 1:

Upload our plugin to the plugins folder found on your server. Proceed to placing your license in the configuration file (instructions: <https://docs.mantic.dev/welcome#how-can-i-claim-my-license>). Then, start up your server.

#### Step 2:

Open the configuration file located at `plugins/manticcurrency/config.yml`.

* **Database Setup**: Ensure your `databaseType` (JSON, SQLITE, or MYSQL) is set according to your needs. If using MYSQL, fill in your `mysqlIp`, `mysqlUsername`, `mysqlPassword`, and `mysqlDatabaseName`.
* **Permissions & Security**: Review the `Security Settings` section. By default, many administrative commands are restricted to the Console only to prevent accidental or malicious use. Adjust the `restrict...ToConsole` settings if you wish to allow these commands in-game.

📓 Notes: A server RESTART is required if you change the `databaseType`.

#### Step 3:

Restart your server to apply your configuration changes.

* The plugin will automatically generate the required database tables or JSON data structure upon startup.
* Once initialized, you can begin using `/manticcurrency` commands to manage balances, shops, and sales.

\
:notebook: **Notes:**  Avoid performing this step on a live server, as the security system may flag and ban players who are not yet listed.

#### :robot: Step 4 (Discord **Integration**):

If you do not want this option enabled, you can ignore this section entirely.

#### 1. Go to Your Discord Channel Settings

* Open Discord.
* Navigate to the **text channel** where you want alerts to be sent.
* Click the **gear icon** next to the channel name.

#### **2. Open the Integrations Menu**

* Inside the channel settings, click **Integrations**.
* Then click **Webhooks**.

#### **3. Create a Webhook**

* Click **Create Webhook**.
* Set a **name** (e.g., `ManticCurrency Alerts`).
* *(Optional) Upload an **avatar** for cleaner embeds.*
* Ensure the webhook is assigned to the correct **channel**

#### **4. Copy the Webhook URL**

* Click **Copy Webhook URL**.
* Paste this link into your `config.yml` under the corresponding webhook section of ManticCurrency.

#### **5. Save and Apply**

* Press **Save** in Discord.
* Restart/reload your server so `ManticCurrency` can use the new webhook.

<br>