|
| 1 | +<div align="center"> |
| 2 | + <a href="https://discord.com/api/oauth2/authorize?client_id=814580247973986314&permissions=259845516535&scope=bot"><img src="https://i.imgur.com/s4q1Wz3.png" width="15%"/></a> |
| 3 | + <h1><a href="https://discord.com/api/oauth2/authorize?client_id=814580247973986314&permissions=259845516535&scope=bot">Prune Bot </a></h1> |
| 4 | + |
| 5 | + <h3>Version 2.0.0</h3> |
| 6 | + |
| 7 | + <h4>Created by Mashwishi | Powered by <a href="https://discord.js.org/">Discord.js</a></h4> |
| 8 | + |
| 9 | + <h6>Fellow Developers that guide me doing this from Discord Server Community of <a href="https://discord.gg/discord-api">Discord API</a>. |
| 10 | + <br>Special Thanks to our contributors and helper <a href="https://github.com/esfox">esfox</a>, <a href="https://github.com/itsjusttriz">itsjusttriz</a> and <a href="https://github.com/Hickacou">Hickacou</a>!</h6> |
| 11 | + |
| 12 | + [](https://ko-fi.com/B0B14A4MU) |
| 13 | + |
| 14 | + [![support][support-image]][support-invite] |
| 15 | + |
| 16 | + [![Contributors][contributors-shield]][contributors-url] |
| 17 | + [![Forks][forks-shield]][forks-url] |
| 18 | + [![Stargazers][stars-shield]][stars-url] |
| 19 | + [![Issues][issues-shield]][issues-url] |
| 20 | + [![MIT License][license-shield]][license-url] |
| 21 | + <br> |
| 22 | + |
| 23 | +</div> |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +<h2 align="center">What is this bot?</h2> |
| 28 | + |
| 29 | +<strong><a href="https://discord.com/api/oauth2/authorize?client_id=814580247973986314&permissions=8&scope=bot">PruneBot</a></strong> is an easy to use multi-purpose bot and it has a free open source code to setup your own prune bot to your own server. Our goal is to cover as many functionalities as possible. |
| 30 | + |
| 31 | +<strong><a href="https://discord.com/api/oauth2/authorize?client_id=816474139560378379&permissions=8&scope=bot">PruneBot (Development)</a></strong> is created for beta testing of the latest updates of PruneBot. This is also limited to 100 servers, This bot is not that stable and may contain bugs. There will be no support given to this version |
| 32 | + |
| 33 | +--- |
| 34 | + |
| 35 | +### Bot Features: |
| 36 | +- :battery: 24/7 Full Uptime with high stability |
| 37 | +- :file_folder: Persistent Database based in `Enmap` |
| 38 | +- :cop: Powerful Moderation Commands |
| 39 | +- :smiley: Easy to use |
| 40 | +- ⚙ Per-Server Settings |
| 41 | +- :+1: Fast command responses |
| 42 | +- :tada: Giveaways Commands |
| 43 | +- :soccer: Slash Commands |
| 44 | + |
| 45 | +### Important Note: |
| 46 | +- ⚠ | Embed links needed for bot embed messages |
| 47 | +- ⚠ | Admin Permission needed for Moderation commands |
| 48 | + |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +<h2 align="center">Commands</h2> |
| 53 | + |
| 54 | +### Featured Commands: |
| 55 | + |
| 56 | +We have more than 80 commands in this bot, and they are **featured** and having 9 main categories |
| 57 | + |
| 58 | +- ⚙ **Basic:** `setprefix`, and more **coming soon**! |
| 59 | +- :lock: **Moderation:** `ban`, `kick`, `warn`, `mute`, `createchannel`, `createemoji`, and **9 more!** |
| 60 | +- :electric_plug: **Utility:** `weather`, `aes256`, `embed`, `enlarge`, and **4 more!** |
| 61 | +- :skull: **Pruning:** `urole`, `unorole`, `kole`, `knorole`, `fetch` |
| 62 | +- :file_folder: **Info:** `help`, `uptime`, `vote`, `channel`, `stats`, `whois`, and **5 more!** |
| 63 | +- :musical_note: **Music:** `play`, `loop`, `skip`, `stop`, `jumpto`, `volume`, and **4 more!** |
| 64 | +- :gift: **Giveaways:** `gstart`, `gend`, `greroll` |
| 65 | +- :stars: **Images:** `cat`, `changemymind`, `gay`, `trigger`, `circle`, and **7 more!** |
| 66 | +- :soccer: **Fun:** `8ball`, `reverse`, `snipe`, and **4 more!** |
| 67 | + |
| 68 | + |
| 69 | +## Issue/Suggestions |
| 70 | + |
| 71 | +If met any issues, go [here](https://github.com/Mashwishi/PruneBot/issues) to report bug and create new issue for supporting |
| 72 | + |
| 73 | +## Github Repository |
| 74 | + |
| 75 | +PruneBot Made by Mashwishi, project [Here](https://github.com/Mashwishi/PruneBot) |
| 76 | + |
| 77 | +<h2 align="center">Self-Hosting & Development</h2> |
| 78 | + |
| 79 | +**We ask you to please not host your own instance of PruneBot.** Even though our license allows it, self-hosted instances of the bot have brought us a lot of headache in the past. If you're considering self-hosting, please [try the official instance of the bot first](https://github.com/mashwishi/PruneBot/#). If you have any concerns about the security of our instance, please contact us. We'd love to talk and answer any questions you have. |
| 80 | + |
| 81 | +> If you're really really really going to self-host the bot, please [read our license](https://github.com/mashwishi/PruneBot/blob/master/LICENSE) first, and be aware that we don't provide any self-hosting support. **You'll be on your own.** |
| 82 | +
|
| 83 | +## Getting Started |
| 84 | + |
| 85 | +This is how you will set-up your self-hosted Prune Bot. |
| 86 | + |
| 87 | + |
| 88 | +### Requirements |
| 89 | + |
| 90 | +- Node.js v12.x or upper |
| 91 | +- Python (For Advanced Music feature) |
| 92 | + |
| 93 | +### Installation |
| 94 | +1. Clone the repo |
| 95 | + ```sh |
| 96 | + git clone https://github.com/mashwishi/prunebot.git |
| 97 | + ``` |
| 98 | +2. Install NPM packages |
| 99 | + ```sh |
| 100 | + npm install |
| 101 | + ``` |
| 102 | +3. Create `.env` file to the same folder of the PruneBot then copy and fill this: |
| 103 | + ```env |
| 104 | + TOKEN=<your bot token here> |
| 105 | + OWNERID=<your id here> |
| 106 | + ``` |
| 107 | + |
| 108 | +### Reminders: |
| 109 | + |
| 110 | +- If you are not using Discord Bot lists and top.gg, delete files from `handlers/dbl-loader.js` / `events/dbl/all-files` and removes all codes from index.js with `//` |
| 111 | +- If you are using Top.gg bot lists API, u need to delete `//` from commands lines from index.js |
| 112 | +- If you are not using .env supported hosters, please add code `require('dotenv').config()` to the top of the code from `index.js`, `shard.js` and other place are needed to use `process.env.(stuff)` |
| 113 | + |
| 114 | +1. To get PruneBot ready to run locally, the first step is to clone this repository onto the machine you wish to run it on. |
| 115 | +2. **Node.js version 12 or newer is recommended to run PruneBot since we are using Discord.js v12** |
| 116 | +3. Use NPM to install the dependencies from the project folder: `npm install` |
| 117 | +4. Edit/create the file `.env` (or your hoster's provided environment secret) and insert your bot token in `TOKEN` value. |
| 118 | +5. Start the bot from the project folder: `node shard.js` |
| 119 | +6. Open `http://localhost:8080/` or your project URL to view the http output. |
| 120 | + |
| 121 | +--- |
| 122 | + |
| 123 | +[support-invite]: https://discord.gg/WAh8eaF2Qq |
| 124 | +[support-image]: https://discordapp.com/api/guilds/779997243159216149/widget.png?style=banner2 |
| 125 | + |
| 126 | +[donate-link]: https://www.paypal.me/NCMC |
| 127 | +[donate-image]: https://i.imgur.com/R2SxfKG.png |
| 128 | + |
| 129 | +<!-- MARKDOWN LINKS & IMAGES --> |
| 130 | +[contributors-shield]: https://img.shields.io/github/contributors/mashwishi/PruneBot.svg?style=for-the-badge |
| 131 | +[contributors-url]: https://github.com/mashwishi/PruneBot/graphs/contributors |
| 132 | +[forks-shield]: https://img.shields.io/github/forks/mashwishi/PruneBot.svg?style=for-the-badge |
| 133 | +[forks-url]: https://github.com/mashwishi/PruneBot/network/members |
| 134 | +[stars-shield]: https://img.shields.io/github/stars/mashwishi/PruneBot.svg?style=for-the-badge |
| 135 | +[stars-url]: https://github.com/mashwishi/PruneBot/stargazers |
| 136 | +[issues-shield]: https://img.shields.io/github/issues/mashwishi/PruneBot.svg?style=for-the-badge |
| 137 | +[issues-url]: https://github.com/mashwishi/PruneBot/issues |
| 138 | +[license-shield]: https://img.shields.io/github/license/mashwishi/PruneBot.svg?style=for-the-badge |
| 139 | +[license-url]: https://github.com/mashwishi/PruneBot/blob/master/LICENSE |
0 commit comments