mirrors/PteroStats
1
0
Fork 0
mirror of https://github.com/HirziDevs/PteroStats synced 2026-01-08 07:11:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
c20f528990b378c26862693b792c815794dbc618
PteroStats/README.md
Hirzi c20f528990 docs: update installation guide in README
2024-09-10 08:44:35 +07:00

4.8 KiB
Raw Blame History

PteroStats v4

PteroStats Banner

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

  1. Getting API key
  2. Creating Discord Bot
  3. Inviting Discord Bot
  4. Getting Channel ID
  5. Starting bot

Getting API key

Warning

The use of Application API keys are deprecated, you should use Client API keys in the config file

  1. Go to your Pterodactyl or Pelican Panel and go to Account Page.

    Home

  2. Click on the API Credentials button

    Account Page

  3. Fill the Description and click on the Create button

    Create Client API Key

  4. Copy the API key.

    API Key

Creating Discord Bot

Please refer to this website

Inviting Discord Bot

Please refer to this website

Getting Channel ID

  1. Enable Developer Feature at your discord settings

    Discord User Settings

  2. Right Click text channel and select Copy ID

    Right Click Channel

Starting bot

  1. Make sure you have done the things above

  2. Run npm install in the root directory of the bot files.

  3. Run node index and fill given question to setup the bot.

    PteroStats V4 Preview

  4. Run node index again to start the bot and you are done.

if you need help contact me on our discord support server

Using Custom Emoji

  1. type \ in server that has custom emoji you want

    Type \ on the chat

  2. Select custom emoji you want

    Select Custom Emoji

  3. Copy the text!

    Copy Emoji ID

  4. Paste the emoji id at the config

    Status Config

Blacklist Nodes

  1. Select node from node list on admin page

    Nodes List

  2. Check the url and copy the node id

    Node Id

  3. Paste the id to the blacklist on config

    Blacklist Config

You can add more than one node in the blacklist

Blacklist Config

The node is online but the embed is read as offline

If you having this issue, you can enable log_error on the config file and report it to our discord server at Support Server

Links