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
1c20949f2086988ee8abbd2231f473636410c82a
PteroStats/README.md
Hirzi 1c20949f20 docs: update installation guide in README
2024-09-10 09:53:27 +07:00

4.9 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

Starting the App

  1. Create your Discord App.

  2. Invite your Discord App to your Discord server.

  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

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

If you need help, contact me on our Discord support server.

Getting Panel API key

Warning

The use of Application API keys are deprecated, you should use Client API keys.

  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

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

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

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