Documentation is available at https://docs.warbot.dev/

Below is a copy of that documentation, which may be out of date.


Warbot is a discord bot originally designed for the hustle-castle mobile phone game. It is intended to display a notification when wars are starting, to assist with reminding members to deploy their troops.

These days, Warbot is a general purpose discord bot, offering many useful features to your discord guild.

## Basic Features

#### Custom Commands

Get tired of managing users? Ever wish users could add themselves to a discord role? Well. Now they can.

Warbot gives you the ability to create custom commands. These commands can perform actions such as...

* Replying to the user with a message of your choice.
* Sending a message in an unrelated channel.
* Adding the user to a discord role.
* Removing the user from a discord role.

Each custom command can contain many actions. So, it is possible to....

1. Add the user to a role
2. Send a message in a channel which requires the above role, tagging the user to say, Hey, @User, look here!
3. Reply to the user and say a message of your choosing.

Please read more in the documentation for [Custom Commands](https://docs.warbot.dev/Features/CustomCommands.md)

#### Discord Role Management

Warbot can easily handle promoting or demoting members to roles. Easy to use, just type `/promote` or `/demote`

Learn more about role managment [Here](https://docs.warbot.dev/Features/RoleManagement.md)



#### Reminders
Need to be reminded of something in the future? Simple. Type `/remind delay:5m message:Its been 5 minutes` WarBOT will send your message after the desired delay.

Learn more about remindars [Here](https://docs.warbot.dev/Features/Reminders.md)

#### Cleaning up old messages
Wish to keep your channels all nice and clean? Hate manually removing messages?

Type `/clear`. Warbot will clear all messages up to 10 days. 

To learn about more options, look at the [Clear Documentation](https://docs.warbot.dev/Features/ClearMessages.md)

#### New user greetings, and farewell messages
WarBOT can greet new users, and/or send a farewell when users leave.

Please read about these features [Here](https://docs.warbot.dev/Features/UserJoinLeave.md)


## Game Specific Features

### Hustle Castle

#### War Notifications

Ever get tired of manually reminding people to deploy their troops for clan wars? Well, Warbot can do this for you.

You can optionally send these events, for each of the wars, automatically.

* Discord Event for War Prep - Creates a discord event for the upcoming war. Sent out two hours before the preperation begins to give time for users to opt-in.
* War Preperation Started Message - Sends a message of your choosing to the channel configured for this specific war.
* War Preperation Ending Message - 15 minutes before the war starts, you can optionally send a secondary remindar to deploy.
* War Started Message - Delivers a message for when the war has started.

Each of the above events is optional, and may be opted out. 

As well, each war is optional, and can be configured to a different channel, if desired. Each war has its own messages

Read more in the [Hustle Castle Documentation](https://docs.warbot.dev/Features/HustleFeatures.md#Wars)

#### Portal Notifications

Have trouble remember when the portal opens every week? Warbot can remind you in the channel you desire, with a message you can set.

Read more in the [Hustle Castle Documentation](https://docs.warbot.dev/Features/HustleFeatures.md#Portal)


# How to add WarBOT?
To Invite WarBot to your discord server, Please visit the [WarBot Site](https://warbot.dev/)

In the Select a guild screen, click the "Invite WarBOT"  button at the bottom.

#### What are all of those permissions?? I don't like them!

Please read about.... [WarBOT Permissions](https://docs.warbot.dev/Faqs/Permissions.md)

# Other

You may join the [WarBot Development discord server](https://discord.gg/uEkamH9) for support.

If you would like a new feature, [Send a request!](https://github.com/XtremeOwnage/WarBot/issues/new/choose)

WarBot

A bot, to send automated hustle castle war reminders. It also has the ability to do user role management (Officer, Leader, Member)

Voting for WarBot

Do you want to support us?