docs: improve readme and other guide

2025-12-23 06:15:44 +00:00 · 2024-10-05 09:23:09 +07:00
parent ea0a90ac40
commit 5a6c4d680b
7 changed files with 36 additions and 29 deletions
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@

 # 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"/>
+<img alt="PteroStats Banner" src="https://usercontent.catto.pictures/hirzi/c6880886-21e2-43da-b218-0ac4c229b001.png" width="400"/>

 </div>

@@ -10,33 +10,35 @@
 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"/>
+<div style="display: flex; justify-content: center; align-items: center;">
+    <img alt="PteroStats Setup Preview" src="https://usercontent.catto.pictures/hirzi/b8645828-591d-4d52-b6d8-51f8df60440c.png" width="300" style="margin-right: 20px;"/>
+    <img alt="PteroStats Image Preview" src="https://usercontent.catto.pictures/hirzi/e6f6fe6a-8c0e-4c7a-8b73-d4af752324f4.png" width="300" style="margin-right: 20px;"/>
+    <img alt="PteroStats Console Preview" src="https://usercontent.catto.pictures/hirzi/8ce3aac6-5c46-4626-bd14-af994b602f8e.png" width="300"/>
+</div>

 ## 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)
+- [How to get Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/panel-api-key.md)
+- [How to get Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/channel-id.md)
+- [How to use Custom Emoji](https://github.com/HirziDevs/PteroStats/blob/main/guide/custom-emoji.md)
+- [Blacklist Nodes](https://github.com/HirziDevs/PteroStats/blob/main/guide/blacklist-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).
+1. [Create your Discord App/Bot](https://discordjs.guide/preparations/setting-up-a-bot-application).
 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.
+    - 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)
+    - [Getting an Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/panel-api-key.md)
+    - [Getting a Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/channel-id.md)

 6. Run `node index.js` if you want to start the app/bot again, and you're done!

@@ -46,6 +48,10 @@ PteroStats is a Discord App/Bot designed to check Pterodactyl or Pelican Panel s
 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
+### Support Server
+- [Discord](https://discord.znproject.my.id)
+
+### Pterodactyl & Pelican Panel server
+Please do not ask about PteroStats here.
 - [Pterodactyl Discord Server](https://discord.gg/pterodactyl)
- [Pelican Discord Server](https://discord.gg/pelican-panel) 
- [Support Server](https://discord.znproject.my.id)
+- [Pelican Discord Server](https://discord.gg/pelican-panel)
--- a/config.yml
+++ b/config.yml
@@ -2,21 +2,21 @@
 # Need help? Join our Discord server: https://discord.znproject.my.id
 version: 9 # Warning: Do not change this unless you know what you are doing!

-# App Presence Configuration
+# App/Bot Presence Configuration
 presence:
-  enable: true # Enable or disable app presence.
+  enable: true # Enable or disable app presence (true/false).
  text: "Hosting Panel" # The status text shown by the app.
  type: "watching" # Available types: 'watching', 'playing', 'listening', 'competing'. (Note: 'streaming' is currently unsupported)
  status: "online" # Available types: 'online', 'idle', 'dnd', or 'invisible'

 # Discord Channel and Refresh Timing Configuration
 refresh: 10 # Interval in seconds for refreshing the panel's stats.
-timeout: 5 # Timeout in seconds for node responses. Adjusting this will affect the overall refresh time.
+timeout: 5 # Timeout in seconds for panel and node responses. Adjusting this will affect the overall refresh time.

 # Message and Embed Configuration
 # To disable an option, leave the value as an empty string: ''
 message:
-  content: "" # Custom content for app messages. Set to '' to disable.
+  content: "" # Custom content for app messages.
  attachment: "" # Attachments will delay stats refresh since they are uploaded first.

 embed:
@@ -63,22 +63,22 @@ button:
 #      url: "https://dash2.example.com"

 # Status Message Configuration
-# For details on using custom emojis, visit: https://github.com/HirziDevs/PteroStats#using-custom-emoji
+# How to use Custom Emoji: https://github.com/HirziDevs/PteroStats/blob/main/guide/custom-emoji.md
 status:
  online: ":green_circle: Online" # Status message for when a node is online.
  offline: ":red_circle: Offline" # Status message for when a node is offline.

 # Node Settings
-# Instructions for retrieving node IDs: https://github.com/HirziDevs/PteroStats#blacklist-nodes
+# How to get Node ID: https://github.com/HirziDevs/PteroStats/blob/main/guide/blacklist-nodes.md
 nodes_settings:
  blacklist: [] # Add node IDs to exclude them from the status embed (e.g., blacklist: [1]).
  details: true # Show node details such as memory and disk usage (true/false).
  servers: false # Show server details (true/false).
  allocations_as_max_servers: false # Show allocations as max servers (true/false).
  host: false # Show node host (true/false).
-  unit: "byte" # Unit for node usage, Available types: "byte" or "percentage".
-  uptime: true # Enable or disable node uptime (true/false).
-  limit: 100 # Node limit for usage statistics display.
+  unit: "byte" # Resource Unit, Available types: "byte" or "percentage".
+  uptime: true # Show node uptime (true/false).
+  limit: 100 # Change how much node can will be displayed.

 # Panel Users and Servers Settings
 panel_settings:
@@ -89,6 +89,7 @@ panel_settings:
  users: true # Display users count (true/false).

 # Notifier Configuration
+# How to use notifier: https://github.com/HirziDevs/PteroStats/blob/main/guide/notifier.md
 notifier:
  enable: false # Enable or disable notifier.
  webhook: "" # Discord Webhook URL for the notifier.
@@ -105,4 +106,4 @@ notifier:

 # Error Logging Configuration
 # Enable logging to console if servers go offline, useful for debugging.
-log_error: false # Set to true to enable error logging.
+log_error: false # Set to true to enable error logging (true/false).
--- a/guide/blacklist-specific-nodes.md
+++ b/guide/blacklist-specific-nodes.md
--- a/guide/changing-env-configuration.md
+++ b/guide/changing-env-configuration.md
@@ -7,8 +7,8 @@

    <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)
+    - [Getting an Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/panel-api-key.md)
+    - [Getting a Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/channel-id.md)

 3. Run `node index.js` if you want to start the app/bot again, and you're done!

--- a/guide/getting-channel-id.md
+++ b/guide/getting-channel-id.md
@@ -1,4 +1,4 @@
-## Getting Channel ID
+## Channel ID
 1. Enable Developer Mode in your Discord settings.

    <img alt="Discord User Settings" src="https://usercontent.catto.pictures/hirzi/36894499-b141-488f-98ed-40245c8f6862.png" width="400"/>
--- a/guide/using-custom-emoji.md
+++ b/guide/using-custom-emoji.md
@@ -1,4 +1,4 @@
-## Using Custom Emoji
+## Custom Emoji
 1. Type `\` in the server that has the custom emoji you want.

    <img alt="Type \ on the chat" src="https://usercontent.catto.pictures/hirzi/2e3c821f-92f9-4b5c-863a-e020b2fbc426.png" width="350"/>
--- a/guide/getting-panel-api-key.md
+++ b/guide/getting-panel-api-key.md
@@ -1,4 +1,4 @@
-## Getting Panel API Key 
+## Panel API Key 
 > [!WARNING]
 > The use of Application API keys is **deprecated**; you should use **Client API keys**.