mirror of
https://github.com/HirziDevs/PteroStats
synced 2026-08-17 12:46:26 +00:00
52 lines
3.0 KiB
Markdown
52 lines
3.0 KiB
Markdown
<div align="center">
|
|
|
|
# PteroStats
|
|
|
|
<img alt="PteroStats Banner" src="https://images-ext-2.discordapp.net/external/oRPpwML4JUV0HbsPKtsghvIjS5ZrVwqH2KQ4tevg_Jg/https/repository-images.githubusercontent.com/381250920/e9acc9c2-2fbd-4fb0-8554-9788146d817e" 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.
|
|
|
|
## Preview
|
|
<img alt="PteroStats Image Preview" src="https://usercontent.catto.pictures/hirzi/e6f6fe6a-8c0e-4c7a-8b73-d4af752324f4.png" width="300"/>
|
|
|
|
<img alt="PteroStats Console Preview" src="https://usercontent.catto.pictures/hirzi/8ce3aac6-5c46-4626-bd14-af994b602f8e.png" width="300"/>
|
|
|
|
## Guide
|
|
- [Starting the App/Bot](#starting-the-appbot)
|
|
- [Changing Env Configuration](https://github.com/HirziDevs/PteroStats/blob/main/guide/changing-env-configuration.md)
|
|
- [Getting an Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/getting-panel-api-key.md)
|
|
- [Getting a Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/getting-channel-id.md)
|
|
- [Using Custom Emoji](https://github.com/HirziDevs/PteroStats/blob/main/guide/using-custom-emoji.md)
|
|
- [Blacklist Nodes](https://github.com/HirziDevs/PteroStats/blob/main/guide/blacklist-specific-nodes.md)
|
|
- [Notifier](https://github.com/HirziDevs/PteroStats/blob/main/guide/notifier.md)
|
|
- [Docker](https://github.com/HirziDevs/PteroStats/blob/main/guide/docker.md)
|
|
|
|
### Starting the App/Bot
|
|
1. [Create your Discord App/Bot](https://discordjs.guide/preparations/adding-your-bot-to-servers.html).
|
|
2. [Invite your Discord App/Bot to your Discord server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html).
|
|
3. Download this repository:
|
|
- Manually: [Download this repository](https://github.com/HirziDevs/PteroStats/archive/refs/heads/main.zip) and extract it.
|
|
- Using Git: Run `git clone https://github.com/HirziDevs/PteroStats.git` in the command line.
|
|
4. Run `npm install` in the root directory of the app/bot files.
|
|
5. Run `node index.js` and answer the prompted questions to set up the app/bot.
|
|
|
|
<img alt="Setup" src="https://usercontent.catto.pictures/hirzi/b8645828-591d-4d52-b6d8-51f8df60440c.png" width="300"/>
|
|
|
|
- [Getting an Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/getting-panel-api-key.md)
|
|
- [Getting a Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/getting-channel-id.md)
|
|
|
|
6. Run `node index.js` if you want to start the app/bot again, and you're done!
|
|
|
|
<img alt="Console Logging" src="https://usercontent.catto.pictures/hirzi/8ce3aac6-5c46-4626-bd14-af994b602f8e.png" width="300"/>
|
|
|
|
## 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](https://discord.znproject.my.id).
|
|
|
|
## Links
|
|
- [Pterodactyl Discord Server](https://discord.gg/pterodactyl)
|
|
- [Pelican Discord Server](https://discord.gg/pelican-panel)
|
|
- [Support Server](https://discord.znproject.my.id)
|