# Modules

## Automation

**Automation** module covers up all server trigger related commands, like [welcome messages](/automation/welcomemessage.md), [welcome DMs](/automation/welcomedm.md), [leave messages](/automation/leavemessage.md) etc. You can customize these events at your own creativity via [dashboard](https://go.nyaru.xyz/dashboard) or commands.

| Command                                         | Description                                                                                                                                                                  |
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [welcomedm](/automation/welcomedm.md)           | Whenever someone joins the server, I will DM them this welcome message automatically.                                                                                        |
| [welcomemessage](/automation/welcomemessage.md) | I trigger this action when someone joins the server. For example, you can set a custom channel and message to be sent when someone joins the server, as a welcome message.   |
| [leavemessage](/automation/leavemessage.md)     | I trigger this action when someone leaves the server. For example, you can set a custom channel and message to be sent when someone leaves the server, as a goodbye message. |

## Automod™

> s00n™

## Moderation

Keep your server's security *tight* with Nyaru's flexible **Moderation** module, that offers *everything* you had expected! You can also keep *logs* of all your moderator(s) actions in your discord server as well!

| Command                       | Description                                                                                                                                     |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| [ban](/moderation/ban.md)     | I can ban someone using this command, for you.                                                                                                  |
| [unban](/moderation/unban.md) | I can unban someone using this command, for you.                                                                                                |
| [purge](/moderation/purge.md) | A command you can use to clear messages in bulk from a channel using different filters.                                                         |
| [kick](/moderation/kick.md)   | I can kick someone using this command, for you.                                                                                                 |
| [nuke](/moderation/nuke.md)   | Clones the current channel and makes a new channel on same position and same permissions. Post deletes the channel the command was executed in. |
| [pin](/moderation/pin.md)     | You can ask me to pin any message :)                                                                                                            |
| [unpin](/moderation/unpin.md) | You can ask me to unpin any message :)                                                                                                          |

## Giveaways

Create awesome events and giveaways using Nyaru's highly customizable **Giveaway** module, that offers requirement giveaways as well, with bonus and bypass entries - with ease.

| Command                          | Description                                                                       |
| -------------------------------- | --------------------------------------------------------------------------------- |
| [gcreate](/giveaways/gcreate.md) | Create and start a giveaway with a wizard, asking you for all options one by one. |
| [gstart](/giveaways/gstart.md)   | Start a giveaway in the server.                                                   |
| [greroll](/giveaways/greroll.md) | Reroll an ended giveaway.                                                         |
| [gedit](/giveaways/gedit.md)     | Edit an on-going giveaway with ease to change requirements, winners etc.          |
| [glist](/giveaways/glist.md)     | Lists out list of all giveaways in the channel.                                   |
| [gend](/giveaways/gend.md)       | End a giveaway in the server.                                                     |

## Music

Chill out your day with our extensive **Music** module, *free for use* ~~unlike other bots~~. We support [YouTube](https://youtube.com), [Spotify](https://www.spotify.com/) and [SoundCloud](https://soundcloud.com/)! We've all options you would've wanted, right under Nyaru.

| Command                            | Description                                    |
| ---------------------------------- | ---------------------------------------------- |
| [play](/music/play.md)             | Plays audio from YouTube, Spotify or Souncloud |
| [pause](/music/pause.md)           | Pause the currently playing music.             |
| [resume](/music/resume.md)         | Resume the current paused song                 |
| [search](/music/search.md)         | Search and select videos to play.              |
| [skip](/music/skip.md)             | Skip a song.                                   |
| [queue](/music/queue.md)           | Show current playlist.                         |
| [stop](/music/stop.md)             | Stop and clear the current queue.              |
| [shuffle](/music/shuffle.md)       | Shuffle queue.                                 |
| [remove](/music/remove.md)         | Remove song from the queue.                    |
| [nowplaying](/music/nowplaying.md) | Show song name playing now.                    |
| [loop](/music/loop.md)             | Repeat the current song or queue.              |

## Informational

Get information about users (across discord), servers, emojis, even me - and a lot more, from **Informational/Info** module.

| Command                                    | Description                                              |
| ------------------------------------------ | -------------------------------------------------------- |
| [serverinfo](/informational/serverinfo.md) | This commands shows detailed server information to you.  |
| [userinfo](/informational/userinfo.md)     | Get the info of tagged users or your own info.           |
| [avatar](/informational/avatar.md)         | Find enlarged avatar of someone, with links!             |
| [about](/informational/about.md)           | Gives you some info about the bot!                       |
| [dpbal](/informational/dpbal.md)           | See DREAM Points balance for yourself or for other user! |

## Utility

Useful left-over commands which does not fit in any other module will be found in **Utility** module.&#x20;

| Command                      | Description                                                                               |
| ---------------------------- | ----------------------------------------------------------------------------------------- |
| [ping](/utility/ping.md)     | Um, you want to know? It shows my latency.                                                |
| [help](/utility/help.md)     | Help command shows all valid commands for you to interact with me.                        |
| [invite](/utility/invite.md) | Gives you the invite link to invite me in your server, my support server and our website. |
| [embed](/utility/embed.md)   | Create a stylish embed using a interactive setup, and send to any channel.                |
| [poll](/utility/poll.md)     | I can create a poll for you! Seperate Question and choices using `\|`!                    |
| [say](/utility/say.md)       | I will repeat what you say.                                                               |
| [edit](/utility/edit.md)     | Edits a message I sent using message ID!                                                  |

## Settings

Configure Nyaru's **settings** for your server, such as log channels, triggers etc.

| Command                       | Description                               |
| ----------------------------- | ----------------------------------------- |
| [prefix](/settings/prefix.md) | Set your server prefix with this command! |


---

# Agent Instructions: 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://docs.nyaru.xyz/introduction/modules.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.
