From 84e2d0e9d4bcd1df6ae729bad1b9f564d5c644dd Mon Sep 17 00:00:00 2001 From: hirzidevs Date: Wed, 11 Sep 2024 21:24:39 +0700 Subject: [PATCH] docs: update installation guide in README --- README.md | 36 ++++++++++++++++++------------------ package.json | 2 +- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 7b56f57..5d81078 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,16 @@ -> [!WARNING] -> This is a development build! Some features may not work. - ## Introduction +> [!WARNING] +> This is a development build! Some features may not work as intended. + PteroStats is a Discord Bot that designed to check Pterodactyl or Pelican Panel stats and post it to your Discord server. ## Preview -PteroStats V4 Preview +PteroStats GIF Preview + +PteroStats Image Preview ## Installation - [Starting the App](#starting-the-app) @@ -26,23 +28,27 @@ PteroStats is a Discord Bot that designed to check Pterodactyl or Pelican Panel ### Starting the App 1. [Create your Discord App](https://discordjs.guide/preparations/adding-your-bot-to-servers.html). 2. [Invite your Discord App to your Discord server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html). -3. Run `npm install` in the root directory of the app files. -4. Run `node index` and answer the provided questions to set up the app. +3. [Download the repository](https://github.com/HirziDevs/PteroStats/archive/refs/heads/dev.zip) and extract it. +4. Run `npm install` in the root directory of the app files. +5. Run `node index` and answer the provided questions to set up the app. - PteroStats V4 Preview + Installer - [Getting Panel API Key](#getting-panel-api-key) - [Getting a Channel ID](#getting-channel-id) -5. Run `node index` again to start the app, and you're done! +6. Run `node index` again to start the app, and you're done! -If you need help, contact me on [our Discord support server](https://discord.gg/zv6maQRah3). + Console Logging ### Getting Panel API Key > [!WARNING] > The use of Application API keys is **deprecated**; you should use **Client API keys**. +> [!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`. Home @@ -85,7 +91,7 @@ If you need help, contact me on [our Discord support server](https://discord.gg/ 4. Paste the emoji ID into the config. - Status Config + Status Config ### Blacklist Nodes @@ -99,11 +105,11 @@ If you need help, contact me on [our Discord support server](https://discord.gg/ 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 @@ -111,12 +117,6 @@ Enable `log_error` in the `config.yml` file and check the console for the error ## Links -- [PteroStats DiscordJS v13](https://github.com/HirziDevs/PteroStats/tree/3d0512c3323ecf079101104c7ecf3c94d265e298) -- [PteroStats DiscordJS v12](https://github.com/HirziDevs/PteroStats/tree/bcfa266be64dda11955f0bf9732da086bcea522c) -- [Pelican Panel](https://pelican.dev) -- [Pterodactyl Panel](https://pterodactyl.io) -- [Pelican API Documentation](https://demo.pelican.dev/docs/api) -- [Pterodactyl API Documentation](https://github.com/devnote-dev/ptero-notes/) - [Pterodactyl Discord Server](https://discord.gg/pterodactyl) - [Pelican Discord Server](https://discord.gg/pelican-panel) - [Support Server](https://discord.gg/zv6maQRah3) diff --git a/package.json b/package.json index daf333f..158b0a8 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "repository": "HirziDevs/PteroStats", "homepage": "https://pterostats.znproject.my.id", "bugs": { - "email": "hirzidevs@gmail.com", + "email": "hirzi@znproject.my.id", "url": "https://github.com/HirziDevs/PteroStats/issues" }, "scripts": {