PteroStats

Introduction

PteroStats is a Discord App/Bot that designed to check Pterodactyl or Pelican Panel stats and post it to your Discord server.

Preview

Guide

• Starting the App/Bot
• Changing Env Configuration
• Getting an Panel API key
• Getting a Channel ID
• Using Custom Emoji
• Blacklist Nodes

Starting the App/Bot

1. Create your Discord App/Bot.

2. Invite your Discord App/Bot to your Discord server.

3. Download this repository:

   • Downloading this repository and extract it.
   • Using Git: Run git clone -b dev 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 provided questions to set up the app/bot.

   
   • Getting Panel API Key
   • Getting a 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.

   

You can add more than one node to the blacklist.

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.

Links

• Pterodactyl Discord Server
• Pelican Discord Server
• Support Server