Skip to content

Better README.md #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 53 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,53 @@
# rookbot
Invite only discord bot geared towards Dungeons of Infinity discord but also multi-purpose for other servers

Includes many commands
- Ban
- Kickban
- Kick
- Unban
- Smz3
- Warn
- Ping
- Hex Color Viewer
- Botsrc
- Lockdown
- Lock channel
- Unlock channel
- nl
- Calculator
- Dice roll
- Coinflip
- Avatar pulling
- Booster command
- Timeout
- Embed Creation

For setup instructions, refer to [SETUP.md](SETUP.md)
# RookBot

RookBot is an invite-only Discord bot, originally designed for the **Dungeons of Infinity** Discord server, but versatile enough to be used across various communities. It includes a wide array of features to enhance moderation, utility, and interactivity.

---

## Features

### Moderation Commands
- **Ban**: Permanently ban a user from the server.
- **Kickban**: Temporarily ban and then unban a user.
- **Kick**: Remove a user from the server.
- **Unban**: Revoke a user's ban.
- **Warn**: Issue a warning to a user.
- **Timeout**: Temporarily restrict a user's ability to interact.
- **Lockdown**: Lock all channels in the server.
- **Lock channel**: Lock a specific channel.
- **Unlock channel**: Unlock a specific channel.

### Utility Commands
- **Ping**: Check the bot's latency.
- **Hex Color Viewer**: Display information about a given hex color code.
- **nl**: Displays a rainbow line
- **Calculator**: Perform basic arithmetic operations.
- **Botsrc**: Display the source code or link to the bot's GitHub repository.
- **Embed Creation**: Create and send custom embeds easily.

### Fun and Interactive Commands
- **Dice roll**: Roll a dice (e.g., d6, d20).
- **Coinflip**: Flip a virtual coin.
- **Avatar pulling**: Retrieve and display a user's avatar.
- **Booster command**: Retrieve the amount of boosts a server has and displat that number.

### Miscellaneous Commands
- **Smz3**: Creates an Smz3 run

---

## Getting Started

### Setup
Refer to the detailed setup guide in [SETUP.md](SETUP.md) for instructions on configuring RookBot for your server.

---

## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

## Support
If you encounter any issues or have suggestions, please open an issue on the GitHub repository or reach out on the **Dungeons of Infinity** Discord server.

Loading