# PteroStats v4 PteroStats Banner

> [!WARNING] > This is a development build! Some features may not work. ## Introduction PteroStats is a Discord Bot that designed to check Pterodactyl or Pelican Panel stats and post it to your Discord server. ## Preview PteroStats V4 Preview

## Installation - [Starting the App](#starting-the-app) - [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) - [Reporting a Bug](#reporting-a-bug) ### Starting the App 1. [Create your Discord App](https://discordjs.guide/preparations/adding-your-bot-to-servers.html). 2. [Invite your Discord App to your Discord server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html). 3. Run `npm install` in the root directory of the app files. 4. Run `node index` and answer the provided questions to set up the app. PteroStats V4 Preview

- [Getting Panel API Key](#getting-panel-api-key) - [Getting a Channel ID](#getting-channel-id) 5. Run `node index` again to start the app, and you're done! If you need help, contact me on [our Discord support server](https://discord.gg/zv6maQRah3). ### Getting Panel API Key > [!WARNING] > The use of Application API keys is **deprecated**; you should use **Client API keys**. 1. Go to your `Pterodactyl` or `Pelican Panel` and navigate to the `Account Page`. Home

2. Click on the `API Credentials` button. Account Page

3. Fill in the `Description` and click the `Create` button. Create Client API Key

4. Copy the API key. API Key

### Getting Channel ID 1. Enable Developer Mode in your Discord settings. Discord User Settings

2. Right-click the text channel and select `Copy ID`. Right Click Channel

### Using Custom Emoji 1. Type `\` in the server that has the custom emoji you want. $Type \ on the chat$ 2. Select the custom emoji you want. Select Custom Emoji

3. Copy the text! Copy Emoji ID

4. Paste the emoji ID into the config. Status Config

### Blacklist Nodes 1. Select a node from the node list on the admin page. Nodes List

2. Check the URL and copy the node ID. Node ID

3. Paste the ID into the blacklist in the config. Blacklist Config

You can add more than one node to the blacklist. Blacklist Config

## 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.gg/zv6maQRah3). ## Links - [PteroStats DiscordJS v13](https://github.com/HirziDevs/PteroStats/tree/3d0512c3323ecf079101104c7ecf3c94d265e298) - [PteroStats DiscordJS v12](https://github.com/HirziDevs/PteroStats/tree/bcfa266be64dda11955f0bf9732da086bcea522c) - [Pelican Panel](https://pelican.dev) - [Pterodactyl Panel](https://pterodactyl.io) - [Pelican API Documentation](https://demo.pelican.dev/docs/api) - [Pterodactyl API Documentation](https://github.com/devnote-dev/ptero-notes/) - [Pterodactyl Discord Server](https://discord.gg/pterodactyl) - [Pelican Discord Server](https://discord.gg/pelican-panel) - [Support Server](https://discord.gg/zv6maQRah3)