mirror of
https://github.com/HirziDevs/PteroStats
synced 2026-01-04 20:24:22 +00:00
47 lines
2.2 KiB
Markdown
47 lines
2.2 KiB
Markdown
<div align="center">
|
|
|
|
# PteroStats
|
|
|
|
<img alt="PteroStats Banner" src="https://usercontent.catto.pictures/hirzi/c6880886-21e2-43da-b218-0ac4c229b001.png" width="400"/>
|
|
|
|
</div>
|
|
|
|
## Introduction
|
|
|
|
PteroStats is a Discord App/Bot designed to check Pterodactyl or Pelican Panel stats and post it to your Discord server.
|
|
|
|
<img alt="PteroStats Image Preview" src="https://usercontent.catto.pictures/hirzi/e6f6fe6a-8c0e-4c7a-8b73-d4af752324f4.png" width="300"/>
|
|
|
|
## 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) |