PteroStats/README.md

PteroStats

Introduction

PteroStats is a bot designed to check Pterodactyl Panel and Nodes status and post it to your discord server

• Written in Javascript, CloudServer is faster and more stable.
• PteroControl can be used with any server on Pterodactyl, irregardless of whether it's on shared hosting or your own hosted panel

PteroStats is still under development and we welcome contributions.

How it works?

PteroStats checks pterodactyl server(s) resource api with axios to get server resource, if the api didn't reply that mean the node of the server is getting wings/daemon down and mark the node as offline

Screenshot

• ItzyStore (No screenshot for resource becouse it will be long image)
• SpaceCloud

Installation

• Create server for each nodes at your pterodactyl panel and copy the server id
• Go to your node list at admin panel, the go to the node you want to get id, and then look the web link, the last number after nodes/ is your node id
• Paste the server id and node id at nodelist array nodes.js
• 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

Getting ServerID

• Go to your pterodactyl panel
• And then select server you want to use
• Go to settings tab
• Scroll, go to debug information and you will find server id
• Copy the first word like on this image

Getting NodeID

• Go to your location page at your pterodactyl admin panel
• Look at before your nodes name
• The nodes id will be there like on this image

Setuping Config

You need to put right config to make the bot work at config.yml file

# PteroStats config
# If you need help, join our discord server: https://discord.gg/zv6maQRah3

# 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) (RECOMMENDED MORE THAN 20 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.url 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.url 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

# Node Resource
resource:
  enable: false # Enable resource option ex [Ram: 2gb/5gb] bellow node name (MUST BE "true" OR "false")
  servers: true # Enable Total server on the node to resource text (MUST BE "true" OR "false")
  allocations: true # Enable Total Allocation on the node to resource text (MUST BE "true" OR "false")
  location: true # Enable location short name on the node to resource text (MUST BE "true" OR "false")
  unit: 'gb' # Must be 'mb', 'gb', or 'percent'

# Developers feature
debug: false # Enable and Disable debug log to console
debugaxios: false #Enable and Disable axios error logs

Adding more nodes

Add more items like bellow per each node to nodelist array at nodes.js

{
    id: "Server ID",
    name: "**Example Server**",
    nameid: "Node1",
    nodeid: "1"
},

if you need help contact me on discord Hirzi#8701 or join our discord server here

Other

FAQ

Q: The node is online but the bot said offline

A: Make sure the serverid is correct and the server is not on installation progress

Q: Do the server must be online?

A: No, the bot can still checks server while it online or offline

Q: Can i use pterodactyl v0.7?

A: No, the pterodactyl v0.7 is not supported

Q: How much nodes can i add?

A: You can add as much your panel have

Q: How i can get support?

A: You can join our discord server

Links

• PteroBot Discord
• Pterodactyl Panel
• Pterodactyl API