PteroStats v4

PteroStats Banner

Introduction

Warning

This is a development build! Some features may not work as intended.

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

Preview

PteroStats GIF Preview PteroStats Image Preview

Installation

Starting the App

  1. Create your Discord App.

  2. Invite your Discord App to your Discord server.

  3. Download the repository and extract it.

  4. Run npm install in the root directory of the app files.

  5. Run node index and answer the provided questions to set up the app.

    Installer
  6. Run node index again to start the app, and you're done!

    Console Logging

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.

    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.

Description
No description provided
Readme MIT 668 KiB
Languages
JavaScript 99.8%
Dockerfile 0.2%