Synqy Bot User Guide - How to Use Synqy

Getting Started with Synqy

Welcome to Synqy, your Discord bot for seamless product purchases, queue management, and community fun! Follow these steps to get started:

Interact with Synqy: You can interact with Synqy using slash commands (e.g., `/buy`, `/tabs`) or by mentioning it with `@Synqy` in text channels to trigger responses or commands. Ensure Synqy has the necessary permissions (View Channels, Send Messages) to respond.
Configure Currency: By default, Synqy uses USD (U.S. dollars, symbol: $) for all pricing and shipping. Server admins must set a different currency if needed using the `/set-product-currency` command (e.g., `/set-product-currency EUR` for Euros, symbol: €).
Configure Shipping Rates: Server admins can set shipping rates using `/set-shipping-rates`.
Load Products: Make sure to add your products to the bot by using the `/load-products` command (command details in the Admin-Only Commands section).
Start Using Commands: Check out the commands below to buy products, manage tabs, and view queues.

Common User Commands

These commands are available to all users in servers where Synqy is invited:

/buy - Add items to your tab by selecting a product via autocomplete.

Example: Type `/buy` and select a product UUID to buy it, then confirm the quantity in the interactive menu. The price will display with the server’s set currency symbol (e.g., “$60.00” for USD or “€60.00” for EUR).

/tabs [all] - View your current tab (purchase total) or all tabs in the server.

Parameter:

all (true/false, optional): Set to `true` to view all tabs in the server (admin-only); defaults to `false` to show only your individual tab. Requires Administrator permission for `true`.

Examples:

`/tabs` - Shows your individual tab: “Your tab is $60.00.” (or the server’s currency symbol, e.g., “€60.00” for EUR).
`/tabs true` - Shows all tabs in the server (admin-only): “Tabs in this server: @User1 ($60.00), @User2 (£30.00).” (or the server’s currency symbols).

/list-products - List all available products and their prices.

Output: Shows products like “- `Product Name`: $60.00” (or the server’s currency symbol, e.g., “- `Product Name`: €60.00” for EUR).

/search-product - Search for products by name or part of the name.

Example: `/search-product mtg` lists Magic: The Gathering products with prices in the server’s currency (e.g., “`mtg_2x2_jpcb`: $60.00” or “`mtg_2x2_jpcb`: €60.00”).

/queue - View the current buy queue (admin-only, but useful for users to know).

Output: Displays queued purchases, e.g., “- @User purchased 1x `Product Name` ($60.00, ID: ).” (or the server’s currency symbol, e.g., “€60.00” for EUR).

/leaderboard - View the leaderboard for the top spenders.

Output: Displays top spenders, e.g., “- @User1: $60.00” (or the server’s currency symbol, e.g., “- @User1: €60.00” for EUR).

Admin-Only Commands

Server administrators can use these commands to manage Synqy:

/load-products - Load product data from a CSV file with columns 'Product' and 'Price' (requires Administrator).

Example: Upload a CSV with the following format to add products:

Product,Price mtg_2x2_jpcb,60.00 mtg_blb_jp,22.00 poke_prismatic_etb,100.00

Notes: Save your CSV file (e.g., `products.csv`) and upload it using the Discord attachment feature with this command. Prices in the CSV are assumed in the server’s set currency (default $ for USD unless changed).

/add-product - Add a product to the product list (requires Administrator).

Parameters:

name: The name of the product.
price: The price of the product (e.g., $24.99, €24.99, £24.99, or 24.99).

Example: `/add-product "Magic Card" 24.99` or `/add-product "Magic Card" $24.99` adds a product named “Magic Card” with a price of $24.99 (or the server’s currency).

/remove-product - Remove a product by name (requires Administrator).

Example: `/remove-product mtg_2x2_jpcb` removes that product. The price will display with the server’s currency symbol (e.g., “$60.00” for USD or “€60.00” for EUR).

/clear-products - Remove all products from your guild (requires Administrator).

Example: `/clear-products` removes the products.

/remove-from-queue - Remove an item from the queue by ID (requires Administrator).

Example: `/remove-from-queue 1` removes item ID 1, adjusting the user’s tab. The price adjustment will display with the server’s currency symbol (e.g., “$60.00” for USD or “€60.00” for EUR).

/move-in-queue - Move an item to a new position in the queue (requires Administrator).

Example: `/move-in-queue 1 2` moves item 1 to position 2. The price will display with the server’s currency symbol (e.g., “$60.00” for USD or “€60.00” for EUR).

/process-queue - Process the next item in the buy queue (requires Administrator).

Output: Notifies the user and moves to the next in queue, e.g., “Processed queue item for User! 1x `Product Name` ($60.00).” (or the server’s currency symbol, e.g., “€60.00” for EUR).

/set-shipping-rates - Set shipping limits and costs for the server (requires Administrator).

Example: `/set-shipping-rates 50 5` sets a $50 limit and $5 cost (or the server’s currency symbols, e.g., “€50.00” and “€5.00” for EUR).

/set-product-currency - Set the currency for product pricing in this server (requires Administrator).

Parameter:

currency (e.g., USD, EUR, GBP, JPY, CAD): The ISO 4217 currency code to use for prices and shipping (e.g., “USD” for U.S. dollars, symbol: $, “EUR” for Euros, symbol: €). Use the autocomplete feature to select from supported currencies (e.g., USD, EUR, GBP, JPY, CAD).

Example: Type `/set-product-currency` and select “EUR” from the autocomplete dropdown to set the currency to Euros (symbol: €) for this server.

Notes: Valid currencies are suggested via autocomplete (e.g., USD, EUR, GBP, JPY, CAD; expand as needed). Prices will display with the selected currency’s symbol (e.g., “€60.00” instead of “$60.00 USD”). The default currency is USD (symbol: $).

/start-givvy - Start a giveaway in the current voice channel (requires Administrator and voice channel presence).

Notes: This is an admin-only command. You must be in a voice channel to use this command. Initiates a giveaway timer, notifying users and selecting a random winner after the timer expires.

/adjust-tab - Adjust a user’s tab balance by a specified amount (requires Administrator).

Parameters:

user_id: The Discord ID of the user whose tab to adjust.
amount: The amount to adjust (positive or negative), displayed with the server’s currency symbol (e.g., $10.00 or €10.00).

Example: `/adjust-tab 123456789012345678 10` increases User ID 123456789012345678’s tab by $10.00 (or the server’s currency, e.g., €10.00).

/clear-tabs - Clear all tabs for this guild (requires Administrator).

Notes: Removes all tab data for the server, resetting balances to zero.

/pay-tab - Mark a user’s tab as PAID (requires Administrator).

Parameter:

user_id: The Discord ID of the user whose tab to mark as paid.

Example: `/pay-tab 123456789012345678` marks User ID 123456789012345678’s tab as paid, removing their balance. The tab balance will display with the server’s currency symbol (e.g., $60.00 or €60.00).

Support and Resources

Need help? Here’s how to get support:

Contact Us: Email us at synqysell@gmail.com.
Terms of Service: Review our Terms of Service.
Privacy Policy: Check our Privacy Policy.