Team Up Documentation

website·Indexed 31 days ago

https://documentation.team-up.xyz

Documentation for the Team Up Discord bot, featuring tools for creating and managing Looking For Group (LFG) party requests. Includes guides on /lfg quick, /lfg advanced, and /lfg template commands, as well as administration settings for whitelists, blacklists, and premium subscription features.

Tokens
6.9K
Snippets
27
Records
69
Agent score
47%

What's inside Team Up

  1. Troubleshoot /lfg overview command issues

    If the /lfg overview command is not working as expected, check the following:

    • Channel Scope: The command only lists requests created within the same channel. To prevent scattered requests, use /settings to set a default channel for parties.
    • Missing Requests: If a request is missing, it may have been completed, deleted, or removed by the server's automatic cleanup window.
    • Permissions: Ensure the bot has permissions to read message history and manage embeds in the channel; otherwise, it cannot generate the overview response.
  2. Manage channel-specific game restrictions with /channelconfig

    The /channelconfig command is a Premium feature used to configure a whitelist or blacklist for the specific channel where the command is executed. These lists restrict which games can be used with the /lfg and /gamble commands.

    Key behaviors:

    • Channel-specific rules override server-wide whitelist/blacklist settings.
    • Only one list type (whitelist OR blacklist) can be active at a time. Adding a game to a whitelist automatically clears any existing blacklist for that channel, and vice versa.
    • Clearing a list removes all channel-specific restrictions.

    Requirements:

    • Permission: Administrator
    • Scope: Server-only (Guilds)
    • Subscription: Active Premium subscription
  3. Create and manage party requests using LFG commands

    The LFG command set is the core functionality of Team Up for managing party requests. It provides four primary subcommands depending on the required level of detail and reusability:
    /lfg quick     # Fast one-shot flow to post a request in the current channel
    /lfg advanced  # Private configuration channel to stage a request before publishing
    /lfg template  # Create a reusable template with a 'Create party' button
    /lfg overview  # List all currently open requests with jump links and slot progress
  4. View server configuration using the info command

    The /info command allows Server Administrators to view the current server configuration. The output is delivered as an ephemeral Discord embed and contains details regarding language settings, premium status, LFG (Looking For Group) deletion intervals, channel restrictions, and game filtering (whitelist/blacklist).
  5. Get a summary of active LFG requests using /lfg overview

    The /lfg overview command provides a private (ephemeral) snapshot of all active Looking For Group requests created in the current channel via /lfg quick or /lfg advanced. This allows moderators or players to see remaining openings and jump to original posts without scrolling through message history.

    How to use:

    1. Navigate to the text channel containing the LFG posts.
    2. Execute /lfg overview.

    The resulting embed includes:

    • Requester name and selected game.
    • Configured party size and the number of remaining open spots.
    • A direct Discord message link to the original LFG post.

    Requests are sorted chronologically, with the oldest requests appearing at the top.

    /lfg overview
  6. Use the Help command to find bot functions

    The Help command provides a quick overview of the bot's most important functions, including a summary of key commands, available setting options, and general information such as links to the homepage.
  7. Refresh the LFG overview summary

    To update the list of active LFG requests without re-typing the command, click the Update button located at the bottom of the ephemeral response embed. This is useful for real-time triaging as players join parties.
  8. Manage server-wide game access with Whitelists and Blacklists

    The whitelist and blacklist systems allow you to permit or block specific games on the server. Note that these are mutually exclusive: you can use either a whitelist or a blacklist, but not both simultaneously. If you add games to a blacklist while a whitelist exists (or vice versa), the existing list will be automatically emptied. These settings apply server-wide, though per-channel configurations are available via /channelconfig.
  9. Manage server Premium status with the /premium command

    The /premium command is used to manage Premium subscriptions for a specific server. Premium provides exclusive features to subscribers and helps cover the project's operational costs.
  10. Manage server-wide game access with Whitelists and Blacklists

    The whitelist and blacklist systems allow administrators to permit or block specific games on a server. Note that these systems are mutually exclusive: you cannot use both a whitelist and a blacklist simultaneously. If a whitelist exists and a game is added to the blacklist (or vice versa), the existing list is automatically emptied. These settings apply server-wide, though separate configurations can be set per channel using /channelconfig.