https://github.com/hirzidevs/pterostats

PteroStats is a Discord App/Bot designed to check Pterodactyl or Pelican Panel stats and post it to your Discord server.
https://github.com/hirzidevs/pterostats

discord discord-bot discord-js nodejs pterodactyl-api pterodactyl-panel-api status-page yaml-configuration

Last synced: 4 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/hirzidevs/pterostats
• Owner: HirziDevs
• License: mit
• Created: 2021-06-29T05:36:18.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-16T13:48:43.000Z (3 months ago)
• Last Synced: 2025-01-26T21:04:55.338Z (4 days ago)
• Topics: discord, discord-bot, discord-js, nodejs, pterodactyl-api, pterodactyl-panel-api, status-page, yaml-configuration
• Language: JavaScript
• Homepage: https://pterostats.znproject.my.id
• Size: 333 KB
• Stars: 213
• Watchers: 5
• Forks: 112
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# PteroStats





## Introduction

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



## Installation

> Node.js 18 or newer is required.

1. [Create your Discord App/Bot](https://discordjs.guide/preparations/setting-up-a-bot-application).

2. [Invite your Discord App/Bot to your Discord server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html).

3. Choose installation method.

    - [Using egg (Recomended)](https://github.com/HirziDevs/PteroStats/blob/main/guide/installation/egg.md)

    - [Manual](https://github.com/HirziDevs/PteroStats/blob/main/guide/installation/manual.md)

    - [Using docker](https://github.com/HirziDevs/PteroStats/blob/main/guide/installation/docker.md)

## Guide

- [Changing Env Configuration](https://github.com/HirziDevs/PteroStats/blob/main/guide/changing-env-configuration.md)

- [How to get Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/panel-api-key.md)

- [How to get Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/channel-id.md)

- [How to use Custom Emoji](https://github.com/HirziDevs/PteroStats/blob/main/guide/custom-emoji.md)

- [Blacklist Nodes](https://github.com/HirziDevs/PteroStats/blob/main/guide/blacklist-nodes.md)

- [Notifier (Discord Webhook)](https://github.com/HirziDevs/PteroStats/blob/main/guide/notifier.md)

## Reporting a Bug

Enable `log_error` in the `config.yml` file and check the console for the error message. Please also send the `logs.txt` file created by the bot, which contains information that will help with the bug report. After that, report it to our Discord server at [Support Server](https://discord.znproject.my.id).

## Links

### Support Server

- [Discord](https://discord.znproject.my.id)

### Pterodactyl & Pelican Panel server

Please do not ask about PteroStats here.

- [Pterodactyl Discord Server](https://discord.gg/pterodactyl)

- [Pelican Discord Server](https://discord.gg/pelican-panel)