# Introduction

This serves as an introduction to kayo, where you can acquaint yourself with the bot and understand how things operate.

In the documentation and on help embeds within the bot, command usage is presented with specific formatting. Notably, arguments wrapped with [] signify optional parameters, while those enclosed in <> indicate required parameters.

Additionally, you may encounter parameters with = after them, such as [param="value"]. This signifies that the parameter is optional, and if no suitable argument is provided, it will default to the specified value.

Certain parameters may require you to pass a specific value from a predefined list. These values will be represented in the command syntax as "value1"|"value2"|..., indicating that any one of those values must be provided.

Flags are additional parameters distinguished by the -- prefix to set them apart from other parameters. They are usually optional and are commonly utilized to make minor modifications to specific aspects of the command you're executing.

To use flags, add a flag argument after entering the command name and regular parameters. The flag is placed after everything else, as seen in this example: ;example test 123 --flag value. The flag value can be diverse, accepting anything from strings to numbers and more.

To view the available flags for a command, use the help command. It will include a brief description of each flag, explaining its purpose.

kayo supports creating your own messages for various commands. You can create your own embeds, buttons, or regular messages according to your preferences.

Every command that supports scripting can accommodate both embeds and regular content. You have the option to set whatever you prefer. For regular content, simply pass text without any additional formatting. If you want to add an embed, the content will need to be passed as a component. Refer to the components below for embeds.

Whether you opt for embeds or regular content, both support variables—text enclosed in curly braces {} that you can include in your message. These variables adapt based on the context. For instance, in the welcome command, {user.mention} would mention the user who joined the server.

Creating your own embeds is straightforward. Simply use curly braces {}, specify the component name with name:, and include your preferred value in the format {name: value}.

{title: cool embed} {description: this is a description}

The components are: color, author, title, url, description, field, footer, thumbnail, image

Certain components go beyond a single value; you must separate values with && inside the component. This applies to the author, field, and footer components. If no color component is provided, it will default to being invisible.

{author: name && icon && url}

{field: name && value && true | false}

The option of true or false is optional, indicating whether the field should be inline; the default is false.

{footer: text && icon}

Button parsing functions in the same way as embeds. You can create link buttons that users can click to visit a website. Additionally, you have the option to include an emoji, although this is entirely optional.

{button: name && url && emoji}