# PteroStats
## Guide
- [Starting the App/Bot](#starting-the-appbot)
- [Changing Env Configuration](#changing-env-configuration)
- [Getting an Panel API key](#getting-panel-api-key)
- [Getting a Channel ID](#getting-channel-id)
- [Using Custom Emoji](#using-custom-emoji)
- [Blacklist Nodes](#blacklist-nodes)
- [Notifier](#notifier)
### Starting the App/Bot
1. [Create your Discord App/Bot](https://discordjs.guide/preparations/adding-your-bot-to-servers.html).
2. [Invite your Discord App/Bot to your Discord server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html).
3. Download this repository:
- [Download this repository](https://github.com/HirziDevs/PteroStats/archive/refs/heads/main.zip) and extract it.
- Using Git: Run `git clone https://github.com/HirziDevs/PteroStats.git` in the command line.
4. Run `npm install` in the root directory of the app/bot files.
5. Run `node index` and answer the prompted questions to set up the app/bot.
- [Getting Panel API Key](#getting-panel-api-key)
- [Getting a Channel ID](#getting-channel-id)
6. Run `node index` if you want to start the app/bot again, and you're done!
### Changing Env Configuration
> [!TIP]
> You can change other configuration at the `config.yml` file.
1. Run `node setup` in the root directory of the app/bot files.
2. Enter `2` to change configuration.
3. Answer the provided question to set up the app/bot.
4. Run `node index` if you want to start the app/bot again, and you're done!
### Getting Panel API Key
> [!WARNING]
> The use of Application API keys is **deprecated**; you should use **Client API keys**.
> [!TIP]
> Make sure the owner of the Client API key has access to the administrator panel.
1. Go to your `Pterodactyl` or `Pelican` Panel and navigate to the `Account Page`.
2. Click on the `API Credentials` button.
3. Fill in the `Description` and click the `Create` button.
4. Copy the API key.
### Getting Channel ID
1. Enable Developer Mode in your Discord settings.
2. Right-click the text channel and select `Copy ID`.
### Using Custom Emoji
1. Type `\` in the server that has the custom emoji you want.
2. Select the custom emoji you want.
3. Copy the text!
4. Paste the emoji ID into the config.
### Blacklist Nodes
1. Select a node from the node list on the admin page.
2. Check the URL and copy the node ID.
3. Paste the ID into the blacklist in the config.
> [!TIP]
> You can add more than one node to the blacklist.
### Notifier
Get a notification on Discord when your panel or specific nodes are currently down.
#### Enabling Notifier
Open `config.yml` and set `enable` at the notifier configuration to `true`
#### Getting Discord Webhook URL
1. Go to the channel settings of the channel you want to set for the notifier.
2. Go to integrations and select `View Webhooks` or `Create Webhook`.
3. Create a new webhook and copy the Webhook URL
4. Paste the Webhook URL on the webhook notifier configuration.
> [!TIP]
> You can change the webhook icon and username on the webhook settings.
## Reporting a Bug
Enable `log_error` in the `config.yml` file and check the console for the error message. After that, report it to our Discord server at [Support Server](https://discord.znproject.my.id).
## Links
- [Pterodactyl Discord Server](https://discord.gg/pterodactyl)
- [Pelican Discord Server](https://discord.gg/pelican-panel)
- [Support Server](https://discord.znproject.my.id)