AuthGuard

AuthGuard Bot (Panel) Usage

General Notes for Panel Commands:

  • Many panel commands require prior setup using /login and /setup.

  • Administrative panel commands (like /whitelist, /settings-set-admin-role, /addadmin) are typically restricted to server owners or roles designated as administrators via the bot's settings.

  • When commands require user input (e.g., a key, a user to whitelist), the bot will usually prompt for this or expect it as a command option.

  • Get it here >> Install <<


🖥️ Panel Commands

🔑 /login

Logs you in with your API key, saving it for use in subsequent panel commands. This is often the first step required before using other panel features.

  • Description: Authenticates your session with the Panda Development API.

  • Details & Usage:

    • You will be prompted to provide your API key securely.

    • This API key is then associated with your Discord user ID for future commands in the current server, so you don't have to enter it repeatedly.


🛠️ /setup

Configures the script panel for your server. This command sets up the necessary details for distributing and managing your script.

  • Description: Initializes the script panel with essential information.

  • Required Parameters:

    • Script Name: The display name for your script.

    • Script: The actual script content or a link/ID to the script.

    • Buyer Role: The Discord role to be assigned to users who successfully redeem a key for this script.

  • Details & Usage:

    • Requires /login to have been completed successfully. The API key from /login will be used.

    • This command only needs to be run once to set up the panel for a particular script.


📜 /script

Allows users (typically those with the buyer role) to retrieve the script.

  • Description: Fetches and provides the script configured via /setup.

  • Details & Usage:

    • The script panel must be fully configured using /setup for this command to work.

    • Users typically need the designated "Buyer Role" to access this command, or it might be available to all if configured that way.


/redeem

Allows users to redeem a premium license key for the script.

  • Description: Validates a provided key and, if successful, grants access and assigns the buyer role.

  • Details & Usage:

    • The user will be prompted to enter their license key.

    • If the key is valid for the configured script:

      • The key is marked as redeemed.

      • The user is assigned the "Buyer Role" (specified during /setup).

    • This command is typically available to all server members.


🎭 /getrole

Allows a user to re-obtain the buyer role if they have a valid, previously redeemed key associated with their ID but have lost the role for some reason.

  • Description: Re-assigns the buyer role based on existing valid key data.

  • Details & Usage:

    • The user must have previously redeemed a key successfully using /redeem.

    • The bot checks if the user's ID has a valid, active key linked to it.

    • If found, the "Buyer Role" is re-assigned.

    • Useful if roles were accidentally removed or if the user rejoined the server.


/whitelist

An administrative command to manually whitelist a user. This typically involves generating a key for them, sending it, and assigning the buyer role.

  • Description: Manually grants a user access to the script.

  • Parameters:

    • User: The Discord user to whitelist.

  • Details & Usage:

    • This command is typically restricted to server administrators or roles with specific permissions (see /settings-set-admin-role).

    • The bot will usually:

      1. Generate a new license key.

      2. Associate this key with the specified user.

      3. Send the key to the user (often via DM).

      4. Assign the "Buyer Role" to the user.


⚙️ /settings-set-admin-role

Configures a specific Discord role as an administrator role for the bot's panel commands.

  • Description: Designates a role that can use administrative panel commands.

  • Parameters:

    • Role: The Discord role to designate as an admin role.

  • Details & Usage:

    • This command is typically restricted to the server owner or high-level administrators.

    • Users with the role set by this command will gain permission to use commands like /whitelist.

    • ⚠️ Caution: Grant this permission carefully, as it allows management of script access.


📊 /settings view-info

Displays basic information about the current server's panel configuration.

  • Description: Shows a summary of the script panel setup.

  • Details & Usage:

    • Useful for administrators to quickly check current settings like script name, buyer role, etc.

    • This is likely a subcommand, invoked as /settings view-info.


ℹ️ /info

Displays information about a specific user, including their redeemed key status and other relevant panel-related data.

  • Description: Retrieves and shows user-specific panel information.

  • Parameters:

    • User (Optional): The Discord user to look up. If not provided, it might default to the user invoking the command.

  • Details & Usage:

    • Administrators can use this to check the status of a user's key, redemption date, etc.


👑 /addadmin

Adds an individual Discord user as a server admin for the bot's panel, independent of roles.

  • Description: Grants panel administrative privileges to a specific user.

  • Parameters:

    • User: The Discord user to grant admin privileges.

  • Details & Usage:

    • This command is typically restricted to the server owner or high-level administrators.

    • Differs from /settings-set-admin-role as it applies to an individual user rather than everyone with a particular role.

    • Useful for granting admin access to specific individuals without creating/assigning a dedicated role.


Last updated