# Welcome to Nyaru Help! Nyaru is a fully-fledged, customizable and your personal discord assistant for your discord server, having exceptional multi-tasking abilities! {% hint style="danger" %} **We do not advice you to read the documentation right now. We're working very hard on our end to make it brief and easy to understand. If you want help, please do not refer to anything here untill it's officially published.** Meanwhile, have a look at our [discord server](https://go.nyaru.xyz/discord)! {% endhint %} This documentation provides information on each module/command, including the description, usage, and examples. {% hint style="info" %} You may always join our [discord server](https://discord.gg/mFrqAdyCBB) for direct assistance! {% endhint %} ## Inviting Nyaru ⭐ An extensive and detailed page has been written on how to invite nyaru over [here](/invite). {% content-ref url="/pages/-MgkUC\_P8wUmYzPXjQoz" %} [Invite Nyaru!](/invite) {% endcontent-ref %} ## Documentation Guide In the navigation bar, you can see many groups. Each group has pages, and sub-pages respectively. Everything is well categorized! If you are looking for detailed help of any topic, you can also use the 🔎 `Search` option to find your answers! {% hint style="success" %} **ProTip:** For instant help regarding a command or module, just run `@Nyaru help ` from the discord itself! {% endhint %} ## Theme {% hint style="danger" %} **White Mode Alert!** This documentation is *only* available in **Day/Light Mode**. Scroll down to learn more. {% endhint %} Unfortunately 😔, we *can't* support dark theme in documentation. We're using [GitBook](https://gitbook.com/) software for documentation which does not permit us to use Dark Mode in our documentation. While premium plans do allow us, consider supporting us on [**Patreon**](https://www.patreon.com/NyaruBot), for [*Premium*](/introduction/premium) *Perks* of Nyaru and more **advanced & limitless control** over your discord server, ~~*plus* we get something to spare on premium plans~~. 😜 ## Keys {% hint style="info" %} **Information** Information and notes will be displayed in large blue boxes like this. {% endhint %} {% hint style="warning" %} **Warning** Warnings will be displayed in large orange boxes such as this. {% endhint %} {% hint style="danger" %} **Danger** Well known mistakes and frequently occuring accidents will be displayed in large red boxes, similar to this one. {% endhint %} {% hint style="success" %} **ProTips** You better learn them! Tips given by professionals for professionals™. {% endhint %} These keys will be useful **throughout** the documentation, better to know them before hand! *Let's get started knowing more about Nyaru!* # Invite Nyaru! The very first step is inviting Nyaru 💖 to use her in your server! Learn how. Inviting Nyaru, is super easy - as you might have thought. In this section, we will guide you giving appropriate permissions while inviting, some recommended behavious etc. Let's dig deep into it. {% hint style="success" %} ### Invite Link for inviting Nyaru: {% endhint %} While you invite with the above link - you might have stuck across this page:
Invite Page For Nyaru
### Invitation Steps * Now you see, it asks permissions to create slash commands, so go ahead and select the server where you want to invite Nyaru. {% hint style="warning" %} *As per recent update from Discord, From April 2022, Slash commands will only available way to interact with bots. This is why we are asking permissions to slash commands - it's all normal. Learn more* [*here*](https://support-dev.discord.com/hc/en-us/articles/4404772028055-Message-Content-Access-Deprecation-for-Verified-Bots)*.* {% endhint %} * Now, in the next page, the prompt asks you for various permissions you want to opt in. **In ideal cases, Administrative permissions is okay for proper functioning of bot**. However, for your convience, we provided all permissions you want to opt in or out. Select accordingly - and hit the **Authorize** button. ![Authorize Permissions for Nyaru.](/files/-MglPCLfH16Aamy0Gv_E) Once done, you might be greeted with a captcha - and after: ![Nyaru is invited successfully!](/files/-MglPSIxQ9BL_lYDJzGy) #### 🎉 You have successfully invited Nyaru to your server! Now you can rock with Nyaru in your very own discord server! {% embed url="" %} Getting excited!? {% endembed %} There's much more to do, excited!? Follow me up! # Changelog All patch notes and changelogs for Nyaru, for the past, present, and future. Versions are listed in reverse chronological order. ## Version 5 \[NEW] ### v5.0.0 — 2025-01-18 \[Latest Major Release] Buckle up, buttercup! Nyaru has received a MEGA overhaul, and we're thrilled to present v5.0.0 – packed with new features, improvements, and a whole lot of love. This is our biggest update yet, so let's dive right in! #### Core Features * **Leveling Module Reborn:** The leveling module is back and better than ever! This all-in-one package provides everything you need for a robust Discord leveling system, including: * Level leaderboards to showcase your server's top grinders. * Visually appealing level cards to display user progress. * Automatic level roles to reward users for their dedication. * **Introducing the Cases System:** Nyaru now features a comprehensive moderation cases system. Every moderation action (kick, ban, timeout, etc.) is now meticulously tracked with in-depth information, including a unique case ID, the action performed, the victim, the moderator, and the reason. This allows for integral logging of all cases, provided you set up a logging channel using `/setchannel type:Logs Channel`. This is a game-changer for server moderation and accountability! * **Multi-Lingual Foundation:** We've laid the foundation for multi-lingual support! While only English is currently supported, Nyaru's architecture has been revamped to easily accommodate new languages in the future. Stay tuned for more language support coming soon! #### New Commands * **Giveaways Manager — Now with Drop Giveaways!** The Giveaway Manager has received a major upgrade, making it easier than ever to create both simple and advanced giveaways. Use `gstart` for quick giveaways or `gcreate` for highly customized events. Advanced options include: * Combining multiple conditions, such as message and role requirements. * Perks like bonus entries and bypass roles. * Role whitelisting and blacklisting. * Conditional checks (requiring all conditions to be met or any of them). * Bonus entry stacking. > And now, we're introducing **Drop Giveaways!** These rapid-fire giveaways end as soon as all eligible users react, creating a fun "first come, first served" experience. You can even combine drop giveaways with the other advanced giveaway features! * **Moderation Commands Expanded:** We've expanded our moderation arsenal with new commands, including `slowmode`. All moderation commands have been enhanced with improved error handling and integration with the new cases system. * **New Fun Commands:** Spice up your server with these fun new commands: * `coinflip` (for a classic heads or tails). * `choose` (to settle those tough decisions). * `roll` (for a virtual dice roll). * **Slash Commands Everywhere!** All commands are now available as both legacy (prefix-based) commands and slash commands. Use whichever you prefer! #### Improvements and Bug Fixes * **Enhanced Command UI and Error Handling:** We've overhauled the command UI for all commands, providing more detailed error messages and even self-correcting some common mistakes to better understand your intentions. * **Help Command Overhaul:** The `help` command has been significantly improved with more descriptive command descriptions, usage examples, and clear permission handling information for both users and Nyaru. We're also working on bringing slash commands to DMs! * **Better User Accessibility:** We've improved how Nyaru handles user mentions, making it easier to mention users using replies, tags, or usernames. We want Nyaru to work *for* you, not the other way around! * **General Bug Fixes:** Numerous bug fixes have been implemented across existing commands, improving overall stability and performance. * **Increased Kick Reason Character Limit:** The maximum character limit for moderation reasons has been increased from 40 to 60. #### Other * **Documentation Support:** We've added documentation support and are working hard to complete the official Nyaru documentation as soon as possible. In the meantime, the improved `help` command should provide ample assistance. *** ## Version 4 ### v4.2.0 — 2023-06-04 It's been a long time since we have updated you about Nyaru. There were many small updates to fix security issues and bugs meanwhile till today, but this time we have something big to actually let you know! #### New Features * Added **Welcome DM** feature. You can easily enable or disable Welcome DMs anytime just by using `welcomedm (enable|disable)` command. * Added **Leveling Module (NEW)**, our brand-new release which offers an enhanced levelling experience for everyone in your server! * Use `level` command to check your level in our new level cards. * Added **leveling leaderboard** with rank systems! * You can set up level up channels easily! * You can `set` / `reset` individual or guild's levels easily. * There are more admin management commands for the leveling module! * Added **Advanced Filtering**. Spam and flood messages are filtered, repeated messages are also filtered, and small messages are ignored and much more! This enhances the use of messaging module and leveling module! * You can now set message counts of individual users. * The **Leaderboard** has been updated for both message and leveling module. * And more features! #### Bug Fixes * The **Set Channel** command (`setchannel`) now accepts **welcome** channel correctly. * Some other bug fixes. The *Leveling Module* is currently in **BETA!** We do not recommend you to completely replace the leveling system with Nyaru's in your server yet! This update took a long time, we hope you like it. Please update us if you see any bugs! ### v4.1.9 — 2023-04-15 #### Bug Fixes * Our CDN is back live! All role-play commands should be working again with no issues (e.g., wave, hug, kiss, etc.). ### v4.1.7 — 2023-03-05 #### Bug Fixes * The “bonus entries” option in `/giveaways create` was causing problems when multiple roles were used. * Performed several internal changes to optimize processes. ### v4.1.6 — 2022-03-11 After a long time, we're here to release amazing features for Nyaru! #### Bug Fixes * Giveaway Reactions: The role requirement bypass was not working. * Giveaway Reroll: Invalid numbers for winner count fixed. #### New Features * **Timeout Command:** You can now use the timeout command with a custom duration! Providing a reason is mandatory. Example: `/timeout @user 5m testing reason` * **Slowmode Command:** Get more control over your chat by setting slowmode with this command! Example: `/slowmode 2s`. You can specify another channel and be anonymous when used: `/slowmode 2s #silence` * **Logs Channel:** You can now set a logs channel for our moderation commands (currently slowmode and timeout). To set a logs channel, use the `.setchannel logs` command with the name of the channel where you want to receive logs. Example: `.setchannel logs #mylogs` * **Added Case Information:** Case information can now be viewed in the previously configured logs channels. These cases currently work for the `/timeout` command. ### v4.1.3 — 2022-05-22 #### Bug Fixes * The configured prefix was being cleared intermittently, affecting usability for some users. #### New Features * **Giveaway Reroll:** If the winner count is not explicitly mentioned, one winner will be automatically drawn. Example: `greroll message_id [count]` * **Giveaway Create:** Now supports multiple timestamps with real-time validation. For example, `2w 1d` will be automatically parsed into 15 days in `/giveaway create duration:[]`. * **Help Command:** Added the `-chat` flag, which performs the same function as the `-c` flag. ### v4.1.0 — 2022-01-05 It's been a long time since we have updated you about Nyaru. There were many small updates to fix security issues and bugs meanwhile till today. This time, we have something big to actually let you know! #### New Features * **Message Tracking Module:** We have finally released the first phase of message tracking. *FYI — this is just a start*, we will make many more improvements in the coming weeks. New functionalities include `/messages`, `/messages leaderboard`, and `smc` (set message count). * **Message x Giveaway Integration:** After initial testing, everything seems perfect! You can now set a new `message count` when creating a giveaway using `/giveaway create`. #### Improvements * **Giveaway Module Revamp:** The entire giveaway manager is now in slash commands! You can easily end, list, and create **advanced** giveaways directly without remembering any commands. It's all `/giveaway` now! * Many more bug fixes! The mass reset message feature (which was initially missing) has now been added. We are aware that `/giveaway create`'s multiple duration timestamps do not work (e.g., `1d 1h 1m 1s`). However, you can use a single, converted timestamp (e.g., `25h`) for now. We will take and implement community feedback! ### v4.0.9 — 2021-11-21 #### New Features * Added top.gg stats. The server count is now available on the top.gg page. * Added command: `checkvote`. Now you can check if you have voted for Nyaru on top.gg. #### Bug Fixes * Fixed buttons interaction bugs. * Fixed some interaction commands. ### v4.0.7 — 2021-11-03 #### Improvements and Bug Fixes * Addressed all known bugs in the music module. * Implemented several other optimization fixes. ### v4.0.6 — 2021-10-20 #### Improvements and Bug Fixes * Addressed more bugs in the music module. #### Removed Features * Welcome DMs have been removed. This feature was being used primarily for advertisements (which violated the terms of service). ### v4.0.3 — 2021-10-10 #### Improvements and Bug Fixes * Addressed bugs in the music module. * Addressed bugs in the command manager. We're approaching 1000 servers! Thank you for the support! :) ### v4.0.1 — 2021-10-07 #### New Features * Added the `disconnect` command to the music module, per popular demand. #### Improvements and Bug Fixes * The `shy` command is now functional again. * Minor fixes to the `gcreate`, `loop`, and `forceskip` commands. * Various other fixes to the music module. * Improved command performance (reduced lag). * Reduced overall memory usage. ### v4.0.0 — 2021-10-04 \[Major Release] #### New Features * **Music:** * Stage channel support has been added. * Added the `lyrics` command (for the current song). * Added the `autoplay` feature/command for recommendations. * Added a `pruning` option/setting to automatically prune music embeds. * **Starboards:** * Enjoy the brand-new starboards module! This module is still in **beta** and under development. It is expected to be completed by v4.1.0. * You can set a starboard channel and threshold. * **Giveaways:** * Multiple bonus entries are now supported. * Role requirements have been implemented. * Dynamic giveaway options, such as entry stacking and all role requirements, are available. * Bypass entries have also been rolled out, allowing users (such as boosters) to bypass giveaway requirements. * An all-in-one giveaway manager is now available to easily control your server's giveaways. * **Action Commands:** * New action commands have been added: `boop`, `shy`, `wave`, and `sad`. * Existing action commands have been significantly improved. Actions now support arguments without mentions or IDs. * All action commands now have counters, so you can see how many times you have been hugged, etc. * New GIFs have been added to Nyaru's database. * Modules and flags are officially implemented and supported. * Brand-new slash commands have been added for the music module and some other modules. * Added the `roleinfo` command. * **Command Manager:** You can now enable/disable commands. This feature can be accessed by server managers with `MANAGE_GUILD` permissions. #### Removed Features * The `gedit` command has been temporarily disabled and is currently being reworked. It will be available again soon. #### Other Improvements and Bug Fixes * The `help` command has been updated for maximum efficiency. * Music commands now use buttons instead of reactions. * You can now remove configured channels, such as leave/welcome channels. * Giveaways no longer edit messages to update the time; they now use Discord's built-in timestamps. * The `userinfo` and `serverinfo` commands now function as intended. * The channel configuration manager (`setchannel`) is now fully functional. * Dream Economy has been officially released. * Resolved all known crashes due to permission errors. * All automation commands now function correctly and can be disabled. * DM interactions are now fully supported; you can now command Nyaru in DMs. * Command usage and descriptions have been redefined for clarity. * All commands now include in-command documentation with a help documentation button. *** ## Version 3 ### v3.4.0 — 2021-08-04 #### New Features * Added a new Advanced Purge Module. * Added partial documentation support. * Re-categorized all commands. #### Other Improvements and Bug Fixes * Addressed over 50 bugs. * Improved the `help` command. ### v3.3.0 — 2021-07-28 #### New Features * Added the `userinfo` command. * Introduced a new flag system to improve user experience. Flags are additional advanced arguments found at the end of a message, starting with `--`. Each flag has its own purpose and use. #### Other Improvements and Bug Fixes * Addressed over 69 bugs. * Improved the `help` command. ### v3.2.0 — 2021-06-22 #### New Features * The music module has been re-added (BETA). It now supports SoundCloud, Spotify, and YouTube. #### Other Improvements and Bug Fixes * Addressed some bugs. ### v3.1.5 — 2021-06-22 #### New Features * Added a beta leveling system. #### Other Improvements and Bug Fixes * Addressed all known bugs. ### v3.1.1 — 2021-06-21 #### New Features * Added the `glist` command, which displays ongoing giveaways (BETA). #### Other Improvements and Bug Fixes * Addressed some additional bugs. ### v3.1.0 — 2021-06-14 #### Other Improvements and Bug Fixes * Addressed almost all bugs in the music module. * Updated some private commands. * Updated emojis. * Addressed some other command bugs. ### v3.0.8 — 2021-06-06 #### New Features * Added the `avembed` command — Advanced Embed uses JSON to send embeds of any type! #### Other Improvements and Bug Fixes * Addressed some bugs in the Music Module. ### v3.0.5 — 2021-06-06 #### New Features * Added the `serverinfo` command. * Implemented button usage in some commands. * Added a greet message on joining a server. * The `greroll` command can now reroll specific winners. #### Other Improvements and Bug Fixes * Added case-insensitivity, so `@Nyaru` will now respond to both `D!` and `d!` as prefixes. * Improved the `help` command. * Addressed other bug fixes. ### v3.0.2 — 2021-06-01 #### New Features * Giveaway Module (Fixed) * Music Module (Partial Fixed) * New Fun commands: hug, kill, neko, pat, slap, tickle, kill. * New avatar command! * New Moderation Commands (BETA) #### Other Improvements and Bug Fixes * It is still a beta release. Expect some downtimes, but going all good for future :) * Added case insensitivity, so @Nyaru will now listen both D! and d! as prefix (MOST WANTED ) * Help command and other bug fixes! ### v3.0.0 — 2021-05-31 \[First Major Release] #### New Features * Giveaway Module * Music Module * Welcome DMs * Welcome/Goodbye Messages * New Fun commands * New Moderation Commands (BETA) #### Removed Features * Lock/Unlock command * Staff Applications Module * Animesearch command #### Other Improvements and Bug Fixes * Welcome the brand new @Nyaru! * We've given our cute catgirl a new profile picture and a mega update! *** ## Version 2 ### v2.0.0 — 2021-04-15 \[First Minor Release] Version 2.0.0 represented a significant step forward in the Nyaru's development. This release established the core functionalities and provided users with an initial set of features and a stable foundation for future expansion. It included the initial release of basic Nyaru functionality and a basic command handling system. *** ## Version 1 ### v1.0.0 — 2021-01-18 \[First Release] Version 1.0.0 marked the beginning of the Nyaru's development. This initial phase concentrated on establishing the basic framework and infrastructure necessary for the Nyaru to function. It included the initial development and testing phase, establishing the basic Nyaru framework. You have made it till the end :tada: # FAQs Here are some frequently asked questions with their answers for quick assistance. If you don’t know how to use a command or module, you can run `@Nyaru help [commandname | modulename]` and Nyaru will help you out with that command or module. Help text usually covers out everything in short, and more detailed knowledge about the command is available in the documentation. {% hint style="info" %} Can’t find the answer you’re looking for? Have a feature request? Let us know in our [community server](https://go.nyaru.xyz). {% endhint %} ## How To Invite Nyaru? {% content-ref url="/pages/-MgkUC\_P8wUmYzPXjQoz" %} [Invite Nyaru!](/invite) {% endcontent-ref %} ## How To Use Nyaru? We have a seperate detailed page on how to use nyaru, how commands are processed, command flags and much more right over [here](/introduction/usage). Detailed documentation of modules is available [here](/introduction/modules), and respective commands are available in their respective section under their categories. ## How long is dashboard coming? > 👀 s00n™ ## Is Nyaru angry with me? Why isn’t she responding? It depends on the situation, you need to troubleshoot on what went wrong! ### Is Nyaru Online? 1. If Nyaru is online and not responding to you, most common reason is **inappropriate permissions**. Nyaru need *at least* `Send Messages`, `View Channel` and `Embed Links` permission to interact with you. 2. Try mentioning her by `@Nyaru`. Did you get a *pop'in up* response? If yes, bot is working alright! You may be using wrong [prefix](/settings/prefix). 3. Is the command or module enabled? Check out in the dashboard! ### Is Nyaru Offline? Check out if there's a server outage. Is Nyaru online in other servers - or just dead completely? Our [*support server*](https://go.nyaru.xyz/discord) at the rescue! #### Last case, but not the least... This is unlikely to happen anytime, unless you decided to break [terms of service](https://go.nyaru.xyz/tos). If you have broken [Nyaru's Terms of Service](https://go.nyaru.xyz/tos), or [Discord's Terms of Service](https://discord.com/terms), you might got blocked by her. You can know more *(if that's your case)* in our [support server](https://go.nyaru.xyz/discord). ## Premium Related FAQs ### How can I get premium? You can know more about premium in our premium page. {% content-ref url="/pages/-MfvB4lRoQpTOfnqx-PI" %} [Premium](/introduction/premium) {% endcontent-ref %} ## Is Nyaru Open Source? No. But, you want your own custom version of Nyaru? Scroll down in [premium section](/introduction/premium) to know more! ## There was a problem running this command.. *An unexpected error has occurred during the execution of the command....* If, that's your case... 😐 It means something went wrong in executing the command *(not your fault).* But, **please let us know** in our [support server](https://go.nyaru.xyz/discord)! Sit tight, and we will work on the fix. ## Some more command-related FAQs... ### Purge isn't working as expected with messages older than 14 days, what does that mean? *Limitation of discord bots.* Discord doesn’t allow bots to purge (bulk delete) messages that are older than 14 days old. If in near future, discord changes their API to support this feature, we will drag it right in! ### There aren't any more FAQs? At the moment, no! You reached the end of FAQs. Still got a doubt? * Try using 🔍 `Search` feature over top-right of this page. Maybe you find what you are looking for? {% hint style="success" %} **ProTip:** *Try to use short sentences, or just words to search out specific topics*. For example, if you are looking `how to purge messages in a channel`, search `purge` instead. {% endhint %} * No luck? No worries! Join us over [here](https://go.nyaru.xyz/discord/). # Modules Modules represents a group of command (or categories), each having specific and unique functions. This includes Automation, Moderation, Giveaways, Music and much more! ## Automation **Automation** module covers up all server trigger related commands, like [welcome messages](/automation/welcomemessage), [welcome DMs](/automation/welcomedm), [leave messages](/automation/leavemessage) etc. You can customize these events at your own creativity via [dashboard](https://go.nyaru.xyz/dashboard) or commands. | Command | Description | | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [welcomedm](/automation/welcomedm) | Whenever someone joins the server, I will DM them this welcome message automatically. | | [welcomemessage](/automation/welcomemessage) | 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) | 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) | I can ban someone using this command, for you. | | [unban](/moderation/unban) | I can unban someone using this command, for you. | | [purge](/moderation/purge) | A command you can use to clear messages in bulk from a channel using different filters. | | [kick](/moderation/kick) | I can kick someone using this command, for you. | | [nuke](/moderation/nuke) | 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) | You can ask me to pin any message :) | | [unpin](/moderation/unpin) | 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) | Create and start a giveaway with a wizard, asking you for all options one by one. | | [gstart](/giveaways/gstart) | Start a giveaway in the server. | | [greroll](/giveaways/greroll) | Reroll an ended giveaway. | | [gedit](/giveaways/gedit) | Edit an on-going giveaway with ease to change requirements, winners etc. | | [glist](/giveaways/glist) | Lists out list of all giveaways in the channel. | | [gend](/giveaways/gend) | 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) | Plays audio from YouTube, Spotify or Souncloud | | [pause](/music/pause) | Pause the currently playing music. | | [resume](/music/resume) | Resume the current paused song | | [search](/music/search) | Search and select videos to play. | | [skip](/music/skip) | Skip a song. | | [queue](/music/queue) | Show current playlist. | | [stop](/music/stop) | Stop and clear the current queue. | | [shuffle](/music/shuffle) | Shuffle queue. | | [remove](/music/remove) | Remove song from the queue. | | [nowplaying](/music/nowplaying) | Show song name playing now. | | [loop](/music/loop) | 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) | This commands shows detailed server information to you. | | [userinfo](/informational/userinfo) | Get the info of tagged users or your own info. | | [avatar](/informational/avatar) | Find enlarged avatar of someone, with links! | | [about](/informational/about) | Gives you some info about the bot! | | [dpbal](/informational/dpbal) | 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. | Command | Description | | ------------------------- | ----------------------------------------------------------------------------------------- | | [ping](/utility/ping) | Um, you want to know? It shows my latency. | | [help](/utility/help) | Help command shows all valid commands for you to interact with me. | | [invite](/utility/invite) | Gives you the invite link to invite me in your server, my support server and our website. | | [embed](/utility/embed) | Create a stylish embed using a interactive setup, and send to any channel. | | [poll](/utility/poll) | I can create a poll for you! Seperate Question and choices using `\|`! | | [say](/utility/say) | I will repeat what you say. | | [edit](/utility/edit) | 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) | Set your server prefix with this command! | # Premium Upgrading to Nyaru Premium™ helps support the development and future of Nyaru, as well as providing you with more flexible service and features. Thank you for the support! 💖 While we completely work on Dashboard and other modules in Nyaru, we are not releasing Nyaru Premium™. s00n™ # How To Use? Processing commands, arguments, flags and much more to learn here. Recommended to read this page before reading the documentation. Throughout our documentation and when asking for help on our official server, you will run into many different kinds of notations (or say terms). To help you understand the texts that you read, in this guide, we will be going over some standard notations, understanding how commands work, proper usage of commands and much more! ## Proper Usage of commands In our help message, documentation or anywhere you ask help, you might see that we enclose variables in some weird brackets, sometimes `<>`, sometimes `[]`... But what do they mean? Basically, they tell you how to use those command arguments in your message. Let's learn the meanings, with an example: ``` @Nyaru ban [reason] [flags] ``` ### **Required Arguments** All usage variables enclosed in `<>` are actually required arguments. If a usage says ``, that means the text argument is required in order for command to work. \ \ In the above example, Mentioning the user or providing their user id is an required argument for the command in order to work, or simply the command will fail to work with an error message. ### **Optional Arguments** All usage variables enclosed in `[]` are actually optional arguments. Command functionality will not break if you don't supply these arguments.\ \ In the above example, supplying a reason for the ban is optional, since the member can also be banned without a reason. Similar case with flags. ### **Conditional Arguments** All usage variables enclosed in `()` are actually conditional arguments. As the name suggests, the requirement of those argument is always conditional based on the situation. For an instance, you can find them in `purge` command: ``` @Nyaru purge (count) (sub-command) (search value) [flags] ``` If, you want a normal purge, **count** is a **required** argument, without count bot can not purge random amount of messages. \ In another case, if you want filters in your purge, you are going to use a sub-command where **count** is an **optional argument**. You may or may not need the amount of messages you want to filter if you are using a sub command. ### **Configuration Arguments** All usage variables enclosed in `{}` are actually configuration based conditional arguments. You may see the usage of conditional arguments in [Welcome DMs](/automation/welcomedm) command, etc. Basically, the usage of this command is required if you want to change data, and not required if you want to check current data. It is again a conditional argument, but based on configuration.\ \ If you use `welcomedm` command without arguments, ``` @Nyaru welcomedm ``` It is not going to break the command. This will show that if any welcome DMs are setup on your server or not - and if yes, it will show you the current welcome DM configuration. If you want to change or create welcome DMs for your server, you can simply: ``` @Nyaru welcomedm Hey, {{user}}. Welcome to our shiny server! ``` Now, your new welcome DMs are setup! Easy enough? ### Or Operator `|` You might have saw the sign `|` in documentation or in usage/help command. What does it mean? The sign `|` is called **Or Operator**. A simple - and easy to understand meaning of this operator is either this **or** this. Confused? Jump right over [here](/introduction/usage#proper-usage-of-commands) again to see the use of the operator. ## How commands work? When you trigger a command, Nyaru breaks your command message into command arguments and flags - and then act accordingly to her best intelligence. Anything you send without starting with command prefix, our mentioning Nyaru will not be considered as a command. Let's learn more about arguments, flags, triggers and much more. Your entire command to bot is called as **command message**. Consider the following example: ``` @Nyaru ban @Lumi being naughty so much -dm ``` *Commands are broken into 3 parts over here:* 1. **Prefix**: `@Nyaru` is your prefix here. You can also use your server prefix as per your convience, default prefix is `d!`. 2. **Arguments**: `ban @Lumi being naughty so much` are destructured as **command arguments**. 3. **Flags**: `-dm` is **command flag**. In the above example, you might have guessed - arguments are further more broken into sub-arguments, that is basically **command syntax** or **command usage**. * The triggered command is `ban`, * `@Lumi` is the victim who is going to be banned, * `being naughty so much` is the reason of the ban. And lastly, the **command flags**. * `-dm` will DM the victim before banning. An important observation over here is that command **flags** and command **arguments** are both different things. {% hint style="success" %} **ProTip**: It seems to be difficult to understand, but actually it isn't. You will get used to the syntax as you use Nyaru. Using message flags seperataly rather than command arguments provide more flexiblitiy to various commands. {% endhint %} ### Command Arguments As above, anything after the prefix and before message flags are called command arguments. Command arguments are seperated by spaces. ### Command Flags Command flags is an advanced feature in Nyaru, that is used in various commands to deliver various options, but they are different than command arguments - independent. #### How command flags are destructured? Bot will look all flags from the end of your command message. Any flag in between your command message is usually not considered as a flag. It is taken and considered as a command argument. Take a look at the example - ``` @Nyaru purge 69 bots -force ``` A very extensive example of [purge](/moderation/purge) command, using [bots](/moderation/purge/bots) sub-command option and a message flag `force`! Let's understand now, how Nyaru will react on this command. 1. From your command arguments, Nyaru received the command `purge`. 2. You specified your count `69`, the second argument, 3. Nyaru will now trigger `bots` sub-command and filter messages that are sent by bot accounts.\ By default, Nyaru also filter pinned messages, so you don't loose them - but, you used `force` flag. 4. Because you used `force` flag, now Nyaru will also delete pinned messages forcefully. And, that's how - Nyaru fetches last 69 messages and killed all messages sent by bots. {% hint style="info" %} We understand things can be confusing, but humans can not! (At least our support staff) - Just hit up us in our [community server](https://go.nyaru.xyz) for help. {% endhint %} # Soon™ We're making it super easy for you. Guess you know. s00n™ # WelcomeDm > Whenever someone joins the server, I will DM them this welcome message automatically. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # WelcomeMessage > 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. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # LeaveMessage > 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. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Soon™ # Ban Ban a member from your server. > I can ban someone using this command, for you. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Kick > I can kick someone using this command, for you. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Nuke > Clones the current channel and makes a new channel on same position and same permissions. Post deletes the channel the command was executed in. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Purge Bulk Delete an amount of messages from a channel. > With the `@Nyaru purge` command, you can delete a number of messages from a channel. You can use different filters/options to specify what type of messages you want to remove from the channel. {% tabs %} {% tab title="Aliases" %} `pg`, `bulkdelete`, `clear` {% endtab %} {% tab title="Flags" %} * `-force` - Force [flag](/introduction/usage#flags) allows you to force purge the required messages, instead of filtering pinned messages **(This will force to delete pinned messages as well)**. Learn more about flags [here](/introduction/usage#flags). {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} * `MANAGE_MESSAGES`: The discord user running the command should have at least this permission in the command channel. {% endtab %} {% tab title="Requirements" %} * `READ_MESSAGES`: Bot should be able to read messages to listen your command! * `READ_MESSAGE_HISTORY`: Bot should be able to read message history to fetch and purge them. * `EMBED_LINKS`: Bot will provide command output in the embed. * `MANAGE_MESSAGES`: Bot should have permissions to manage messages in the command channel to delete messages. {% endtab %} {% endtabs %} {% hint style="warning" %} You can **only** delete upto **100** messages *maximum* per execution, and you **cannot** purge messages **older** than **14 days**. [Learn more](/introduction/faqs#purge-isnt-working-as-expected-with-messages-older-than-14-days-what-does-that-mean). {% endhint %} ## Usage ``` @Nyaru purge (count) (option) (search arguments) ``` ### Examples * Purge last **69** messages, **excluding** channel pins: > @Nyaru purge 69 * Purge last **100** messages, **including** channel pins: > @Nyaru purge 100 -force {% hint style="danger" %} In above examples, purge count/amount is **required** argument, however the flag is *optional*. {% endhint %} ## Sub Commands Purge filters can help you specify and clean **specific** type of messages (to your desire). Some cases where you can use these sub commands: * You want to clear messages which **includes** text `hell`, * You want to clear all bot messages *(upto last 100 messages)*, * You want to clear all **attachment** messages, * You want to clear all messages **not including** text `noob`, and much more - we have got it covered for you. | Sub Command | Description | | -------------------------------------------- | ---------------------------------------------------------- | | [bots](/moderation/purge/bots) | Purge messages sent by **bots**. | | [humans](/moderation/purge/humans) | Purge messages sent by **humans**. | | [links (WIP)](/moderation/purge/links) | Purge messages containing any **link(s)**. | | [attachments](/moderation/purge/attachments) | Purge messages containing any **attachment(s)**. | | [mentions](/moderation/purge/mentions) | Purge messages containing **user** or **role mention(s)**. | | [embeds (WIP)](/moderation/purge/embeds) | Purge messages containing **embed(s)**. | | [includes](/moderation/purge/includes) | Purge messages **including** the given text. | | [not](/moderation/purge/not) | Purge messages **not including** the given text. | | [startswith](/moderation/purge/startswith) | Purge messages **starting with** given text. | | [endswith](/moderation/purge/endswith) | Purge messages **ending with** given text. | | [user](/moderation/purge/user) | Purge messages sent by a **specific user/bot account**. | {% hint style="info" %} **You can click on the respective sub-command to jump to detailed documentation with usage and examples of that specific sub-command.** {% endhint %} # Bots Purge messages sent by bots. ## Usage ``` @Nyaru purge [count] bots ``` ## Examples * Purge all messages sent by bots in last **50** messages > @Nyaru purge 50 bots * Purge **all** messages sent by bots > @Nyaru purge bots {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} # Humans Purge messages sent by humans. ## Usage ``` @Nyaru purge [count] humans ``` ## Examples * Purge all messages sent by humans in last **20** messages > @Nyaru purge 20 humans * Purge **all** messages sent by humans > @Nyaru purge humans {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} # Links Purge messages containing any link(s). ## Usage ``` @Nyaru purge [count] links ``` ## Examples * Purge messages *having links* in last **60** messages. > @Nyaru purge 60 links * Purge **all** messages having *links*. > @Nyaru purge links {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} # Attachments Purge messages containing any attachment(s). ## Usage ``` @Nyaru purge [count] attachments ``` ## Examples * Purge messages *having attachments* in last **10** messages. > @Nyaru purge 10 attachments * Purge **all** messages having *attachments*. > @Nyaru purge attachments {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} # Mentions Purge messages containing user or role mention(s). ## Usage ``` @Nyaru purge [count] mentions ``` ## Examples * Purge messages *having any role or user mention* in last **20** messages. > @Nyaru purge 20 mentions * Purge **all** messages having *any role or user mention*. > @Nyaru purge mentions {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} # Embeds Purge messages containing embed(s). ## Usage ``` @Nyaru purge [count] embeds ``` ## Examples * Purge messages *having embeds* in last **15** messages. > @Nyaru purge 15 embeds * Purge all messages having *embeds*. > @Nyaru purge embeds {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} # Includes Purge messages including the given text. ## Usage ``` @Nyaru purge [count] includes ``` ## Examples * Purge messages containing text `Lumi is dumb` in last **25** messages > @Nyaru purge 25 includes Lumi is dumb The above example will fetch last **25** messages in the channel and check if the message content or message text **contains** your search arguments, i.e., `Lumi is dumb`, filter them and then **purges** it. {% hint style="danger" %} **Search arguments are case sensitive!** This means `Lumi is dumb` is NOT same as `LUMI is DuMb`. Learn more about case senstivity [here](https://en.wikipedia.org/wiki/Case_sensitivity). {% endhint %} Take a look at the other example, * Purge **all** messages *containing* text `Meowryy` > @Nyaru purge includes Meowryy {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} As of the above example, bot will search the text `Meowryy` in last **100** messages of the channel and **purge** them. Looks awesome? There's **much more**. # Not Purge messages not including the given text. ## Usage ``` @Nyaru purge [count] not ``` ## Examples * Purge messages **NOT** *containing* text `Lumi is my bestie` in last **20** messages > @Nyaru purge 20 not Lumi is my bestie The above example will fetch last **20** messages in the channel and check if the message content or message text **does not** *contains* your search arguments, i.e., `Lumi is my bestie`, filter them and then **purges** it. {% hint style="danger" %} **Search arguments are case sensitive!** This means `Lumi is my bestie` is NOT same as `LUMI is MY bestie`. Learn more about case senstivity [here](https://en.wikipedia.org/wiki/Case_sensitivity). {% endhint %} Take a look at the other example, * Purge all messages **not** *containing* text `Meowryy dumbo` > @Nyaru purge not Meowryy dumbo {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} As of the above example, bot will search the text `Meowryy dumbo` in last **100** messages of the channel and filter them with all other messages, so they are *saved* and rest all is **purged**. # Startswith Purge messages starting with given text. ## Usage ``` @Nyaru purge [count] startswith ``` ## Examples * Purge messages containing text `Meowry` *in **start** of the message* in last **10** messages > @Nyaru purge 10 startswith Meowry The above example will fetch last **10** messages in the channel and check if the message content or message text **starts with** your search arguments, i.e., `Meowry`, filter them and then **purges** it. {% hint style="danger" %} **Search arguments are case sensitive!** This means `Meowry` is NOT same as `MEOWRY`. Learn more about case senstivity [here](https://en.wikipedia.org/wiki/Case_sensitivity). {% endhint %} Take a look at the other example, * Purge **all** messages *starting with* text `Lumi dumbo` > @Nyaru purge startswith Lumi dumbo {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} As of the above example, bot will search the text `Lumi dumbo` in last **100** messages of the channel and check if each message *starts with* the your search argument, if it does, it will be **purged**! # Endswith Purge messages ending with given text. ## Usage ``` @Nyaru purge [count] endswith ``` ## Examples * Purge messages containing text `Cutie` *in **end** of the message* in last **10** messages > @Nyaru purge 10 endswith Cutie The above example will fetch last **10** messages in the channel and check if the message content or message text ***ends** with* your search arguments, i.e., `Cutie`, filter them and then **purges** it. {% hint style="danger" %} **Search arguments are case sensitive!** This means `Cutie` is NOT same as `CUTIE`. Learn more about case senstivity [here](https://en.wikipedia.org/wiki/Case_sensitivity). {% endhint %} Take a look at the other example, * Purge all messages *ending with* text `dumbo` > @Nyaru purge endswith dumbo {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} As of the above example, bot will search the text `dumbo` in last **100** messages of the channel and check if each message *ends with* the your search argument, if it does, it will be **purged**! # User Purge messages sent by a specific user/bot account. ## Usage ``` @Nyaru purge [count] <@User Mention | User ID> ``` ## Examples * Purge messages sent by `@Meowry` in last **50** messages. > @Nyaru purge 50 @Meowry Alternatively, if you don't want to *mention* the user, you can use their **user ID** as well. > @Nyaru purge 50 858392770565373992 {% hint style="info" %} **Learn more on how to get user ID of a discord user** [**here**](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-)**.** {% endhint %} Both of the above examples will fetch last **50** messages in the command channel and **purge** them if it is *sent by Meowry*! * Purge **all** messages sent by `@Lumi` > @Nyaru purge @Lumi And again, > @Nyaru purge 844176873335423046 Will also work as charm! {% hint style="warning" %} If you don't provide count, bot will index last **100** messages and filter them by default. {% endhint %} # 🔨 Unban > I can unban someone using this command, for you. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # 📌 Unpin > You can ask me to unpin any message :) {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Pin > You can ask me to pin any message :) {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # create Create a giveaway with all advanced option using an interactive giveaway wizard. > The interactive wizard offers you a series of choices in form of an interactive wizard to fill up all giveaway properties such as giveaway prize, winner, duration or required roles. It is a simpler method than using a slash command, but both have same functionality. {% tabs %} {% tab title="Aliases" %} giveawaycreate, giveawaywizard, gwcreate, gwwizard {% endtab %} {% tab title="Cooldown" %} 30 seconds {% endtab %} {% tab title="Permissions" %} * `MANAGE_SERVER:` The discord user running the command should have at least this permission in the giveaway server. {% endtab %} {% tab title="Requirements" %} * `VIEW_CHANNEL:` Nyaru should be able to view the giveaway channel. * `SEND_MESSAGES:` Nyaru should be able to send the giveaway message. * `EMBED_LINKS:` Nyaru should be able to send giveaway embeds in the giveaway channel. * `MANAGE_MESSAGES:` Nyaru should have this permission to control giveaway reactions. {% endtab %} {% endtabs %} {% hint style="warning" %} During the giveaway wizard (`@Nyaru gcreate`), you need to communicate with Nyaru using messages in the same channel. To provide valid values, you're given 3 attempts with the respective error message to provide the correct value. {% endhint %} ## Usage `@Nyaru gcreate` `/giveaway create (options)` ## Giveaway Options
OptionDescriptionExample
Channel*Provide the giveaway channel or channel ID where the giveaway should be hosted.
  • #channel
  • channelId
Prize*Provide the giveaway prize. Ensure the prize character limit is 100.
  • Nitro Basic
Duration*Provide the giveaway duration. Ensure the duration is between 30 seconds and 1 year.
  • 10 hours
  • 1 week 2 days
WinnersProvide the number of giveaway winners. Ensure winners are less than 20.
  • 2
Messages RequiredProvide the amount of messages that are required to enter the giveaway. Maximum message limit is 10000.
  • 20
Whitelist RolesProvide the whitelist roles for the giveaway. These roles are allowed to enter without any restrictions.
  • @role1, @role2
  • roleId1 roleId2
Blacklist RolesProvide the blacklist roles for the giveaway. These roles are not allowed to enter even if they qualify for any kind of conditions.

  • @role1, @role2
  • roleId1 roleId2
Roles RequiredProvide the roles that are required to enter the giveaway. You can also set if you want to check all roles or not.

  • @role1, @role2
  • roleId1 roleId2
Roles BypassProvide the bypass roles for the giveaway. These roles are allowed to enter bypassing the conditions.

​

  • @role1, @role2
  • roleId1 roleId2
Bonus EntriesProvide the bonus entries for the giveaway. This can be used to incentivize your users having certain role to have more than 1 entries. You can also stack bonus entries with each other.
  • @role1 10, @role2 20
Drop GiveawaySet this giveaway as a drop giveaway. Learn more about drop giveaways below.Simply click the button to toggle between yes or no. For slash command, provide a boolean value (true/false).
Check All ConditionsGiveaway setting that will allow you to check all conditions of the giveaway to enter the giveaway (If both roles are messages should be checked).Simply click the button to toggle between yes or no. For slash command, provide a boolean value (true/false).
Check All RolesGiveaway setting that will allow you to check all roles required to enter the giveaway. If enabled, user must have all the roles required to enter the giveaway, otherwise user needs only one role required.Simply click the button to toggle between yes or no. For slash command, provide a boolean value (true/false).
Stack Entries
Giveaway setting that will allow you to stack all the bonus entries for the giveaway to give more advantage to certain users.Simply click the button to toggle between yes or no. For slash command, provide a boolean value (true/false).
Options marked with \* are mandatory options. We have provided the most extensive and advanced giveaway options ever so we understand this could be overwhelming. You can simply use [gstart (giveaway start)](/giveaways/gstart) command to create a simple giveaway anytime. ### Drop Giveaways Drop Giveaway is a new giveaway feature that allows you to launch rapid giveaways that will end immediately once all valid users react to the giveaway. Think of this as a "First Come First Serve" giveaway, where the first *x* winners to react to the giveaway will immediately win the giveaway. Of course, all entries are validated in real-time. If you happen to have roles required or messages required options, they will be validated on each reaction. Only if the user is allowed to enter the giveaway, will they be drawn as winners. #### Example of Drop Giveaway Scenario: Drop Giveaway with 2 winners and the messages required are set to 10. Result: First 2 people who have 10 messages that reacts to this giveaway will be drawn as winners immediately and the giveaway will end. [^1]: Refer to "Check All Roles" option. [^2]: Refer to "Stack Entries" option. # start Start a simple giveaway instantly in your server. {% tabs %} {% tab title="Aliases" %} gwstart, giveawaystart {% endtab %} {% tab title="Cooldown" %} 30 seconds {% endtab %} {% tab title="Permissions" %} * `MANAGE_SERVER:` The discord user running the command should have at least this permission in the giveaway server. {% endtab %} {% tab title="Requirements" %} * `VIEW_CHANNEL:` Nyaru should be able to view the giveaway channel. * `SEND_MESSAGES:` Nyaru should be able to send the giveaway message. * `EMBED_LINKS:` Nyaru should be able to send giveaway embeds in the giveaway channel. * `MANAGE_MESSAGES:` Nyaru should have this permission to control giveaway reactions. {% endtab %} {% endtabs %} ## Usage `@Nyaru gstart`` ``` `` `` `/giveaway start`` ``` ``` ``` ## Example `@Nyaru gstart`` ``1d` `1` `Nitro Basic` `/giveaway create`` ``duration:20h 10m` `prize:Nitro Basic` `channel:general` ## Giveaway Options ### Duration Provide the giveaway duration. Ensure the duration is between 30 seconds and 1 year. Duration can be defined as 10h (10 hours), or 20m (20 minutes) ### Winner Count Provide the number of giveaway winners. Ensure winners are less than 20. > Winner Count is only necessary in `gstart` message command and not mandatory in slash command. It defaults to 1 winner automatically. ### Giveaway Prize Provide the giveaway prize. Ensure the prize character limit is 100. ### Channel Provide the giveaway channel or channel ID where the giveaway should be hosted. > Channel is only necessary in slash command and not mandatory in normal (prefix) command. It defaults to the message channel automatically. # edit This command is currently unavailable. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # list Displays a list of all available giveaways in your server. {% tabs %} {% tab title="Aliases" %} giveawaylist, gwlist {% endtab %} {% tab title="Cooldown" %} 30 seconds {% endtab %} {% tab title="Permissions" %} * `MANAGE_SERVER:` The discord user running the command should have at least this permission in the giveaway server. {% endtab %} {% tab title="Requirements" %} * `VIEW_CHANNEL:` Nyaru should be able to view the giveaway channel. * `SEND_MESSAGES:` Nyaru should be able to send the giveaway message. * `EMBED_LINKS:` Nyaru should be able to send giveaway embeds in the giveaway channel. {% endtab %} {% endtabs %} ## Usage `@Nyaru glist` `/giveaway list`` ``[Type]` ## Example In the slash command, you have an optional property Type that allows you to narrow down your giveaway list selection from all giveaways. 1. All: This is the default type selection, it shows you all giveaways on the server. 2. Running: This narrows the giveaway list to only running giveaways on the server. 3. Ended: This narrows the giveaway list to only ended giveaways on the server. #### Scenario: You want to display only the running giveaways on the server: > `/giveaway list`` ``type: running` # end End a running giveaway instantly on your server. {% tabs %} {% tab title="Cooldown" %} 30 seconds {% endtab %} {% tab title="Permissions" %} * `MANAGE_SERVER:` The discord user running the command should have at least this permission in the giveaway server. {% endtab %} {% tab title="Requirements" %} * `VIEW_CHANNEL:` Nyaru should be able to view the giveaway channel. * `SEND_MESSAGES:` Nyaru should be able to send the giveaway message. * `EMBED_LINKS:` Nyaru should be able to send giveaway embeds in the giveaway channel. {% endtab %} {% endtabs %} ## Usage `@Nyaru gend`` ```>` `/giveaway end`` ``` ## Example Simply provide the message ID of the running giveaway to end it. > `@Nyaru gend`` ``1325902679289102542` > > `/giveaway`` ``end message_id:1325902679289102542` # reroll Re-roll the winners of a ended giveaway. {% tabs %} {% tab title="Cooldown" %} 30 seconds {% endtab %} {% tab title="Permissions" %} * `MANAGE_SERVER:` The discord user running the command should have at least this permission in the giveaway server. {% endtab %} {% tab title="Requirements" %} * `VIEW_CHANNEL:` Nyaru should be able to view the giveaway channel. * `SEND_MESSAGES:` Nyaru should be able to send the giveaway message. * `EMBED_LINKS:` Nyaru should be able to send giveaway embeds in the giveaway channel. {% endtab %} {% endtabs %} ## Usage `@Nyaru greroll`` ``` `[Winner Count]` `/giveaway reroll``` `[Winner Count]` ## Example Simply provide the message ID of the ended giveaway to end it. Optionally provide a new number of winners to draw. For example, if you want to draw 2 new winners of a giveaway: > `@Nyaru greroll`` ``1325902679289102542`` ``2` > > `/giveaway reroll`` ``message_id:1325902679289102542` `winner_count:2` # Play > Plays audio from YouTube, Spotify or Souncloud {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Pause > Pause the currently playing music. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Resume > Resume the current paused song {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Search > Search and select videos to play. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # ⏭️ Skip > Skip a song. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Queue > Show current playlist. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Stop > Stop and clear the current queue. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Shuffle > Shuffle queue. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Remove > Remove song from the queue. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # NowPlaying > Show song name playing now. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Loop > Repeat the current song or queue. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # 🏨ℹ ServerInfo > This commands shows detailed server information to you. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # 🧑ℹ UserInfo > Get the info of tagged users or your own info. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Avatar > Find enlarged avatar of someone, with links! {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # 👩‍🔧 About > Gives you some info about the bot! {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # DPBal > See DREAM Points balance for yourself or for other user! {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Ping > Um, you want to know? It shows my latency. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Help > Help command shows all valid commands for you to interact with me. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # 👯‍♀️ Invite > Gives you the invite link to invite me in your server, my support server and our website. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Embed > Create a stylish embed using a interactive setup, and send to any channel. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Poll > I can create a poll for you! Seperate Question and choices using `|`! {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Say > I will repeat what you say. {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Edit > Edits a message I sent using message ID! {% tabs %} {% tab title="Aliases" %} {% endtab %} {% tab title="Sub-commands" %} {% endtab %} {% tab title="Cooldown" %} 5 seconds {% endtab %} {% tab title="Permissions" %} {% endtab %} {% tab title="Requirements" %} {% endtab %} {% endtabs %} {% hint style="warning" %} Optional Warning {% endhint %} ## Sub-command # Prefix Set your own custom Nyaru prefix to run commands! {% tabs %} {% tab title="Aliases" %} px {% endtab %} {% tab title="Cooldown" %} 10 seconds. {% endtab %} {% tab title="Permissions" %} * `Administrator:` The discord user running this command must have admin rights to change the server prefix. {% endtab %} {% tab title="Requirements" %} * `VIEW_CHANNEL:` Nyaru should be able to view the command channel. * `SEND_MESSAGES:` Nyaru should be able to send messages. * `EMBED_LINKS:` Nyaru should be able to send embeds in the command channel. {% endtab %} {% endtabs %} {% hint style="warning" %} The prefix character length must be less than or equal to 10 letters! We do not allow more than this because it can cause chaos in your server! {% endhint %} ## Usage `@Nyaru prefix {New Prefix}` `/prefix new_prefix:{New Prefix}` ## Example To change your server's prefix to `!` `@Nyaru prefix !` `/prefix new_prefix:!` # coming soon