mirror of
https://github.com/HirziDevs/PteroStats
synced 2026-01-08 07:11:48 +00:00
Update README.md
This commit is contained in:
60
README.md
60
README.md
@@ -14,11 +14,11 @@ PteroStats is a bot designed to check Pterodactyl Panel and Nodes status and pos
|
||||
|
||||
PteroStats is still **under development** and we welcome contributions.
|
||||
|
||||
## How it works?
|
||||
### How it works?
|
||||
|
||||
PteroStats checks [pterodactyl](https://pterodactyl.io) server(s) [resource api](https://dashflo.net/docs/api/pterodactyl/v1/#req_a8875d2840c64cbdb40e9bdb6cba4f75) with [axios](https://www.npmjs.com/package/axios) to get server resource, if the api didn't reply that mean the node of the server is getting [wings/daemon](https://pterodactyl.io/wings/1.0/installing.html) down and mark the node as offline
|
||||
|
||||
## Screenshot
|
||||
### Screenshot
|
||||
|
||||
- [**ItzyStore**](https://discord.gg/PS4Mf6DBzt)
|
||||

|
||||
@@ -30,30 +30,52 @@ PteroStats checks [pterodactyl](https://pterodactyl.io) server(s) [resource api]
|
||||
|
||||
- `Create server at your pterodactyl panel and copy the server id`
|
||||
- `Paste the server id at nodelist array` [index.js line 17](https://github.com/HirziDevs/PteroStats/blob/main/index.js)
|
||||
- `fill in the required informations in the config.json file`
|
||||
- `fill in the required informations in the config.yml file`
|
||||
- `Run npm install in the root directory of the bot files`
|
||||
- `Run node index.js and you are done`
|
||||
- `To add more nodes go to this link` [This Link](https://github.com/HirziDevs/PteroStats#adding-more-nodes-and-databases)
|
||||
|
||||
### Setuping Config
|
||||
|
||||
You need to put right config to make the bot work at [config.json](https://github.com/HirziDevs/PteroStats/blob/main/config.json) file
|
||||
You need to put right config to make the bot work at [config.yml](https://github.com/HirziDevs/PteroStats/blob/main/config.yml) file
|
||||
```
|
||||
{
|
||||
"token": "BOT TOKEN", //Your Discord Bot Token
|
||||
"panelurl": "HOST PANEL LINK", //Your Hosting Panel Url/Link
|
||||
"clientapikey": "CLIENT APIKEY", //Your Hosting Client Apikey
|
||||
"adminapikey": "ADMIN APIKEY", //Your Hosting Admin/Application Apikey
|
||||
"channel": "CHANNEL ID", //Your Discord Channel Id For The Embed
|
||||
"hostname": "HOSTING NAME", //Your Hosting Name
|
||||
"embedcolor": "E5BE11", //Embed Color
|
||||
"monline": ":green_circle: Online", //Status Online Message
|
||||
"moffline": ":red_circle: Offline", //Status Offline Message
|
||||
"mcheck": ":orange_circle: Checking", //Status Checking Message
|
||||
"footer": "By Hirzi#8701", //Footer for the embed
|
||||
"enabletimestamp": "yes", //Enable/Disable Timestampbon embed footer
|
||||
"time": "60" //How Much Seconds The Embed Will Be Refreshes
|
||||
}
|
||||
# PteroStats config
|
||||
# If you need help, join our discord server: https://discord.gg/9Z7zpdwATZ
|
||||
|
||||
# Bot Info's
|
||||
token: 'BOT TOKEN' # Put bot token here, check https://discord.dev to create and get bot token
|
||||
botstatus:
|
||||
enable: false # Enable Custom Status (MUST BE "TRUE" OR "FALSE")
|
||||
text: 'Hosting Panel' # Bot Status Message
|
||||
type: 'WATCHING' # Bot Status Type. Ex: PLAYING, WATCHING, LISTENING, STREAMING
|
||||
|
||||
# Channel and RefreshTime Configuration
|
||||
channel: 'CHANNEL ID' # Put channel id here where the embed will be sended
|
||||
refreshtime: 60 # Time when the embed edited/refreshed (MUST BE A SECONDS)
|
||||
|
||||
# Panel Info's
|
||||
panel:
|
||||
url: 'HOST PANEL LINK' # Put panel url here. Example: https://panel.purenodes.net
|
||||
clientkey: 'CLIENT APIKEY' # Put Client ApiKey here. check https://your.host.url/account/api (your.host.urrl is an example link)to get the Client Apikey
|
||||
adminkey: 'ADMIN APIKEY' # Put Admin Apikey here. check https://your.host.url/admin/api (your.host.urrl is an example link) to get the Admin ApiKey
|
||||
|
||||
# Embed Configuration
|
||||
embed:
|
||||
title: 'EMBED TITLE' # Embed Title here. Ex: PureNodes Stats
|
||||
color: 'E5BE11' # Embed Hex color here.
|
||||
description:
|
||||
enable: false # Enable Embed Description (MUST BE "TRUE" OR "FALSE")
|
||||
text: 'EMBED DESCRIPTION' # Embed Description
|
||||
footer:
|
||||
enable: true # Enable Embed Footer (MUST BE "TRUE" OR "FALSE")
|
||||
text: 'By Hirzi#8701' # Embed Footer
|
||||
timestamp: true # Enable Embed TimeStamp (MUST BE "TRUE" OR "FALSE")
|
||||
|
||||
# Status Message Configuration
|
||||
status:
|
||||
online: ':green_circle: Online' # Message if the status is Online
|
||||
offline: ':red_circle: Offline' # Message if the status is Offline
|
||||
check: ':orange_circle: Checking' # Message if the status is Checking
|
||||
```
|
||||
|
||||
### Adding more nodes
|
||||
|
||||
Reference in New Issue
Block a user