From da627cb21067fe0a3f0570030a5c63a5a14de743 Mon Sep 17 00:00:00 2001 From: Hirzi <64255651+HirziDevs@users.noreply.github.com> Date: Sat, 10 Jul 2021 17:38:20 +0700 Subject: [PATCH] Update README.md --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 45 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a3d803a..7785460 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,24 @@ PteroStats is a bot designed to check Panel, Nodes, and Databases status and post it to 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 +- 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. -Installation --------------------- +## 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 + +- [**ItzyStore**](https://discord.gg/PS4Mf6DBzt) +![img](https://media.discordapp.net/attachments/796259732683227157/863359897210060820/IMG_20210710_164939.jpg) + +- [**SpaceCloud**](https://discord.gg/28z8CYmPEY) +![img](https://media.discordapp.net/attachments/796259732683227157/863359896912658472/IMG_20210710_170313.jpg) + +## Installation - `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) @@ -21,8 +32,7 @@ Installation - `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) -Config --------------------- +## 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 ``` @@ -42,8 +52,7 @@ You need to put right config to make the bot work at [config.json](https://githu } ``` -Adding more nodes --------------------- +## Adding more nodes Add more items like bellow to `nodelist` array at [index.js line 17](https://github.com/HirziDevs/PteroStats/blob/main/index.js) ``` @@ -56,16 +65,36 @@ Add more items like bellow to `nodelist` array at [index.js line 17](https://git if you need help contact me on discord `Hirzi#8701` or join [our discord server here](https://discord.gg/9Z7zpdwATZ) -Screenshot --------------------- +## FAQ -[**ItzyStore**](https://discord.gg/PS4Mf6DBzt) -![img](https://media.discordapp.net/attachments/796259732683227157/863359897210060820/IMG_20210710_164939.jpg) +Q: The node is online but the bot said offline -[**SpaceCloud**](https://discord.gg/28z8CYmPEY) -![img](https://media.discordapp.net/attachments/796259732683227157/863359896912658472/IMG_20210710_170313.jpg) +A: Make sure the serverid is correct and the server is not on installation progress -Links --------------------- +- + +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](https://discord.gg/9Z7zpdwATZ) + +## Links * __[Discord](https://discord.gg/9Z7zpdwATZ)__