### Modr8 Getting Started Source: https://docs.modr8.net/getting-started/team-access A guide to getting started with Modr8, covering initial setup steps like registering a bot and adding your chat. ```APIDOC Getting Started: - A comprehensive guide to setting up and configuring Modr8 for your community. - Covers essential steps from bot registration to initial configuration. - Recommended settings and best practices are included. ``` -------------------------------- ### Modr8 Getting Started: Register Bot, Add Chat, Recommended Settings Source: https://docs.modr8.net/getting-started/recommended-settings Guides users through the initial setup process for Modr8, including registering a bot, adding a chat, and configuring recommended settings for optimal performance. ```APIDOC Getting Started: Register A Bot: - Steps to register a new bot with the Modr8 platform. - Involves providing bot details and obtaining necessary credentials. Add Your Chat: - Instructions for connecting your chat platform (e.g., Discord, Telegram) to Modr8. - Requires authorization and configuration of the connection. Recommended Settings: - Provides optimal configurations for various Modr8 features. - Covers settings for spam prevention, welcome messages, user filters, and more. - Aims to help users set up a secure and efficient community environment. ``` -------------------------------- ### Modr8 Actions Quick Start Source: https://docs.modr8.net/getting-started/team-access A quick start guide for using Modr8 Actions, which allow for automated responses and tasks within your community. This covers the basic setup and usage of actions. ```APIDOC Actions Quick Start: - Learn the basics of creating and using automated actions in Modr8. - Set up triggers and define actions to be performed. - Examples of common use cases are provided. ``` -------------------------------- ### Modr8 Actions: Quick Start Source: https://docs.modr8.net/features/advanced-features A quick start guide to using Modr8 Actions, which allow for automated responses and tasks within your community. This covers the basic setup and usage of actions. ```APIDOC Actions - Quick Start: - Define automated responses or tasks within your community. - Actions can be triggered by specific events or commands. - Basic structure involves defining a trigger and an action. - Example: - Trigger: User joins the server. - Action: Send a welcome message. ``` -------------------------------- ### Modr8 Actions: Quick Start Source: https://docs.modr8.net/features/media-and-text-filters A quick start guide for using Modr8 Actions, which allow for automated responses and tasks within your community. This section covers the basic setup and usage of actions. ```APIDOC Actions - Quick Start: - Introduces the concept of Modr8 Actions for automating tasks. - Provides a basic guide to setting up and using actions. - May include examples of simple action configurations. ``` -------------------------------- ### Modr8 Actions: Quick Start and Conditions Source: https://docs.modr8.net/features/user-management Guides for setting up and managing actions within Modr8. This includes a quick start for creating actions and details on defining conditions that trigger these actions. ```APIDOC Modr8 Actions: Quick Start: - Guides users through the initial steps of creating and implementing custom actions. - Covers basic action setup and configuration. Conditions: - Details the logic and criteria that can be used to trigger actions. - Explains how to define conditional statements for automated responses or tasks. ``` -------------------------------- ### Modr8 Actions: Quick Start Source: https://docs.modr8.net/features/community-reputation A quick start guide to using Modr8 Actions, which allow for automated responses and moderation based on predefined conditions. This section covers the basic setup and usage of actions. ```APIDOC Actions - Quick Start: - Define automated responses or moderation tasks. - Set up triggers and conditions for actions. - Examples include welcoming new users, filtering messages, or applying moderation rules. ``` -------------------------------- ### Modr8 Actions: Quick Start Source: https://docs.modr8.net/features/actions/using-the-marketplace This guide provides a quick start for using Modr8 Actions, a feature that allows for automated responses and tasks within a community. It likely covers the basic steps to create and implement simple actions. ```APIDOC Actions - Quick Start: - Introduces the Modr8 Actions feature. - Guides users through the initial steps of creating and deploying actions. - Focuses on simple, common use cases for automation. ``` -------------------------------- ### Modr8 Actions: Quick Start and Management Source: https://docs.modr8.net/features/announcements Guides on how to use and manage actions within Modr8, including quick start, conditions, action groups, and marketplace usage. ```APIDOC Modr8 Actions: - Quick Start: https://docs.modr8.net/features/actions/quick-start - Conditions: https://docs.modr8.net/features/actions/conditions - Action Groups: https://docs.modr8.net/features/actions/action-groups - Managing, Importing & Exporting Actions: https://docs.modr8.net/features/actions/managing-importing-and-exporting-actions - Using The Marketplace: https://docs.modr8.net/features/actions/using-the-marketplace - Bot Actions vs. Chat Actions: https://docs.modr8.net/features/actions/bot-actions-vs.-chat-actions ``` -------------------------------- ### Modr8 Getting Started: Registering a Bot and Adding a Chat Source: https://docs.modr8.net/getting-started/add-your-chat This documentation provides essential steps for new users to get started with Modr8. It includes instructions on registering a bot, adding a chat to the platform, recommended settings, and managing bot/chat configurations. ```APIDOC Getting Started with Modr8: - Register A Bot: Step-by-step guide to registering a new bot with Modr8. - Add Your Chat: Instructions on how to integrate your chat platform with Modr8. - Quick Instructions: Concise steps for chat activation. - Full Guide To Chat Activation: Comprehensive activation process. - Adding Your Bot As An Administrator: Details on granting necessary permissions. - Activating / Registering Your Chat: Covers the registration flow. - FAQ & Troubleshooting: Common issues and solutions related to chat activation. - Recommended Settings: Best practices for configuring your bot and chat. - Managing Your Bot & Chat: How to manage existing bot and chat configurations. - Team Access: Information on setting up team access for collaborative management. ``` -------------------------------- ### Modr8 Actions: Quick Start and Management Source: https://docs.modr8.net/features/analytics Guides on how to use and manage actions within Modr8, including quick start, conditions, action groups, and marketplace usage. ```APIDOC Modr8 Actions: - Quick Start: https://docs.modr8.net/features/actions/quick-start - Conditions: https://docs.modr8.net/features/actions/conditions - Action Groups: https://docs.modr8.net/features/actions/action-groups - Managing, Importing & Exporting Actions: https://docs.modr8.net/features/actions/managing-importing-and-exporting-actions - Using The Marketplace: https://docs.modr8.net/features/actions/using-the-marketplace - Bot Actions vs. Chat Actions: https://docs.modr8.net/features/actions/bot-actions-vs.-chat-actions ``` -------------------------------- ### Modr8 Getting Started: Register A Bot Source: https://docs.modr8.net/features/community-reputation A step-by-step guide on how to register a new bot with Modr8, including the necessary information and procedures to get a bot operational. ```APIDOC Getting Started - Register A Bot: - Create a new bot application within Modr8. - Provide necessary details such as bot name, description, and icon. - Obtain API keys and tokens for bot authentication. - Follow the platform's guidelines for bot registration. ``` -------------------------------- ### Modr8 Actions: Quick Start, Conditions, and Management Source: https://docs.modr8.net/features/welcome-message-and-human-check Covers the fundamentals of Modr8 Actions, including how to get started, define conditions for actions, and manage them. It also touches upon action groups, importing/exporting, and using the marketplace. ```APIDOC Actions Overview: - Quick Start: Guides users through the initial setup of actions. - Conditions: Defines the criteria that trigger an action (e.g., user joins, message content). - Action Groups: Allows organizing multiple actions into logical groups. - Managing, Importing & Exporting Actions: Provides tools for managing custom actions and sharing them. - Using The Marketplace: Accessing pre-built actions from the Modr8 marketplace. - Bot Actions vs. Chat Actions: Differentiates between actions executed by the bot and those initiated within the chat. ``` -------------------------------- ### Modr8 Getting Started: Register A Bot Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Guides users through the process of registering a bot with the Modr8 platform. This is a crucial first step for integrating a bot into chats. ```APIDOC Getting Started: Register A Bot: - Provides step-by-step instructions for registering a new bot. - Details the information required during the registration process (e.g., bot name, API keys). - Explains how to obtain necessary credentials for bot integration. - Covers initial setup and configuration for a new bot. ``` -------------------------------- ### Get Started as an Affiliate Source: https://docs.modr8.net/popular-questions/affiliates-and-partnerships Follow these steps to become an affiliate for ModR8 and start earning commissions. This process involves signing up on the LemonSqueezy platform, completing a review, and setting up payout methods. ```text 1. Go to https://modr8.lemonsqueezy.com/affiliates 2. Select "Become an affiliate" 3. Complete the short sign-up form and submit your details 4. LemonSqueezy will review your details to ensure you are not spamming us with AI or Bot traffic 5. Within 48 hours your application will be reviewed and if accepted you will receive an e-mail with your unique referral link/code. 6. Re-visit LemonSqueezy to add your preferred pay-out channel such as Bank or PayPal. 7. Provide this link to any clients/customers and our website will track they have visited using your referral 8. Upon completing checkout and making a payment your dashboard will update on the LemonSqueezy website 9. Receive your payout once reaching the $10 limit and 30 days have passed. ``` -------------------------------- ### Modr8 Actions: Quick Start Source: https://docs.modr8.net/features/community-referrals A guide to quickly setting up and using Modr8 Actions, which allow for automated responses and tasks within a community. This covers the initial steps to define and deploy actions. ```APIDOC Actions - Quick Start: - Define automated tasks or responses within Modr8. - Steps: 1. Create a new Action. 2. Define triggers (e.g., new message, user join). 3. Specify actions to perform (e.g., send message, mute user). 4. Configure conditions for the action to run. 5. Save and enable the Action. ``` -------------------------------- ### Modr8 Getting Started: Recommended Settings Source: https://docs.modr8.net/features/community-reputation Provides recommended settings and configurations for Modr8 to optimize performance, security, and community management based on best practices. ```APIDOC Getting Started - Recommended Settings: - Configure essential moderation settings. - Set up welcome messages and verification. - Optimize performance and resource usage. - Implement security best practices for your bot and community. ``` -------------------------------- ### Modr8 Actions: Quick Start and Management Source: https://docs.modr8.net/getting-started/add-your-chat This documentation covers the 'Actions' feature in Modr8, including a quick start guide, understanding conditions, managing action groups, and importing/exporting actions. It also touches upon using the marketplace and the difference between bot and chat actions. ```APIDOC Modr8 Actions: - Quick Start: Guides users through the initial setup and usage of actions. - Conditions: Explains how to define conditions for triggering actions. - Action Groups: Details how to group multiple actions together for complex workflows. - Managing, Importing & Exporting Actions: Covers the lifecycle management of custom actions. - Using The Marketplace: Information on leveraging the Modr8 Actions Marketplace. - Bot Actions vs. Chat Actions: Differentiates between actions executed by the bot and those initiated within the chat. ``` -------------------------------- ### Modr8 Getting Started: Recommended Settings Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Offers guidance on recommended settings for new users of Modr8. This section helps users configure their bots and chats for optimal performance and moderation. ```APIDOC Getting Started: Recommended Settings: - Suggests optimal configurations for various Modr8 features. - Provides best practices for moderation, engagement, and bot behavior. - Helps users set up essential features like welcome messages, filters, and commands. - Aims to ensure a smooth and effective initial setup. ``` -------------------------------- ### Modr8 Getting Started: Register A Bot Source: https://docs.modr8.net/features/media-and-text-filters A guide on how to register a bot with Modr8, the initial step for integrating your bot with the platform's services. ```APIDOC Getting Started - Register A Bot: - Provides step-by-step instructions for registering a new bot with the Modr8 platform. - Covers the necessary information and prerequisites for bot registration. - The first step in connecting your bot to Modr8's features. ``` -------------------------------- ### Modr8 Actions: Quick Start and Management Source: https://docs.modr8.net/features/announcements/social-announcements Guides on how to use Modr8 Actions, including a quick start, understanding conditions, managing action groups, and importing/exporting actions. It also covers using the marketplace and the difference between bot and chat actions. ```APIDOC Modr8 Actions: - Quick Start: Get started with creating and using actions. - Conditions: Define triggers and criteria for actions. - Action Groups: Organize and manage multiple actions. - Management: Import, export, and manage your custom actions. - Marketplace: Utilize pre-built actions from the marketplace. - Bot Actions vs. Chat Actions: Understand the scope and application of different action types. ``` -------------------------------- ### Modr8 Getting Started: Recommended Settings Source: https://docs.modr8.net/features/media-and-text-filters Provides recommended configuration settings for Modr8 to optimize performance, security, and moderation effectiveness. ```APIDOC Getting Started - Recommended Settings: - Offers suggestions for optimal configuration of Modr8 features. - Covers settings related to moderation, security, and bot behavior. - Helps users set up Modr8 efficiently for best results. ``` -------------------------------- ### Modr8 Actions: Quick Start & Conditions Source: https://docs.modr8.net/features/announcements/global-bot-announcements This section provides a quick start guide to Modr8 Actions and explains the conditions that can be used to trigger them. It's essential for automating tasks and responses within Modr8. ```APIDOC Actions - Quick Start & Conditions: - Quick start guide for implementing Modr8 Actions. - Explanation of conditions that can be used to trigger actions. - Details on creating and managing action groups. ``` -------------------------------- ### Modr8 Actions: Quick Start, Conditions, and Management Source: https://docs.modr8.net/introduction/global-and-multi-chat-features This covers the core aspects of Modr8 Actions, including how to get started, define conditions for actions, and manage them. It also touches upon action groups, importing/exporting, and using the marketplace. ```APIDOC Modr8 Actions: Quick Start: - Guides users through the initial setup and usage of actions. - Covers basic action creation and deployment. Conditions: - Defines the criteria that trigger an action. - Supports various conditions based on user behavior, messages, and events. Action Groups: - Allows for the organization and management of multiple actions. - Facilitates the creation of complex automated workflows. Managing, Importing & Exporting Actions: - Provides tools for editing, backing up, and sharing action configurations. - Supports importing actions from external sources and exporting existing ones. Using The Marketplace: - Access to a library of pre-built actions created by the Modr8 community. - Enables users to discover and implement new functionalities easily. Bot Actions vs. Chat Actions: - Differentiates between actions executed by the bot and those executed within a specific chat. ``` -------------------------------- ### Modr8 Actions: Quick Start and Management Source: https://docs.modr8.net/features/timeline-and-event-log Guides on using and managing Modr8's 'Actions' feature, which allows for automated responses and moderation based on predefined conditions. Covers quick start, conditions, action groups, and marketplace usage. ```APIDOC Modr8 Actions: - Quick Start: Basic steps to create and implement actions. - Conditions: Define triggers and criteria for actions (e.g., user behavior, message content). - Action Groups: Organize multiple actions for complex workflows. - Managing, Importing & Exporting Actions: Tools for managing your action library. - Using The Marketplace: Access pre-built actions from the Modr8 marketplace. - Bot Actions vs. Chat Actions: Differentiate between bot-level and chat-specific actions. ``` -------------------------------- ### Modr8 Getting Started: Managing Your Bot & Chat - Managing Your Bot Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Specific guidance on managing the bot component within Modr8. This focuses on bot-specific configurations and operational aspects. ```APIDOC Managing Your Bot: - Details how to configure bot settings, including its name, avatar, and core functionalities. - Covers managing bot commands, permissions, and integrations. - Explains how to monitor the bot's performance and activity logs. - Focuses on the operational aspects of the bot within the Modr8 ecosystem. ``` -------------------------------- ### Modr8 Actions: Quick Start and Management Source: https://docs.modr8.net/features/actions This documentation covers the 'Actions' feature in Modr8, including a quick start guide, conditions, action groups, and management of actions. It explains how to create, import, export, and utilize actions, as well as the difference between bot and chat actions. ```APIDOC Modr8 Actions: - Quick Start: Guides users through the initial setup and usage of actions. - Conditions: Details the conditions that can trigger actions. - Action Groups: Explains how to group actions for better organization. - Managing, Importing & Exporting Actions: Covers the lifecycle management of actions. - Using The Marketplace: Information on leveraging the action marketplace. - Bot Actions vs. Chat Actions: Differentiates between actions executed by the bot and those by the chat. ``` -------------------------------- ### Modr8 Getting Started: Managing Bot/Chat, Team Access Source: https://docs.modr8.net/getting-started/recommended-settings Covers the management of bots and chats within Modr8, as well as how to set up and manage team access for collaborative administration. ```APIDOC Getting Started: Managing Your Bot & Chat: - Provides tools and interfaces for managing registered bots and connected chats. - Includes options for updating settings, monitoring status, and disconnecting services. Team Access: - Allows multiple users to collaborate on managing a community's Modr8 settings. - Features role-based access control to define permissions for team members. - Facilitates delegation of moderation tasks and administrative responsibilities. ``` -------------------------------- ### Modr8 Getting Started: Managing Your Bot & Chat Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Details how to manage your bot and chat effectively using the Modr8 platform. This covers ongoing management tasks and best practices. ```APIDOC Getting Started: Managing Your Bot & Chat: - Provides an overview of the dashboard and management interface. - Covers essential tasks such as monitoring chat activity, user management, and configuration updates. - Offers tips for maintaining a healthy and engaged community. - Includes sections on troubleshooting common issues and accessing support. ``` -------------------------------- ### Modr8 Actions: Quick Start, Conditions, and Management Source: https://docs.modr8.net/getting-started/recommended-settings Covers the creation, management, and utilization of Actions within Modr8. This includes understanding conditions, action groups, and managing actions through import/export and the marketplace. ```APIDOC Modr8 Actions: Quick Start: - Guides users through the initial setup of actions. - Covers basic action creation and deployment. Conditions: - Defines the criteria that trigger an action. - Supports various conditions like user roles, message content, and time. Action Groups: - Allows grouping multiple actions to be executed together. - Facilitates complex moderation workflows. Managing, Importing & Exporting Actions: - Provides tools to manage existing actions. - Supports importing actions from external sources and exporting for backup or sharing. Using The Marketplace: - Access to a marketplace for pre-built actions. - Enables community sharing and discovery of useful actions. Bot Actions vs. Chat Actions: - Differentiates between actions triggered by the bot and those initiated within the chat. ``` -------------------------------- ### Modr8 Actions: Quick Start and Conditions Source: https://docs.modr8.net/introduction This documentation covers the 'Actions' feature in Modr8, focusing on the quick start guide and how to define conditions for actions. Actions allow for automated responses to events within a chat, and conditions specify when these actions should be triggered. ```APIDOC Actions - Quick Start: - Define automated responses to chat events. - Trigger actions based on specific conditions. Actions - Conditions: - Specify criteria for action execution. - Examples: user role, message content, user activity. - Conditions can be combined using logical operators (AND, OR). ``` -------------------------------- ### Modr8 Getting Started: Managing Your Bot & Chat - Managing Your Chat Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Specific guidance on managing the chat component within Modr8. This focuses on chat-specific settings, moderation, and community engagement. ```APIDOC Managing Your Chat: - Details how to configure chat settings, including welcome messages, rules, and moderation levels. - Covers managing users, roles, and permissions within the chat. - Explains how to utilize features like polls, announcements, and custom commands. - Focuses on fostering a positive and engaging environment within the chat. ``` -------------------------------- ### Modr8 Actions: Quick Start and Conditions Source: https://docs.modr8.net/index This documentation covers the 'Actions' feature in Modr8, focusing on the quick start guide and how to define conditions for actions. Actions allow for automated responses to events within a chat, and conditions specify when these actions should be triggered. ```APIDOC Actions - Quick Start: - Define automated responses to chat events. - Trigger actions based on specific conditions. Actions - Conditions: - Specify criteria for action execution. - Examples: user role, message content, user activity. - Conditions can be combined using logical operators (AND, OR). ``` -------------------------------- ### Modr8 Getting Started: Managing Your Bot & Chat - FAQ & Troubleshooting Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Addresses frequently asked questions and provides troubleshooting steps for managing bots and chats with Modr8. This section aims to resolve common user issues. ```APIDOC FAQ & Troubleshooting: - Lists common questions encountered while managing bots and chats with Modr8. - Provides step-by-step solutions for technical issues and configuration problems. - Offers guidance on diagnosing and resolving errors. - Directs users to further support resources if needed. ``` -------------------------------- ### Adding Conditions to a Modr8 Action Source: https://docs.modr8.net/features/actions/quick-start Defines the criteria for an action to trigger. This example sets up conditions to run the action when a message starts with '!hello' or '/hello'. ```APIDOC Condition Configuration: 1. Select 'Message Text' for 'Property'. 2. Select 'Starts With' for 'Match'. 3. Enter '/hello' in 'Match Value'. 4. Click 'Add Condition'. 5. Repeat steps 1-3, entering '!hello' in 'Match Value'. 6. Change 'Match All Conditions' to 'Match Any Condition'. ``` -------------------------------- ### Modr8 Getting Started: Managing Your Bot & Chat Source: https://docs.modr8.net/features/community-reputation Guidance on managing your Modr8 bot and associated chat settings, including updating configurations, monitoring performance, and troubleshooting common issues. ```APIDOC Getting Started - Managing Your Bot & Chat: - Update bot configurations and settings. - Monitor bot status and performance. - Manage chat integrations and permissions. - Access logs and analytics for troubleshooting. ``` -------------------------------- ### Modr8 Getting Started: Add Your Chat Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Explains how to add an existing chat to the Modr8 platform for management. This step is necessary to apply Modr8's features to a specific chat. ```APIDOC Getting Started: Add Your Chat: - Provides instructions on how to link or add a chat to your Modr8 account. - Details the permissions required to add a chat. - Covers the process of selecting the chat and confirming its addition. - Enables the application of Modr8's moderation and management tools to the chat. ``` -------------------------------- ### Modr8 Getting Started: Team Access Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Explains how to grant and manage team access to your Modr8 account. This allows multiple users to collaborate on managing bots and chats. ```APIDOC Getting Started: Team Access: - Details how to invite team members to your Modr8 account. - Covers assigning roles and permissions to team members. - Explains how to manage team member access, including revoking permissions. - Facilitates collaborative management of bots and chats. ``` -------------------------------- ### Modr8 Marketplace for Actions Source: https://docs.modr8.net/getting-started/team-access Guide to using the Modr8 Marketplace to discover and utilize pre-built actions created by the community or Modr8. ```APIDOC Using The Marketplace: - Discover and utilize pre-built actions from the Modr8 Marketplace. - Find actions for various community management tasks. - Learn how to contribute your own actions to the marketplace. ``` -------------------------------- ### Modr8 Getting Started: Team Access Source: https://docs.modr8.net/features/media-and-text-filters Information on granting and managing team access to the Modr8 platform, allowing multiple administrators to collaborate on community management. ```APIDOC Getting Started - Team Access: - Explains how to invite and manage team members who will have access to the Modr8 dashboard. - Covers assigning roles and permissions for collaborative community management. - Facilitates teamwork in moderating and administering the community. ``` -------------------------------- ### Affiliate Program Setup Details Source: https://docs.modr8.net/popular-questions/affiliates-and-partnerships This section details the current settings for the ModR8 affiliate campaign, including commission structure, referral tracking, and payout conditions. ```text * Minimum payout amount: $10 * Credit the last referrer if multiple links are clicked * Track referrals for 14 days after link clicked * Commission type 20% * Recurring commissions for subscriptions on each successful payment * All ModR8 products can earn commission * Payouts can be made to PayPal or Bank * Auto approval of affiliates that pass LemonSqueezy due-diligence checks * Sign up / Login address https://modr8.lemonsqueezy.com/affiliates ``` -------------------------------- ### Modr8 Actions: Using The Marketplace Source: https://docs.modr8.net/features/actions/using-the-marketplace This guide explains how to use the Modr8 Actions Marketplace, a platform for discovering and utilizing pre-built actions created by the Modr8 community or developers. It likely covers browsing, installing, and customizing marketplace actions. ```APIDOC Actions - Using The Marketplace: - Explains how to navigate and utilize the Modr8 Actions Marketplace. - Covers finding, installing, and configuring actions from the marketplace. - Provides information on contributing to the marketplace. ``` -------------------------------- ### Modr8 Introduction: Feature Overview Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Provides a comprehensive overview of the features offered by Modr8. This section serves as a guide to the platform's various functionalities. ```APIDOC Introduction: Feature Overview: - Lists and briefly describes the main features of Modr8, including moderation tools, engagement features, analytics, and customization options. - Highlights the value proposition of each feature. - Gives users a roadmap of what they can achieve with the platform. ``` -------------------------------- ### Modr8 Getting Started: Managing Your Bot & Chat Source: https://docs.modr8.net/features/media-and-text-filters Information on how to manage your registered bot and connected chats within the Modr8 dashboard, including updating settings and monitoring status. ```APIDOC Getting Started - Managing Your Bot & Chat: - Details how to manage registered bots and connected chat instances through the Modr8 interface. - Covers updating configurations, monitoring bot status, and managing chat integrations. - Provides tools for ongoing administration of your Modr8 setup. ``` -------------------------------- ### Modr8 Actions Source: https://docs.modr8.net/features/commands/creating-and-managing-custom-commands Documentation for Modr8 Actions, covering quick start, conditions, action groups, management, importing/exporting, marketplace usage, and the difference between bot and chat actions. ```APIDOC Actions: - Quick Start: Get started with creating and using actions. - Conditions: Learn about the conditions that can trigger actions. - Action Groups: How to group actions for efficient management. - Managing, Importing & Exporting Actions: Procedures for handling action configurations. - Using The Marketplace: Information on utilizing the Modr8 Actions Marketplace. - Bot Actions vs. Chat Actions: Explains the distinction between bot-specific and chat-specific actions. ``` -------------------------------- ### Modr8 Actions Documentation Source: https://docs.modr8.net/features/commands/built-in-commands This section covers Modr8's 'Actions' feature, which allows for automated responses and tasks based on specific conditions. It includes information on quick start guides, conditions, action groups, and marketplace integration. ```APIDOC Actions Overview: - Description: Automate responses and tasks within your community based on predefined triggers and conditions. Quick Start: - Description: A guide to quickly set up your first action. Conditions: - Description: Defines the criteria that must be met for an action to be triggered (e.g., user joins, message content, specific roles). - Example Condition: `user.role == 'admin'` Action Groups: - Description: Organize multiple actions into logical groups for easier management and execution. Managing, Importing & Exporting Actions: - Description: Tools for managing your created actions, including importing from and exporting to external sources. Using The Marketplace: - Description: Access and utilize pre-built actions from the Modr8 Marketplace. Bot Actions vs. Chat Actions: - Description: Differentiates between actions executed by the bot and those initiated by users in the chat. ``` -------------------------------- ### Previewing Welcome Message Source: https://docs.modr8.net/features/welcome-message-and-human-check Instructions on how to preview welcome messages before they are sent to new members. Explains the process of sending a preview message via direct message and the prerequisite of starting a conversation with the bot. ```APIDOC APIDOC: Welcome Message Preview: - Add content to your welcome message. - Select the "Preview Message" button. - The bot will send a direct message with the content for review. - Prerequisites: - You MUST have started a conversation with the bot in Direct Message (DM). - You MUST have clicked the "Start" button in the DM conversation with the bot. ``` -------------------------------- ### Modr8 Actions: Managing, Importing & Exporting Source: https://docs.modr8.net/features/community-referrals Guidance on how to manage existing Modr8 Actions, including importing new actions and exporting current configurations. This facilitates sharing and backup of action setups. ```APIDOC Actions - Managing, Importing & Exporting: - Manage Actions: View, edit, delete, enable/disable. - Import Actions: Upload action configurations from files (e.g., JSON). - Export Actions: Download current action configurations for backup or sharing. - Supported Formats: JSON ``` -------------------------------- ### Modr8 Actions Documentation Source: https://docs.modr8.net/introduction/pricing-and-subscriptions This documentation covers Modr8's Actions feature, allowing users to create custom automated responses and tasks within their communities. It includes guides on conditions, action groups, and marketplace usage. ```APIDOC Actions: - Quick Start: Guides on setting up your first action. - Conditions: Defines the triggers and criteria for actions to execute. - Example Condition: 'user_joined_channel' with parameters like 'channel_id'. - Action Groups: Allows bundling multiple actions for sequential or conditional execution. - Managing, Importing & Exporting Actions: Tools for organizing and sharing custom actions. - Using The Marketplace: Accessing pre-built actions from the Modr8 community. - Bot Actions vs. Chat Actions: Differentiates actions performed by the bot versus those initiated within the chat. ``` -------------------------------- ### Creating a Modr8 Action Source: https://docs.modr8.net/features/actions/quick-start This snippet outlines the process of creating a simple 'Hello World' style action in Modr8. It details how to set up a command that responds to user input with a personalized greeting. ```en The quickest way to get up and running with Actions is to just have a go! The following sections will outline how to create your first action using a simple "Hello World" style command. We want the command to run when a user sends a command such as !hello or /hello with the output being "Hello X, how are you?" ``` -------------------------------- ### Modr8 Introduction: What is Modr8?, Feature Overview, Pricing Source: https://docs.modr8.net/getting-started/recommended-settings Provides an introduction to Modr8, outlining its core purpose, a general overview of its features, and information regarding pricing and subscription plans. ```APIDOC Introduction: What is Modr8?: - An overview of the Modr8 platform and its primary functions. - Explains its role in community management and moderation. Feature Overview: - A summary of the key features and capabilities offered by Modr8. - Highlights functionalities like moderation tools, automation, user management, and analytics. Pricing & Subscriptions: - Details the different pricing tiers and subscription plans available. - Outlines the features and limits associated with each plan. - Information on billing and payment options. ``` -------------------------------- ### Modr8 Getting Started: Add Your Chat Source: https://docs.modr8.net/features/media-and-text-filters Instructions on how to add your chat (e.g., Discord server, Telegram group) to Modr8 for management and moderation. ```APIDOC Getting Started - Add Your Chat: - Guides users through the process of connecting their chat platform (e.g., Discord, Telegram) to Modr8. - Involves providing necessary permissions and configuration details. - Enables Modr8's moderation and management features for the specified chat. ``` -------------------------------- ### Single Send Scenario Source: https://docs.modr8.net/features/announcements/one-off-and-scheduled Provides an example of how to configure the schedule for a single announcement send by setting the interval to be larger than the time between the scheduled start and stop times. ```APIDOC Single Send Example: To send an announcement only once, set the 'Send Every' interval to be greater than the duration between 'Schedule For' and 'Stop Sending'. Example: Schedule for 1 PM today, Stop Sending 2 PM today. Interval: 1 day. This will send the announcement once and stop before the next interval. ``` -------------------------------- ### Modr8 Getting Started: Team Access Source: https://docs.modr8.net/features/community-reputation Information on how to grant team access to your Modr8 bot and community management dashboard, allowing multiple administrators to collaborate effectively. ```APIDOC Getting Started - Team Access: - Invite team members to manage your Modr8 bot. - Assign roles and permissions to team members. - Collaborate on community moderation and management. - Ensure secure access control for your team. ``` -------------------------------- ### Modr8 Introduction Source: https://docs.modr8.net/getting-started/team-access An introduction to Modr8, explaining what it is and its core functionalities for community management. ```APIDOC Introduction: - What is Modr8? An overview of the platform's purpose and capabilities. - Feature Overview: A summary of the key features Modr8 offers for community management. - Pricing & Subscriptions: Information on available plans and pricing. - Global & Multi-Chat Features: Details on managing multiple chats or global features. ``` -------------------------------- ### Creating a Modr8 Action Source: https://docs.modr8.net/features/actions/quick-start Steps to create a new action on the Modr8 platform. This involves navigating the UI, naming the action, setting execution permissions, and enabling the action. ```APIDOC Action Creation Steps: 1. Login to Modr8 platform. 2. Navigate to 'Manage' -> 'Actions' for your bot profile. 3. Click 'Create' on the 'Create A New Action' card. 4. Enter a 'Strategy Name'. 5. Configure 'Executes For' permissions (default is fine for now). 6. Ensure 'Active' switch is enabled. 7. Set 'Execution Probability' (default 100%). ``` -------------------------------- ### Modr8 Getting Started: Add Your Chat Source: https://docs.modr8.net/features/community-reputation Instructions on how to connect your existing chat platform (e.g., Discord, Telegram) to Modr8, enabling the bot's features within your community. ```APIDOC Getting Started - Add Your Chat: - Connect your chat platform (e.g., Discord, Telegram) to Modr8. - Invite the Modr8 bot to your server or group. - Authorize Modr8 to access necessary chat permissions. - Ensure successful integration for bot functionality. ``` -------------------------------- ### Modr8 Actions: Using The Marketplace Source: https://docs.modr8.net/features/community-referrals Instructions on how to utilize the Modr8 Actions Marketplace to discover, download, and implement pre-built actions created by the community or Modr8. ```APIDOC Actions - Using The Marketplace: - Browse and discover pre-made actions. - Install actions directly from the marketplace. - Share your own created actions with the community. - Categories: Moderation, Engagement, Utility, etc. ``` -------------------------------- ### Modr8 Introduction: Global & Multi-Chat Features Source: https://docs.modr8.net/getting-started/recommended-settings Explains Modr8's capabilities for managing global features and interacting with multiple chat platforms simultaneously. ```APIDOC Introduction: Global & Multi-Chat Features: - Describes functionalities that operate across multiple communities or chat platforms. - Enables centralized management and consistent application of rules or settings. - Details how Modr8 can manage multiple chat integrations simultaneously. ``` -------------------------------- ### Modr8 Introduction: Pricing & Subscriptions Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat Details the pricing structure and subscription plans available for Modr8. This section helps users understand the costs associated with using the platform. ```APIDOC Introduction: Pricing & Subscriptions: - Outlines the different pricing tiers and subscription levels offered by Modr8. - Details the features and limitations associated with each plan. - Provides information on billing, payment methods, and trial periods. - Helps users choose the plan that best suits their needs. ``` -------------------------------- ### Adding Action Outcomes Source: https://docs.modr8.net/features/actions/quick-start Specifies what the action should do when its conditions are met. This example configures the action to send a personalized message. ```APIDOC Action Outcome Configuration: 1. Under 'Action Groups', select 'Send Message' for 'Execute Action'. 2. In 'Message Text', enter 'Hello {{o_user}}, how are you?'. 3. Check the 'Delete After Timeout' box. 4. Click 'Save Changes'. ``` -------------------------------- ### Modr8 Polls and Quizzes Source: https://docs.modr8.net/getting-started/team-access Guide to creating and managing polls and quizzes in Modr8 to engage your community and gather feedback. ```APIDOC Polls & Quizzes: - Create interactive polls and quizzes to engage your community. - Gather feedback, test knowledge, or simply have fun. - Analyze results to understand community sentiment and engagement. ``` -------------------------------- ### Welcome Message Configuration Source: https://docs.modr8.net/getting-started/recommended-settings Set up personalized welcome messages for new users, including text, personalization tags like {{user}}, and optional verification steps. ```APIDOC APIDOC: Settings: Welcome Message & Captcha Check: Welcome Users: true Welcome Message Text: "Welcome {{user}}! Please check our documentation." Personalization Tags: user: "Injects the user's name as a clickable link to their profile." ``` -------------------------------- ### Modr8 Media and Text Filters Source: https://docs.modr8.net/getting-started/team-access Guide to configuring media and text filters in Modr8 to control the content shared within your community. ```APIDOC Media & Text Filters: - Configure filters to automatically detect and manage specific media or text content. - Customize filter lists and actions to maintain community standards. - Protect your community from inappropriate or harmful content. ``` -------------------------------- ### Modr8 User Filters Source: https://docs.modr8.net/getting-started/team-access Guide to configuring user filters in Modr8 to manage specific users or user groups based on various criteria. ```APIDOC User Filters: - Create and manage filters to apply specific rules or actions to individual users or groups. - Filter based on user roles, activity, or other attributes. - Customize user management and moderation workflows. ``` -------------------------------- ### Modr8 Features: Admin Verification, Welcome Message, and Human Check Source: https://docs.modr8.net/getting-started/recommended-settings Details Modr8's features for verifying administrators, customizing welcome messages for new users, and implementing human checks to prevent bot abuse. ```APIDOC Admin Verification: - Process for verifying administrators or moderators. - May involve specific roles or permissions. Welcome Message & Human Check: - Customizable welcome messages for new users joining the community. - Human check mechanisms (e.g., CAPTCHA, simple questions) to ensure new members are not bots. - Helps in onboarding legitimate users and deterring malicious bots. ``` -------------------------------- ### Telegram Supergroup Conversion Check Source: https://docs.modr8.net/getting-started/add-your-chat Details how to check if a Telegram group is a Supergroup and the conditions under which a group is automatically converted. A Supergroup chat ID starts with '-100'. ```APIDOC Checking for Telegram Supergroup: - Execute the /debug command in your chat. - If the chat ID begins with '-100', it is a Supergroup. - Otherwise, it's a normal group and needs conversion. ``` -------------------------------- ### Modr8 Recommended Settings Source: https://docs.modr8.net/getting-started/team-access Provides recommended settings and configurations for Modr8 to optimize performance and effectively manage your community. ```APIDOC Recommended Settings: - Best practices and suggested configurations for Modr8. - Optimize bot performance, moderation rules, and engagement features. - Ensure a smooth and effective community management experience. ``` -------------------------------- ### Modr8 Custom Commands Source: https://docs.modr8.net/getting-started/team-access A guide on creating and managing custom commands in Modr8, allowing users to tailor the bot's functionality to their specific community needs. ```APIDOC Creating & Managing Custom Commands: - Step-by-step guide to creating your own commands in Modr8. - Learn how to define command triggers, responses, and parameters. - Covers managing, editing, and deleting custom commands. ``` -------------------------------- ### Modr8 Editing User Profiles and Details Source: https://docs.modr8.net/features/user-management Guide on how to edit user profiles, including reputation points, warnings, and status. It covers amending whitelisting and submitting changes. ```APIDOC 1. Select "Manage" on your bot profile 2. Select "Users" on your chat profile 3. Search for a user 4. Click the "Manage" button at the end of the row 5. Click "View Profile" within the menu 6. Amend reputation points by editing the number value in the "Reputation" text box 7. To add a user to the trusted list where they bypass bot filters or to remove them toggle the "Whitelisted" option 8. The user status can be amended by updating the drop down on the "Status" option 9. To add or remove warnings use the "Add Warning" button or delete out any you do not want to be in place. 10. Hit "Submit" button to save any changes made ``` -------------------------------- ### Modr8 Pricing and Subscriptions Source: https://docs.modr8.net/introduction/pricing-and-subscriptions Details on Modr8's subscription plans, pricing, and payment options. Includes information on free trials, accepted payment methods, and affiliate programs. ```APIDOC Pricing & Subscriptions: - Overview: General information about available plans. - Subscription Options: Details on different tiers and their features. - Chat Prices: Current pricing for chat services. - Free Trials: Information on trial periods. - Payment Methods: Accepted forms of payment, including crypto. - Referrals / Affiliates: Details on commission for partnerships. - FAQ & Troubleshooting: Common questions related to billing and subscriptions. ``` -------------------------------- ### Modr8 Commands: Creating & Managing Custom Commands Source: https://docs.modr8.net/features/community-reputation Guides users on how to create, customize, and manage their own commands within Modr8. This allows for tailored bot responses and moderation workflows. ```APIDOC Commands - Creating & Managing Custom Commands: - Define custom command names and triggers. - Assign specific responses or actions to custom commands. - Manage the lifecycle of custom commands (create, edit, delete). ``` -------------------------------- ### Modr8 Introduction: Pricing & Subscriptions Source: https://docs.modr8.net/features/media-and-text-filters Information regarding Modr8's pricing plans and subscription options, detailing the features and limits associated with each tier. ```APIDOC Introduction - Pricing & Subscriptions: - Details the various pricing tiers and subscription plans offered by Modr8. - Outlines the features, limits, and costs associated with each plan. - Helps users choose the most suitable subscription for their needs. ``` -------------------------------- ### Modr8 Introduction: What is Modr8? Source: https://docs.modr8.net/getting-started/managing-your-bot-and-chat An introductory explanation of what Modr8 is and its primary purpose. This section provides a high-level overview of the platform's capabilities. ```APIDOC Introduction: What is Modr8?: - Defines Modr8 as a platform for managing and moderating online communities and bots. - Highlights key benefits such as enhanced user engagement, automated moderation, and streamlined management. - Briefly touches upon the core features and target audience. ``` -------------------------------- ### Modr8 Commands: Creating & Managing Custom Commands Source: https://docs.modr8.net/features/community-referrals A guide on how to create, configure, and manage custom commands within Modr8 to extend its functionality based on specific community needs. ```APIDOC Commands - Creating & Managing Custom Commands: - Create custom commands to automate tasks or provide specific information. - Process: 1. Define command name (e.g., !greet). 2. Set command response (text, embed, action). 3. Configure permissions (who can use the command). 4. Manage commands: edit, delete, enable/disable. - Use cases: Welcome messages, FAQs, custom moderation tools. ``` -------------------------------- ### Modr8 Actions: Using The Marketplace Source: https://docs.modr8.net/features/advanced-features Information on how to utilize the Modr8 Actions Marketplace to discover and implement pre-built actions created by the community. ```APIDOC Actions - Using The Marketplace: - Browse and install pre-made actions from the Modr8 community. - Discover actions for various use cases like moderation, engagement, and utility. - Contribute your own actions to the marketplace. ``` -------------------------------- ### Modr8 Commands: Creating & Managing Custom Commands Source: https://docs.modr8.net/features/advanced-features A guide on how to create and manage your own custom commands within Modr8. This allows for tailored functionality to suit specific community needs. ```APIDOC Commands - Creating & Managing Custom Commands: - Define your own commands with custom triggers and responses. - Assign arguments, permissions, and execution logic. - Manage a library of custom commands for your community. - Example: - Command Name: `!greet` - Trigger: `!greet` - Response: `Hello, {user}! Welcome to the server.` ```