Add a few emojis to the README

3urobeat · Dec 24, 2023 · d320fa0 · d320fa0
1 parent cbcb0b3
commit d320fa0
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@
 
 <p align="center">
   <a href="#introduction">Introduction</a> •
-  <a href="#setup--config-guide">Setup & Config Guide</a> •
+  <a href="#setup-config-guide">Setup & Configuration Guide</a> •
   <a href="#the-wiki">Wiki</a> •
   <a href="#questions-bugs-issues--betas">Get Help</a> •
   <a href="#license">License</a>
@@ -28,9 +28,12 @@
 
 &nbsp;
 
-## **Introduction**  
+<a id="introduction"></a>
+
+## ✨ **Introduction**  
 <img align="right" width="200" height="200" src="https://3urobeat.com/comment-bot/mesh.png">  
 
+**Features:**
 * Request profile, group, screenshot, artwork, guide or discussion comments directly from the Steam Chat
 * Manage hundreds of Steam accounts with ease and control them from **one** terminal and Steam Chat
 * No need of having a Steam Client installed - perfect for hosting on a server
@@ -46,13 +49,15 @@ If you would like to rather follow a video than these written instructions, clic
 
 &nbsp;
 
-## Setup & Config Guide:
+<a id="setup-config-guide"></a>
+
+## 🚀 Setup & Configuration Guide:
 Follow the Wiki's [**Setup Guide by clicking here**](./docs/wiki/setup_guide.md) to get started!  
 This process is pretty simple and should not take you long!  
 
 &nbsp;
 
-## Additional Information: <a href="https://youtu.be/8J78rC9Z28U?t=339" target="_blank"><img align="right" src="https://img.shields.io/badge/YouTube-Tutorial%20section-red"></a>
+## 💡 Additional Information: <a href="https://youtu.be/8J78rC9Z28U?t=339" target="_blank"><img align="right" src="https://img.shields.io/badge/YouTube-Tutorial%20section-red"></a>
 <div align="center">
 
 [![Sponsor](https://img.shields.io/badge/Sponsor-%241-orange)](https://github.com/sponsors/3urobeat) ![Star](https://img.shields.io/github/stars/3urobeat/steam-comment-service-bot)  

diff --git a/src/data/fileStructure.json b/src/data/fileStructure.json
@@ -53,7 +53,7 @@
         {
             "path": "README.md",
             "url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/README.md",
-            "checksum": "3bbdee2047bb9236f7c42d9f4e9c7c9d"
+            "checksum": "1c634a89128ad04be9e9907ec88c1f0f"
         },
         {
             "path": "docs/dev/README.md",
@@ -803,7 +803,7 @@
         {
             "path": "types/types.d.ts",
             "url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/types/types.d.ts",
-            "checksum": "10e64a2b2d1ad53429f979609785134a"
+            "checksum": "4c8759a97dd01ab1b0a2e0d1601d80cf"
         }
     ]
 }
diff --git a/types/types.d.ts b/types/types.d.ts
@@ -1238,10 +1238,12 @@ declare class PluginSystem {
      */
     loadPluginConfig(pluginName: string): Promise<object>;
     /**
-     * Integrates changes made to the config to the users config
+     * Internal: Integrates changes made to a plugin's default config into the user's config
+     * @param pluginName - Name of your plugin
+     * @param currentConfig - Config file currently loaded for this plugin
      * @returns the config
      */
-    aggregatePluginConfig(pluginName: string): Record<string, any>;
+    _aggregatePluginConfig(pluginName: string, currentConfig: any): Record<string, any>;
     /**
      * Writes your plugin config changes to the filesystem. The object data will be processed to JSON.
      * @param pluginName - Name of your plugin
@@ -1312,18 +1314,20 @@ declare class PluginSystem {
      * @returns Resolves with your plugin config processed from JSON to an object. If the config failed to load, the promise will be rejected with an error.
      */
     loadPluginConfig(pluginName: string): Promise<object>;
+    /**
+     * Internal: Integrates changes made to a plugin's default config into the user's config
+     * @param pluginName - Name of your plugin
+     * @param currentConfig - Config file currently loaded for this plugin
+     * @returns the config
+     */
+    _aggregatePluginConfig(pluginName: string, currentConfig: any): Record<string, any>;
     /**
      * Writes your plugin config changes to the filesystem. The object data will be processed to JSON.
      * @param pluginName - Name of your plugin
      * @param pluginConfig - Config object of your plugin
      * @returns Resolves on success, rejects otherwise with an error
      */
     writePluginConfig(pluginName: string, pluginConfig: any): Promise<void>;
-    /**
-     * Integrates changes made to the config to the users config
-     * @returns the config
-     */
-    aggregatePluginConfig(pluginName: string): Record<string, any>;
 }
 
 /**