diff --git a/README.md b/README.md index 1b66a5cfb..72d4b6701 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,44 @@ -# 🤖 About Me +

+
+ Discord.js v14 Bot +
+ Discord.js v14 Bot +
+

-![Strange Bot](https://i.imgur.com/nFrS5wC.png) +

Admin, AutoMod, Anime, Economy, Fun, Giveaway, Image, Invite, Information, Moderation, Music, Owner, Social, Statistics, Suggestion, Ticket, Utility and More...

-> An awesome multipurpose discord bot built using [discord.js v13](https://discord.js.org) with support for slash commands and context menus +
-> Demo Bot: [Invite Here](https://discord.com/oauth2/authorize?client\_id=752922609733337190\&permissions=397602323830\&scope=bot%20applications.commands) -> -> Support Server: [Join Here](https://discord.gg/fE75UShbqB) -> -> Documentation URL: [Visit Here](https://docs.strangebot.xyz) +

+ Resource Links + • + Prerequisites + • + Getting Started + • + Features + • + Contributing +

-### Prerequisites +
-* [Node.js](https://nodejs.org/en/) v16.6.0 or higher -* [Git](https://git-scm.com/downloads) -* [MongoDB](https://www.mongodb.com) +## 🔗 Resource Links -### Getting Started +- 🤖 Demo Bot: [Invite Here](https://discord.com/oauth2/authorize?client_id=1013236808353599488&permissions=397602323830&scope=bot%20applications.commands) +- 🤝 Support Server: [Join Here](https://discord.gg/fE75UShbqB) +- 📂 Documentation URL: [Visit Here](https://docs.strangebot.xyz) -* Open the terminal and run the following commands +## 📦 Prerequisites + +- [Node.js](https://nodejs.org/en/) v16.9.0 or higher +- [Git](https://git-scm.com/downloads) +- [MongoDB](https://www.mongodb.com) + +## 🚀 Getting Started + +- Open the terminal and run the following commands ``` git clone https://github.com/saiteja-madha/discord-js-bot.git @@ -26,46 +46,111 @@ cd discord-js-bot npm install ``` -* Wait for all the dependencies to be installed -* Rename `.env.example` to `.env` and fill the values -* Optionally edit `config.js` -* Type `npm run start` to start the bot +- Wait for all the dependencies to be installed +- Rename `.env.example` to `.env` and fill the values +- Optionally edit `config.js` +- Type `npm run start` to start the bot If you need any additional help, make sure to read our guides [here](docs/additional/installation.md) -### Features +
+ +

✨ Features ✨

+ +### 📡 **Advanced Dashboard** + +- Manage your servers and make your server-specific settings! +- Make custom adjustments easy! + +### 🛑 **Powerful Moderation:** + +- **Moderation Commands.**
_Commands:_ `ban`, `unban`, `timeout`, `voice moderation`, `deafen`, `move`, `warn`, `setnick`, ... +- **Multi-Function Purge Commands.**
_Commands:_ `purge`, `purge attach`, `purge bots`, `purge links`, `purge token`, `purge user`, ... + +### 🤖 **Auto Moderation:** + +- **Anti system**
_Commands:_ `anti ghostping`, `anti spam`, `anti massmention`, ... +- **Auto Delete system**
_Commands:_ `autodelete attachments`, `autodelete invites`, `autodelete links`, `autodelete maxlines`, ... +- **AutoMod system**
_Commands:_ `automod status`, `automod strikes`, `automod action`, `automod debug`, `automod whitelist`, ... + +### ⚙️ **Admin Configuration:** + +- **Let a bot be the server's assistant!**
_Commands:_ `autorole`, `farewell`, `welcome`, `counters`, `flag translation`, `reaction roles`, ... +- **Make custom settings for your own server.**
_Commands:_ `setprefix`, `maxwarns`, `modlog`... + +### 💁 **Information Gathering:** + +- **User Context Interactions** +- **Advanced Information** Get deep information about a user, channel, role, etc. + +### 🎵 **Music:** + +- **LossLess Music!** Enjoy high quality lossless music +- **Multi-Platform** Play music from YouTube, SoundCloud, Spotify, and more +- **Filters** Apply filters to your music and spice it up + +### 🎉 **Giveaways:** + +- **Easy to use** Create giveaways with ease +- **Role specific** giveaways +- **Customizable** Customize the giveaway to your liking +- **Limitless** Create unlimited giveaways + +### 🫂 **Social Content:** + +- **You Have A CV In Each Server-Specific Bot!**
_Commands:_ `rep`, `rep view`... +- **Do You Love Someone?**
_Commands:_ `rep give`... + +### 🎟 **Ticket System:** + +- **Make Supporting Members A Breeze With Tickets!**
Highly customizable ticket system with staff roles +- **Multiple Categories**
Don't Want The Tickets To Be Everywhere? Categorize them using select menus + +### 📉 **Stats Tracking:** + +- **Levelling** Track your server's activity with a level system +- **Leaderboards** See who is the most active user in your server +- **Customizable System** Configure the levelup message, rank cards to your liking + +### 🙋‍♂️ **Suggestions:** + +- **Get Suggestions From Server Members To Help Your Server Become The Best!**
_Commands:_ `suggest`, `suggestion`... +- **Accept Or Decline The Suggestions And Customize Them To The Max!**
_Commands:_ `suggestion status`, `suggestion channel`, `suggestion appch`, `suggestion rejch`, `suggestion approve`, `suggestion staffadd`, `suggestion staffremove`... + +### ⚒️ **Utility Commands:** + +- **Need Some Help With Something? Use The Utility Commands To Find Out The Answer To It**
_Commands:_ `bigemoji`, `covid`, `pokedex`, `urban`, `weather`, ... +- **Need Help With Some More Stuff?**
_Commands:_ `help`, `proxies`, `translate`, `paste`, ... + +### ⭐ **Anime Content:** + +- **Love Anime? Express You Love To Someone Using The React Commands**
_Commands:_ `react`, `hug`, `kiss`, `cuddle`, `pat`, `poke`, `slap`, `smug`, ... + +### 🪙 **Economy System:** + +- **Want To Become Richest? Use The Economy Commands!**
_Commands:_ `bank`, `daily`, `beg`, `gamble`... +- **Give People Money, Check Your Balance, Or Just Flex!**
_Commands:_ `bank balance`, `bank deposit`, `bank withdraw`, `bank transfer`, ... + +### 😁 **Fun Commands:** -Strange is a feature-rich discord bot with new features constantly being updated! Current features include +- **Have Some Fun In Your Server!**
_Commands:_ `animal`, `facts`, `meme`, `flip`, ... +- **Play Games And Enjoy Yourself**
_Commands:_ `snake`, `together`, `flip coin`, `flip text`, ... -* **Auto-Moderation**: Power auto-moderation to keep your discord server clean -* **Powerful Moderation with Logging**: Moderate and log every action you take -* **Image Manipulation**: Have fun with various image `filters` and `generators` -* **Economy & XP System**: Engage user interaction with the economy and Levelling system -* **Invite Tracking**: Best invite tracking with configurable invite ranks -* **Ticketing**: Support for creating multiple `ticket` channels -* **Reaction Roles**: Support for creation of multiple custom reaction roles -* **Greeting**: Highly Customizable welcome and farewell embeds +### 📨 **Invite Tracking:** -### Categories +- **Track who has been inviting people to your server!** +- **Invite Ranks!** Inviter can get awesome rewards and be recognised +- **Configure these settings and customize them to your liking!**
_Commands:_ `resetinvites`, `addinvites`, `invitesimport`, `inviterank`... -Strange has an extensive list of all useful commands (**more than 100**) which are categorized as follows +### 📷 **Image Manipulation:** -* **Automod**: `antighostping`, `antiinvites`, `antilinks`, `antiscam`, `maxlines`, `maxmentions`, ... -* **Admin**: `welcome`, `farewell`, `reaction-roles`, ... -* **Economy**: `daily`, `gamble`, `deposit`, `withdraw`, `transfer`, ... -* **Fun**: `cat`, `doc`, `flipcoin`, `fliptext`, ... -* **Information**: `avatar`, `roleinfo`, `channelinfo`, `guildinfo`, `profile`, ... -* **Invites**: `inviter`, `invites`, `invitesimport`, `invitecodes`, ... -* **Moderation**: `warn`, `kick`, `softban`, `ban`, `mute`, `unmute`, ... -* **Music**: `play`, `pause`, `resume`, `stop`, `skip`, `queue`, `np`, ... -* **Social**: `reputation list,` `give reputation,` ... -* **Ticket**: setup, close, log, ... -* **Utility**: `proxies`, `translation`, `weather`, `covid`, ... +- **Customize other peoples avatars**
_Commands:_ `blur`, `greyscale`, `invert`, `pixelate`, `blur`, `sepia`, `sharpen`, `ad`, `affect`, `beautiful`, `color`... +- **Make some images by yourself or make some art**
_Commands:_ `bobross`, `confusedstonk`, `delete`, `facepalm`, ` hitler`, `jail`, `jokeoverhead`, `karaba`, `mms`, `notstonk`, `poutine`, `rainbow`, `rip`, ` shit`, `stonk`, `tatoo`, `thomas`, `trash`, `wanted`, `wasted`, ... -A complete list of commands can be found in the [documentation](docs/commands/) +
-### 🤝 Contributing +

🤝 Contributing 🤝

-* Special thanks to [@Androzz](https://github.com/Androz2091/AtlantaBot) for the [dashboard](https://github.com/Androz2091/AtlantaBot) and his other cool discord bot projects -* Feel free to [Fork](https://github.com/saiteja-madha/discord-js-bot/fork) this repository, create a feature branch and submit a pull request -* You can check all the planned features [here](https://github.com/saiteja-madha/discord-js-bot/projects) or make a request for one at our discord +- Special thanks to [@Androzz](https://github.com/Androz2091/AtlantaBot) for the [dashboard](https://github.com/Androz2091/AtlantaBot) and his other cool discord bot projects +- Feel free to [Fork](https://github.com/saiteja-madha/discord-js-bot/fork) this repository, create a feature branch and submit a pull request +- You can keep track of all the planned features [here](https://github.com/saiteja-madha/discord-js-bot/projects) or make a request for one at our discord