DOCSEARCHbyAlgolia
Submit Docs

Atlas Documentation

website·Indexed 31 days ago

https://atlas-bcg.pages.dev/

Documentation for Atlas, a Discord automation and management tool. Includes guides on creating custom actions with triggers (such as slash commands, keywords, and intervals), writing scripts using tags like {user}, {channel}, and {responder}, and configuring plugins for moderation, levels, starboards, and logging.

Tokens
28.6K
Snippets
169
Records
279
Agent score
75%

What's inside Atlas

  1. Understand and use Context in Atlas

    Context represents the information Atlas possesses about the event it is currently handling. It allows commands, plugins, actions, restrictions, and scripts to access details about the current server, member, channel, message, or event.

    Context is primarily used to determine default values for tags. For example, if a tag like {user.name} is used without a specified value, Atlas uses the user currently in context. If a tag parameter is listed as having a context Channel default, it can be omitted if the current trigger provides a channel.

    Context varies by trigger:

    • Message Create: Provides message, user, and channel context.
    • Slash Command: Provides the user who ran the command, the channel, and command options.
    • Feed Delivery: Provides {$feed} and {$feedItem} context.
    • Interval Action: Has no message context because it runs on a schedule.
    • Webhook Action: Provides request data instead of standard message context.

    When an action lacks a specific piece of context (e.g., an interval action lacking a message), you must provide the required value (channel, user, etc.) directly to the tag.

  2. Manage community ideas with the Suggestions plugin

    The Suggestions plugin allows members to submit ideas that staff can review, approve, deny, and track. It supports a workflow where suggestions are sent to a dedicated review channel for staff approval before being published to a community channel for voting. The plugin is available with an Atlas Prime subscription.

  3. Monitor RSS and Atom feeds with the Feeds plugin

    The Feeds plugin (available with Atlas Prime) watches RSS and Atom feeds and runs a specified script whenever a new item is found. It can be used to track blogs, release feeds, news sites, changelogs, and podcasts. When a new feed is added, Atlas validates the URL and shows the latest items; however, existing items are skipped, and only new items trigger the script. Atlas supports standard RSS/Atom feeds and will attempt to discover feeds if a regular webpage URL is provided. Feeds are typically checked every 5 minutes unless the feed itself specifies a different interval.

  4. Use parameters in Context Menu triggers

    Context Menu triggers support several parameters to access information about the invocation and the target.

    General Parameters:

    • {channel}: The channel where the command was invoked.
    • {user}: The user who invoked the command.
    • {$targetType}: The type of target (based on Discord application command types).

    Message Context Menu Parameters:

    • {message}: The message the action was used on.
    • {$targetId}: The ID of the message.

    User Context Menu Parameters:

    • {$targetId}: The ID of the user the action was used on.

  5. Choose the right Atlas feature based on your goal

    Depending on your objective, use the following Atlas entry points:

    • Built-in features: Browse plugin guides to find pre-made functionality and customizable scripts.
    • Custom commands/automations: Create a new 'Action'.
    • Server branding: Configure the 'Appearance' settings.
    • Advanced development: If you are already a coder, use the Developer Quick Start.
    • Terminology: Review the 'Concepts' pages to understand Atlas-specific vocabulary.

  6. Get a role's ID, name, or position

    Use these tags to retrieve basic metadata about a specific role:

    • {role.id;role}: Returns the unique ID of the role.
    • {role.name;role}: Returns the display name of the role.
    • {role.position;role}: Returns the position of the role in the role hierarchy.

  7. Atlas Prime subscription features and benefits

    Atlas Prime is a paid subscription that provides servers with access to premium features, including feeds, suggestions, guild appearances, higher action limits, and more powerful script tags. Specific limits regarding actions, plugins, storage, and tags vary by subscription tier.

  8. Understand the difference between Atlas Actions and Scripts

    In Atlas, Actions and Scripts serve distinct roles in automating responses:

    • Actions define the when: They are the triggers that tell Atlas when to execute a task (e.g., a user executing a Slash Command).
    • Scripts define the what: They are the reusable logic and templates that determine the actual output or behavior once an action is triggered.

    Execution Flow: Member triggers action (e.g., /hello) $\rightarrow$ Action provides context $\rightarrow$ Script executes logic $\rightarrow$ Atlas delivers the response.

    Scripts are reusable and can be used in various places, including Actions and plugin settings (like level-up messages or feed templates). The available tags/variables within a script change based on the context (e.g., a message action provides {message}, while a feed script provides {$feedItem}).

    {responder.text;Hello {user.name}!}

  9. Use the Atlas Log plugin to track server events

    The Log plugin allows you to send selected server events (such as moderation activity, message changes, and voice activity) to one or more designated log channels.

    Key operational details:

    • Multiple Streams: You can create several log streams, each with its own destination channel and set of selected events. If an event is selected in multiple streams, a log entry is sent to each.
    • Log Restrictions: Use restrictions to exclude specific channels or roles (e.g., a staff category) to prevent noise in the logs. Note that restrictions only prevent events from being logged; they do not manage Discord channel visibility.
    • Permissions: The destination channel must be kept private using standard Discord channel permissions, and the Atlas bot must have access to the destination channel to post logs.

  10. Understand and use Atlas Plugins

    Plugins are ready-made features in Atlas that provide specific commands and server behaviors. Once enabled in the dashboard and configured, they automate tasks such as role assignment or ticket management. For example, the Roles plugin allows members to acquire roles via buttons, menus, or reactions, while the Tickets plugin manages private staff-member communication channels. Some plugins allow for further customization of messages using scripts, while more complex, tailored behavior can be achieved by recreating plugin functionality using custom actions.

  11. Understand Atlas Action fundamentals

    Actions are custom automations consisting of two primary components: a trigger and a script. The trigger determines when the action is executed, and the script defines the resulting behavior. Actions can be triggered by various events including slash commands, messages, reactions, schedules, webhooks, and buttons. Triggers automatically provide context to the script, allowing it to access objects like {message}, {user}, and {channel} without manual lookup.

  12. Understand core Atlas concepts for Actions and Scripts

    Atlas uses a system of event handlers and templates to automate responses. Key concepts include:

    • Actions: Event handlers that trigger scripts based on specific criteria.
    • Scripts: Templates (or action bodies) that execute when an action is triggered. They support variables, loops, arrays, and conditions.
    • Tags: Functions or value lookups used within scripts (e.g., {user.name}).
    • Variables: Values scoped to a script, accessed using the $ prefix when read.
    • Plugins: Packaged features containing settings and built-in commands.
    • Restrictions: Allow/deny rules evaluated before a feature executes.