> For the complete documentation index, see [llms.txt](https://mythicalbot.gitbook.io/arklynn-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mythicalbot.gitbook.io/arklynn-docs/resources/legacy-scripting/announcements.md). # Announcements This method uses the prefix `; or .` and the command `announcement or ann`. > **Note:** This is the **legacy** system. For more flexibility (embeds, buttons, advanced scripting), we recommend using the new **Scripts** system under **Announcements**. However, if you're already familiar with this command, it still works. *** ### Command Syntax ``` ;ann [channel] [title] -- [content] [options] ``` Parameters | Part | Description | Example | | ----------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------- | | `[channel]` | The channel where the announcement will be sent (mention or ID). | `#announcements` | | `[title]` | The title of the embed. | `New Update!` | | `--` | Separator between title and content. | `--` | | `[content]` | The main text of the announcement. You can use `--` for line breaks and `__` for paragraph breaks. | `We've added new features -- Check them out!` | | `[options]` | Optional flags to customize the embed (see below). | `--color red --ping @everyone` | ### ### Main Options (Flags) > You can add any of the following options after the content. Each option starts with `--` followed by the parameter name and its value. | Option | Description | Example | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | | `--color [HEX/name]` | Set the embed color. You can use a hex code (e.g., `#ff0000`) or a color name (e.g., `red`, `blue`, `green`, `yellow`, `purple`, etc.). | `--color #00ff00` or `--color blue` | | `--url [link]` | Make the title clickable by adding a URL. | `--url https://example.com` | | `--image [URL]` | Add a large image to the embed. | `--image https://i.imgur.com/abc.png` | | `--thumb [URL]` | Add a thumbnail image (top right corner). | `--thumb https://i.imgur.com/xyz.png` | | `--ping [@role/id]` | Mention a role or user after the announcement is sent. You can use `@everyone` or `@here` as well. | `--ping @Staff` or `--ping 123456789012345678` | | `--footer [text]` | Add a footer text (appears at the bottom of the embed). | `--footer "Posted by Admin"` | {% hint style="info" %} **Note:** Options are case‑insensitive. If you use a color name, it must be one of the supported names (common ones work). {% endhint %} ### ### **Formatting Inside the Content** 1. You can add basic formatting to your content using special markers: * `--` – Inserts a **line break** (new line) within the content. * `__` – Inserts a **paragraph break** (adds an empty line). Example: ``` ;ann #general Server Maintenance -- We will be performing maintenance tomorrow -- from 2 AM to 4 AM UTC __ Thank you for your patience. ``` This will produce: ``` We will be performing maintenance tomorrow from 2 AM to 4 AM UTC Thank you for your patience. ``` *** ### Complete Examples Example 1: Simple Announcement with Color and Ping ``` ;ann #announcements New Rules -- Please read the updated rules in #rules --color red --ping @everyone ``` {% hint style="info" %} **Result:** An embed with title "New Rules", content "Please read the updated rules in #rules", red color, and a ping to @everyone after the message. {% endhint %} Example 2: Announcement with Image and Footer ``` ;ann #updates Patch Notes v2.0 -- We've added a new leveling system! --image https://i.imgur.com/levelup.png --footer "Check #changelog for details" ``` {% hint style="info" %} **Result:** An embed with title, content, an image, and a footer. {% endhint %} #### Example 3: Using Title URL and Thumbnail ``` ;ann #general Community Event -- Join us this Friday for a game night! --url https://discord.gg/event --thumb https://i.imgur.com/event_icon.png --color purple ``` {% hint style="info" %} **Result:** Title links to the event page, and a thumbnail appears. {% endhint %} *** ### Important Notes * The command must be used in a channel where the bot can send messages and embeds. * The bot needs permission to mention roles if you use `--ping`. * If you use a hex color, include the `#` (e.g., `#ff9900`). * The legacy system does **not** support buttons or advanced variables like `{user}` – it's plain text and basic embeds only. *** {% hint style="danger" %} ### Migration to New Scripts {% endhint %} > We strongly recommend switching to the new **Scripts** system (found under **Announcements** in the dashboard) for greater flexibility. There you can: * Use embeds with multiple fields, timestamps, and author lines. * Add buttons. * Include dynamic variables (`{user}`, `{guild.name}`, etc.). * Customize every aspect of the message. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://mythicalbot.gitbook.io/arklynn-docs/resources/legacy-scripting/announcements.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.