Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 3 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 (about 3 years ago)
Default Branch: main
Last Pushed: 2024-09-19T01:16:39.000Z (9 days ago)
Last Synced: 2024-09-24T11:03:45.418Z (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: 300 KB
Stars: 191
Watchers: 5
Forks: 112
Open Issues: 1
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.

## Preview





## 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.

    

    - [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!

    

## 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)