update README

Author: sneak-it

README.md

@@ -3,47 +3,46 @@
 A Discord bot that monitors Counter-Strike: Global Offensive (and other supported) servers, provides real-time server status updates, and notifies users when specific maps appear on followed servers.
 
 ![Version](https://img.shields.io/badge/version-7.0.0-blue)
-![License](https://img.shields.io/badge/license-ISC-green)
 ![Node](https://img.shields.io/badge/node-%3E%3D20-blue)
 
 ## Features
 
+### Core Features
+
+- **Real-time Server Monitoring**: Automatically queries game servers at a configurable interval to update server status
+- **Embed Channel**: Automatically updates a channel message with rich embed of all configured servers and their status
+- **Map Notifications**: Receive DM alerts when followed maps appear on monitored servers
+- **Multi-Game Mode Support**: Supports Surf, KZ (kreedz climb), and Bhop map prefixes
+- **Slash Commands**: Modern Discord interaction using slash commands with autocomplete support
+- **Rate Limiting**: Built-in rate limiting to prevent abuse (configurable per command)
+- **IP Validation**: Secure IP address/FQDN validation with private IP blocking
+- **Automatic Cleanup**: Automatically removes user follows when they leave the server
+- **Caching System**: User and map image caching to reduce API calls
+- **Retry Logic**: Exponential backoff for failed server queries
+
 ### Public Commands
 
 | Command | Description |
 |---------|-------------|
-| `--players` / `--p` | Display currently connected players on a specified server |
-| `--map` / `--m` | Show the current map on a server or display map statistics |
-| `--keywords` / `--keys` | List all available server keywords for searching |
-| `--follow` / `--f` | Follow a map to receive DM notifications when it appears on a server |
-| `--unfollow` / `--uf` | Stop following a specific map or all maps |
-| `--listfollows` / `--lf` | Display all maps you are currently following |
-| `--help` / `--commands` | Show a list of all available commands |
-| `--ping` | Check bot latency (reacts with ping emoji) |
-| `--version` / `--v` | Display the bot version |
+| `/players` | Display currently connected players on a specified server |
+| `/map` | Show the current map on a server or display map statistics |
+| `/keywords` | List all available server keywords for searching |
+| `/follow` | Follow a map to receive DM notifications when it appears on a server |
+| `/unfollow` | Stop following a specific map or all maps |
+| `/listfollows` | Display all maps you are currently following |
+| `/help` | Show a list of all available commands |
+| `/ping` | Check bot latency |
+| `/version` | Display the bot version |
 
 ### Administrator Commands
 
 | Command | Description |
 |---------|-------------|
-| `--id` | Developer command |
-| `--mem` | Display current memory usage statistics |
-| `--check <IP>` | Check server status by IP address (with rate limiting) |
-| `--listallfollows` / `--laf` | List all users and their followed maps |
-| `--testnotify <map>` | Test map notification system |
-| `--removeuser <userID>` | Remove all map follows for a specific user |
-
-### Core Features
-
-- **Real-time Server Monitoring**: Automatically queries CS:GO servers every 90 seconds to update server status
-- **Map Notifications**: Receive DM alerts when followed maps appear on monitored servers
-- **Multi-Game Mode Support**: Supports surf, KZ (climb), bhop, and retakes game modes
-- **Rate Limiting**: Built-in rate limiting to prevent abuse (configurable per command)
-- **IP Validation**: Secure IP address validation with private IP blocking
-- **Automatic Cleanup**: Automatically removes user follows when they leave the server
-- **Graceful Shutdown**: Proper database connection cleanup on SIGINT/SIGTERM
-- **Caching System**: User and map image caching to reduce API calls
-- **Retry Logic**: Exponential backoff for failed server queries
+| `/check <server>` | Check server status by IP address (admin only) |
+| `/mem` | Display current memory usage statistics (admin only) |
+| `/listallfollows` | List all users and their followed maps (admin only) |
+| `/testnotify <map>` | Test map notification system (admin only) |
+| `/removeuser <userID>` | Remove all map follows for a specific user (admin only) |
 
 ## Configuration
 
@@ -75,98 +74,19 @@ A Discord bot that monitors Counter-Strike: Global Offensive (and other supporte
      cp config.json.example config.json
      ```
 
-   - Edit `config.json` with your settings (see [Configuration Options](#configuration-options) below)
+   - Edit `config.json` with your settings (see [Configuration Fields](#configuration-fields) below)
 
 4. **Run the bot**
 
    ```bash
    npm start
    ```
 
-### Configuration Options
-
-Create a `config.json` file based on `config.json.example`:
-
-```json
-{
-  "discord": {
-    "token": "YOUR_BOT_TOKEN_HERE",
-    "prefix": "!",
-    "intents": [
-      "Guilds",
-      "GuildMessages",
-      "GuildMessageReactions",
-      "DirectMessages",
-      "DirectMessageReactions"
-    ]
-  },
-  "security": {
-    "adminUserIds": ["YOUR_DISCORD_USER_ID_1", "YOUR_DISCORD_USER_ID_2"]
-  },
-  "logging": {
-    "enabled": true,
-    "guildID": "YOUR_LOG_GUILD_ID",
-    "channelID": "YOUR_LOG_CHANNEL_ID"
-  },
-  "fallback": {
-    "guildID": "YOUR_FALLBACK_GUILD_ID",
-    "channelID": "YOUR_FALLBACK_CHANNEL_ID"
-  },
-  "serverUpdate": {
-    "intervalSeconds": 90,
-    "mapCheckIntervalSeconds": 91,
-    "maxConcurrentQueries": 10
-  },
-  "follow": {
-    "timeoutSeconds": 30
-  },
-  "embeds": [
-    {
-      "channelID": "YOUR_EMBED_CHANNEL_ID",
-      "messageID": "YOUR_EMBED_MESSAGE_ID"
-    }
-  ],
-  "cache": {
-    "userCacheTTLSeconds": 300,
-    "mapImageCacheTTLSeconds": 86400
-  },
-  "retry": {
-    "maxRetries": 3,
-    "baseDelaySeconds": 1
-  },
-  "gamedig": {
-    "defaultMaxRetries": 4
-  },
-  "embedsConfig": {
-    "color": 7980240
-  },
-  "images": {
-    "fallbackAvatar": "https://i.imgur.com/cBiDnMi.png",
-    "offlineServer": "https://i.imgur.com/WnS0Biz.png"
-  },
-  "mapUrls": {
-    "surf": {
-      "stats": "https://snksrv.com/surfstats/",
-      "image": "https://bans.snksrv.com/images/maps/"
-    },
-    "kz": {
-      "stats": "https://snksrv.com/kzstats/#/maps/",
-      "image": "https://raw.githubusercontent.com/KZGlobalTeam/map-images/public/images/"
-    },
-    "bhop": {
-      "stats": "https://snksrv.com/bhopstats/index.php?map=",
-      "image": "https://bans.snksrv.com/images/maps/"
-    }
-  }
-}
-```
-
 ### Configuration Fields
 
 | Field | Type | Required | Default | Description |
 |-------|------|----------|---------|-------------|
 | `discord.token` | string | Yes | - | Your Discord bot token |
-| `discord.prefix` | string | Yes | `!` | Command prefix for the bot |
 | `discord.intents` | array | Yes | - | Discord gateway intents required for bot functionality |
 | `security.adminUserIds` | array | Yes | - | Discord user IDs with access to admin commands |
 | `logging.guildID` | string | Yes | - | Guild ID for logging bot activities |
@@ -189,19 +109,19 @@ The bot supports the following CS:GO game modes with automatic map detection:
 ### Surf Maps
 
 - **Prefix**: `surf_`
-- **Stats URL**: [snksrv.com/surfstats](https://snksrv.com/surfstats/)
+- **Default Stats URL**: [snksrv.com/surfstats](https://snksrv.com/surfstats/)
 - **Example**: `surf_beginner`
 
 ### KZ (Climb) Maps
 
 - **Prefixes**: `kz_`, `bkz_`, `kzpro_`, `skz_`, `vnl_`, `xc_`
-- **Stats URL**: [snksrv.com/kzstats](https://snksrv.com/kzstats/)
+- **Default Stats URL**: [snksrv.com/kzstats](https://snksrv.com/kzstats/)
 - **Example**: `kz_asylum`
 
 ### Bhop (Bunnyhop) Maps
 
 - **Prefix**: `bhop`
-- **Stats URL**: [snksrv.com/bhopstats](https://snksrv.com/bhopstats/)
+- **Default Stats URL**: [snksrv.com/bhopstats](https://snksrv.com/bhopstats/)
 - **Example**: `bhop_strix`
 
 ## Server Configuration
@@ -224,7 +144,7 @@ Add your CS:GO servers to `servers.json`:
 
 | Field | Type | Required | Description |
 |-------|------|----------|-------------|
-| `ip` | string | Yes | Server IP and port (e.g., `216.52.143.73:27015`) |
+| `ip` | string | Yes | Server IP and port (e.g., `127.0.0.1:27015`) |
 | `nick` | string | Yes | Display name shown in embeds |
 | `show` | boolean | Yes | Whether to display server in public commands |
 | `protocol` | string | No | Game protocol (default: `csgo`) - see list [here](https://github.com/gamedig/node-gamedig/blob/master/GAMES_LIST.md)|
@@ -245,6 +165,7 @@ Add your CS:GO servers to `servers.json`:
   - Add Reactions
   - Send Messages in Threads
   - Use External Emojis
+  - Use Application Commands
 
 - **Required Intents**:
   - Guilds
@@ -253,71 +174,6 @@ Add your CS:GO servers to `servers.json`:
   - DirectMessages
   - DirectMessageReactions
 
-## Architecture
-
-```mermaid
-flowchart TB
-    subgraph "Bot Initialization"
-        A[Load config.json] --> B[Initialize SQLite Database]
-        B --> C[Connect to Discord Gateway]
-        C --> D[Load Server List from servers.json]
-    end
-    
-    subgraph "Main Loop"
-        E[Server Status Monitor<br/>90s interval] --> F[Query Servers via GameDig]
-        F --> G[Update Embeds in Discord]
-        G --> H[Map Change Detector<br/>91s interval]
-        H --> I[Notify Followed Users]
-    end
-    
-    subgraph "User Commands"
-        J[Message Event] --> K{Command Type}
-        K -->|Public| L[handlePublicCommand]
-        K -->|Admin| M[handleDevCommand]
-        L --> N[Player/Map/Help Commands]
-        M --> O[Admin Tools]
-    end
-    
-    subgraph "Data Persistence"
-        P[SQLite Database<br/>players_follow table]
-        Q[User Follows]
-        R[Map Statistics]
-    end
-    
-    D --> E
-    E --> H
-    H --> I
-    J --> K
-    P --> Q
-    P --> R
-```
-
-## Rate Limiting
-
-The bot implements rate limiting to prevent abuse:
-
-| Command | Limit | Window |
-|---------|-------|--------|
-| `--follow` | 5 actions | per minute |
-| `--unfollow` | 5 actions | per minute |
-| `--check` (IP) | 10 actions | per minute |
-
-## Security Features
-
-- **IP Validation**: Validates IPv4 and IPv6 addresses before querying
-- **Private IP Blocking**: Prevents scanning of internal network addresses
-- **SQL Injection Prevention**: Parameterized queries for all database operations
-- **Map Name Sanitization**: Validates and sanitizes map name inputs
-- **Mention Prevention**: Blocks user/role mentions in map names
-- **Admin-Only Commands**: Restricted admin commands via user ID whitelist
-
-## Error Handling
-
-- **Retry Logic**: Exponential backoff for failed server queries and Discord API calls
-- **Graceful Degradation**: Continues operation even if individual servers fail to respond
-- **Fallback Notifications**: Sends notifications to fallback channel if DM fails
-- **Memory Management**: Automatic cache cleanup and database connection handling
-
 ## Troubleshooting
 
 ### Bot won't start
@@ -328,44 +184,30 @@ First and foremost, **review all logs**.
 - Check that `config.json` exists and is valid JSON
 - Ensure all required configuration fields are present
 
-### Commands not working
+### Commands not appearing
 
-- Verify the command prefix matches your configuration
-- Check that the bot has proper channel permissions
-- Ensure your user ID is in the `adminUserIds` list for admin commands
+- The bot uses slash commands - type `/` in any channel the bot has access to
+- The bot must be invited to your server with proper permissions
+- Slash commands may take a few minutes to propagate after the bot starts
+- Try using `/help` to see available commands
 
 ### Map notifications not working
 
 - Verify `follow.timeoutSeconds` is set appropriately
 - Check that the bot can send DMs to users
 - Ensure map names match the expected format (alphanumeric, underscores, hyphens)
+- Make sure you have `/follow` set for the maps you want notifications for
 
 ### Server status not updating
 
 - Check server IP and port in `servers.json`
 - Verify the server is accessible from your network
 - Review logs for GameDig query errors
 
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Test thoroughly
-5. Submit a pull request
-
-## License
-
-This project is licensed under the ISC License.
-
 ## Author
 
 **Frumpy7**
 
 ## Support
 
 For issues and feature requests, please visit the [GitHub Issues](https://github.com/Sneaks-Community/discordCSGOServerBot/issues) page.
-
----
-
-*Last Updated: 2026-03-07*