> 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/scripting/announcements.md).

# Announcements

### 1. Command Syntax (Two Ways)

***

**A. Basic Embed with Script Syntax**

```
;ann #channel {embed}$v{color: #e2e8f0}$v{title: Your Title}$v{description: Your message with {variables}}
```

**B. Full Script with Multiple Components**

1. You can chain elements together inside the `{embed}` block:

```
;ann #general {embed}$v{color: #e2e8f0}$v{title: Welcome {user.name}}$v{description: We now have {guild.count} members!}$v{thumbnail: {member.avatar}}$v{button: link && Visit Site && https://arklynn.xyz}
```

###

### 2. Available Variables

***

> Use these placeholders to personalize announcements:

| Variable          | Description                         |
| ----------------- | ----------------------------------- |
| `{user.name}`     | Username of the target user         |
| `{user.mention}`  | Mention the user (e.g., @Anaseueid) |
| `{member.avatar}` | URL of the user's avatar            |
| `{guild}`         | Server name                         |
| `{guild.count}`   | Current member count                |
| `{channel}`       | Mention of the current channel      |
| `{user.id}`       | User's Discord ID                   |
| `{guild.icon}`    | Server icon URL                     |

###

### 3. Building an Announcement

***

> You can include multiple components inside the `{embed}` block. Below are all available elements, organized by category.

####

#### Basic Settings

| Component       | Format                             | Example                                               |
| --------------- | ---------------------------------- | ----------------------------------------------------- |
| **Title**       | `{title: Your Title}`              | `{title: Important Update}`                           |
| **Description** | `{description: Main text}`         | `{description: We've reached {guild.count} members!}` |
| **Title URL**   | `{url: https://...}`               | `{url: https://arklynn.xyz}`                          |
| **Ping Target** | `{ping: @role}`                    | `{ping: @everyone}`                                   |
| **Color**       | `{color: #hex}` or `{color: name}` | `{color: #FF5733}` or `{color: blue}`                 |

####

#### Appearance & Media

| Component     | Format                   | Example                                |
| ------------- | ------------------------ | -------------------------------------- |
| **Image**     | `{image: image_url}`     | `{image: https://i.imgur.com/abc.png}` |
| **Thumbnail** | `{thumbnail: image_url}` | `{thumbnail: {member.avatar}}`         |

####

#### Author Information

| Component       | Format                   | Example                      |
| --------------- | ------------------------ | ---------------------------- |
| **Author Name** | `{author: name}`         | `{author: Server Staff}`     |
| **Author Icon** | `{authoricon: icon_url}` | `{authoricon: {guild.icon}}` |

####

#### Fields

1. Add up to 25 fields. Each field can be inline or not.

```
{field: Title && Value && true}
```

* `true` = inline, `false` = not inline

Example**:**

```
{field: Members && {guild.count} && true}{field: Online && 42 && true}
```

####

#### Buttons

1. Currently supports link buttons.

```
{button: link && Button Text && https://url}
```

Example**:**

```
{button: link && Join Event && https://discord.gg/abc123}
```

####

#### Footer

| Component       | Format                   | Example                          |
| --------------- | ------------------------ | -------------------------------- |
| **Footer Text** | `{footer: text}`         | `{footer: Announced by Arklynn}` |
| **Footer Icon** | `{footericon: icon_url}` | `{footericon: {guild.icon}}`     |

#### Timestamp

1. Add `{timestamp}` anywhere to insert the current time.

### 4. Complete Examples

***

Simple Welcome

```
;ann #welcome {embed}$v{title: Welcome {user.name}!}$v{description: Glad to have you in {guild}! We're now at {guild.count} members.}$v{thumbnail: {member.avatar}}$v{color: green}
```

Event Announcement with Button

```
;ann #events {embed}$v{title: 🎮 Game Night Tonight}$v{description: Join us at 8 PM UTC for among us!}$v{image: https://i.imgur.com/gamenight.png}$v{field: Date && March 10 && true}$v{field: Prize && 100 Discord Nitro && true}$v{button: link && Join VC && https://discord.gg/voice-channel}
```

Server Milestone

```
;ann #general {embed}$v{title: 🎉 Milestone Reached!}$v{description: We just hit **{guild.count} members**! Thank you all!}$v{color: #FFD700}$v{footer: {guild.name}}{timestamp}$v{ping: @everyone}
```

###

### 5. Interactive Builder (Recommended)

***

For the easiest experience, use the **visual embed builder** at:\
\> [**arklynn.xyz/embed**](https://arklynn.xyz/embed) 

The builder lets you:

* Design your embed with live preview
* Add fields, images, buttons visually
* Test different colors and layouts
* Export your embed as a **ready-to-use command**

#### How to Use the Builder

1. Visit [arklynn.xyz/embed](https://arklynn.xyz/embed)
2. Fill in the sections: **Basic**, **Appearance**, **Media**, **Author**, **Fields**, **Buttons**, **Footer**
3. Watch the **Live Preview** update in real-time
4. Click **Copy Command** – the exact `;ann #channel` syntax will be copied to your clipboard
5. Paste it into Discord and send

### 6. Tips & Best Practices

***

* **Test first**: Try your announcement in a private channel before sending to #general
* **Use variables wisely**: `{user.name}` and `{member.avatar}` only work when the command is triggered by an event that has a user context
* **Button URLs**: Must start with `https://` or `http://`
* **Color names**: Common names like `red`, `blue`, `green`, `yellow`, `purple`, `orange` work; for exact shades use hex codes (e.g., `#5865F2`)
* **Line breaks**: Use `\n` inside description or field values for line breaks

### 7. Troubleshooting

***

| Issue                  | Likely Fix                                                                                              |
| ---------------------- | ------------------------------------------------------------------------------------------------------- |
| Embed not showing      | Ensure `{embed}` is at the start and all brackets are properly closed                                   |
| Variables not replaced | Check spelling; some variables only work in specific contexts (e.g., `{user}` only in welcome messages) |
| Button missing         | Verify syntax: `{button: link && Text && https://url}`                                                  |
| Color not working      | Use hex with `#` or a supported color name                                                              |
|                        |                                                                                                         |

***


---

# 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/scripting/announcements.md?ask=<question>
```

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.