From d1ef562431394977473a7381a37668224b03c561 Mon Sep 17 00:00:00 2001 From: hirzidevs Date: Fri, 13 Sep 2024 20:31:58 +0700 Subject: [PATCH] docs: update README --- README.md | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 69bf81a..54162c5 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ PteroStats is a Discord App/Bot that designed to check Pterodactyl or Pelican Pa ## Preview PteroStats Image Preview +PteroStats Image Preview + PteroStats GIF Preview ## Guide @@ -28,29 +30,29 @@ PteroStats is a Discord App/Bot that designed to check Pterodactyl or Pelican Pa ### 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 by: +3. Download this repository: - [Downloading this repository](https://github.com/HirziDevs/PteroStats/archive/refs/heads/dev.zip) and extract it. - - Using Git: Run `git clone -b dev https://github.com/HirziDevs/PteroStats.git .` in the command line. + - Using Git: Run `git clone -b dev 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` and answer the provided questions to set up the app/bot. - Setup + Setup - [Getting Panel API Key](#getting-panel-api-key) - [Getting a Channel ID](#getting-channel-id) 6. Run `node index` if you want to start the app/bot again, and you're done! - Console Logging + Console Logging ### Changing Env Configuration 1. Run `node setup` in the root directory of the app/bot files. 2. Enter `2` to change configuration. - Change Configuration + Change Configuration 3. Answer the provided question to set up the app/bot. -4. Run `node index` if you want ti start the app/bot again, and you're done! +4. Run `node index` if you want to start the app/bot again, and you're done! ### Getting Panel API Key > [!WARNING] @@ -59,21 +61,21 @@ PteroStats is a Discord App/Bot that designed to check Pterodactyl or Pelican Pa > [!TIP] > Make sure the owner of the Client API key has access to the administrator panel. -1. Go to your `Pterodactyl` or `Pelican Panel` and navigate to the `Account Page`. +1. Go to your `Pterodactyl` or `Pelican` Panel and navigate to the `Account Page`. - Home + Home 2. Click on the `API Credentials` button. - Account Page + Account Page 3. Fill in the `Description` and click the `Create` button. - Create Client API Key + Create Client API Key 4. Copy the API key. - API Key + API Key ### Getting Channel ID 1. Enable Developer Mode in your Discord settings. @@ -104,19 +106,23 @@ PteroStats is a Discord App/Bot that designed to check Pterodactyl or Pelican Pa ### Blacklist Nodes 1. Select a node from the node list on the admin page. - Nodes List + Pterodactyl Nodes List + + Pelican Nodes List 2. Check the URL and copy the node ID. - Node ID + Pterodactyl Node ID + + Pelican Node ID 3. Paste the ID into the blacklist in the config. - Blacklist Config + Blacklist Config You can add more than one node to the blacklist. -Blacklist Config +Blacklist Config ## 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).