|
1 | | -<!-- PROJECT SHIELDS --> |
2 | | -<!-- |
3 | | -*** I'm using markdown "reference style" links for readability. |
4 | | -*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). |
5 | | -*** See the bottom of this document for the declaration of the reference variables |
6 | | -*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. |
7 | | -*** https://www.markdownguide.org/basic-syntax/#reference-style-links |
8 | | ---> |
9 | | -[![Contributors][contributors-shield]][contributors-url] |
10 | | -[![Forks][forks-shield]][forks-url] |
11 | | -[![Stargazers][stars-shield]][stars-url] |
12 | | -[![Issues][issues-shield]][issues-url] |
13 | | -[![MIT License][license-shield]][license-url] |
14 | | -[![LinkedIn][linkedin-shield]][linkedin-url] |
15 | | -[![WakaTime][wakatime-shield]][wakatime-url] |
16 | | - |
17 | | -<!-- PROJECT LOGO --> |
18 | | -<br /> |
19 | | -<p align="center"> |
20 | | - <a href="https://github.com/beanbeanjuice/cafeBot"> |
21 | | - <img src="http://cdn.beanbeanjuice.com/images/cafeBot/readme/logo.gif" alt="Logo" width="260" height="186"> |
22 | | - </a> |
23 | | - |
24 | | - <h1 align="center">cafeBot</h1> |
25 | | - |
26 | | - <p align="center"> |
27 | | - A cafe bot for your discord server! |
28 | | - <br /> |
29 | | - <a href="https://github.com/beanbeanjuice/cafeBot"><strong>Explore the docs »</strong></a> |
30 | | - <br /> |
31 | | - <br /> |
32 | | - <a href="https://github.com/beanbeanjuice/cafeBot">View Demo</a> |
33 | | - · |
34 | | - <a href="https://github.com/beanbeanjuice/cafeBot/issues">Report Bug</a> |
35 | | - · |
36 | | - <a href="https://github.com/beanbeanjuice/cafeBot/issues">Request Feature</a> |
37 | | - </p> |
38 | | - <figure><embed src="https://wakatime.com/share/@beeb4317-977b-4b19-878a-21e9aa8e43ed/31fd7762-6212-4dd2-b4d7-4bfdc2a3b5a3.svg"></embed></figure> |
39 | | -</p> |
40 | | - |
41 | | -<!-- TABLE OF CONTENTS --> |
42 | | -<details open="open"> |
43 | | - <summary><h2 style="display: inline-block">Table of Contents</h2></summary> |
44 | | - <ol> |
45 | | - <li> |
46 | | - <a href="#about-the-project">About The Project</a> |
47 | | - <ul> |
48 | | - <li><a href="#built-with">Built With</a></li> |
49 | | - </ul> |
50 | | - </li> |
51 | | - <li> |
52 | | - <a href="#getting-started">Getting Started</a> |
53 | | - <ul> |
54 | | - <li><a href="#prerequisites">Prerequisites</a></li> |
55 | | - <li><a href="#installation">Installation</a></li> |
56 | | - </ul> |
57 | | - </li> |
58 | | - <li><a href="#usage">Usage</a></li> |
59 | | - <li><a href="#roadmap">Roadmap</a></li> |
60 | | - <li><a href="#contributing">Contributing</a></li> |
61 | | - <li><a href="#license">License</a></li> |
62 | | - <li><a href="#data">What data does this bot store?</a></li> |
63 | | - <li><a href="#contact">Contact</a></li> |
64 | | - <li><a href="#acknowledgements">Acknowledgements</a></li> |
65 | | - </ol> |
66 | | -</details> |
67 | | - |
68 | | -<!-- ABOUT THE PROJECT --> |
69 | | -# About The Project |
70 | | - |
71 | | -[![Product Name Screen Shot][product-title]](https://www.beanbeanjuice.com/cafeBot.html) |
72 | | - |
73 | | -### Built With |
74 | | - |
75 | | -* [Gradle](https://gradle.org/) |
76 | | -* [Discord JDA](https://github.com/DV8FromTheWorld/JDA) |
77 | | -* [Lavaplayer](https://github.com/sedmelluq/lavaplayer) |
78 | | -* [Spotify Web API](https://github.com/thelinmichael/spotify-web-api-java) |
79 | | -* [Twitch4J](https://github.com/twitch4j/twitch4j) |
80 | | - |
81 | | -### About the Bot |
82 | | -`cafeBot`, formerly `beanBot` is a general purpose bot that has many features. Many features work across Discord servers. Some features include; |
83 | | -* Global Birthday Checker |
84 | | -* Global Currency |
85 | | -* Global Counting Leaderboard (Only Tells You What Place Number You Are In) |
86 | | -* Interaction Commands |
87 | | -* Moderation Commands |
88 | | -* Poll/Raffle Commands |
89 | | -* Music Player |
90 | | -* Bind Roles to Voice Channels |
91 | | -* AI Responses to Certain Words/Phrases |
92 | | -* And more to come... |
93 | | - |
94 | | -<!-- GETTING STARTED --> |
95 | | -# Getting Started |
96 | | - |
97 | | -To add this bot to your server, follow these steps. |
98 | | - |
99 | | -## Prerequisites |
100 | | - |
101 | | -This is an example of how to list things you need to use the software and how to install them. |
102 | | -* A Discord Server |
103 | | -* Administrative Access |
104 | | - |
105 | | -## Installation |
106 | | - |
107 | | -1. Click this [link](https://discord.com/api/oauth2/authorize?client_id=787162619504492554&permissions=305654886&scope=bot). |
108 | | -2. Give the bot administrative access. `I promise it's safe. You can view all the code for yourself.` |
109 | | -3. Enjoy! |
110 | | - |
111 | | -<!-- USAGE EXAMPLES --> |
112 | | -# Usage |
113 | | - |
114 | | -#### **The Help Command** |
115 | | -* `!!help` - Shows a list of command section. |
116 | | -* `!!help (command section name)` - Shows a list of commands in that section. |
117 | | -* `!!help (command name/alias)` - Shows how to use the command. |
118 | | -* `!!get-prefix` - Gets the current prefix for the server if you forget it! |
119 | | - |
120 | | -<p align="center"> |
121 | | - <img src=http://cdn.beanbeanjuice.com/images/cafeBot/readme/help.png> |
122 | | -</p> |
123 | | - |
124 | | -As you can see, this was shown using the command `!!help order`. It shows each parameter you can run. For example, the first `<NUMBER>` is the `CATEGORY NUMBER` for the menu, needs to be a number, and is required. The `help` command also provides an example on how to actually use the command if you are stuck! |
125 | | - |
126 | | -#### **Command Section** |
127 | | -*There are many command sections, with more coming soon. To show the commands in a specific section, do `!!help (command section)` or for example, `!!help moderation`!* Doing `!!help (command)` will also show you an example of how to use the command. |
128 | | - |
129 | | -##### 1. **GENERIC** |
130 | | -* `help` - Shows the list of command sections and command list for those sections. |
131 | | -* `ping` - Show bot information! |
132 | | -* `feature-request` - Request a bot feature. |
133 | | -* `bug-report` - Report a bug with the bot. |
134 | | -* `support` - Get support for the bot! |
135 | | -* `invite-bot` - A command to get an invite link for the bot! |
136 | | -* `user-info` - Get user information about someone. |
137 | | -* `member-count` - Get the member count for your server! |
138 | | -* `bot-upvote` - Upvote the bot! |
139 | | -* `bot-donate` - Donate for the bot! |
140 | | -* `remove-my-data` - Request to remove your data from the bot! |
141 | | -* `generate-code` - Generate a random 32-digit long code! |
142 | | -* `get-bot-release-version` - Gets a specific/the latest release notes for the bot! |
143 | | -##### 2. **CAFE** |
144 | | -* `menu` - Show the list of Cafe menu items. |
145 | | -* `serve` - Get beanCoins! Essentially you run this command by doing `!!serve (dictionary word)`! This must be an english word. The longer the word, the more money you get. However, the more popular the word is, the less money you will get for it. |
146 | | -* `order` - Order a menu item for someone! |
147 | | -* `balance` - Check your balance! |
148 | | -* `bc-donate` - Donate some of your `beanCoins` to someone! (Only up to 25 every hour though!) |
149 | | -##### 3. **FUN** |
150 | | -* `coffee-meme` - Get a coffee meme! |
151 | | -* `tea-meme` - Get a tea meme! |
152 | | -* `meme` - Send a meme in the current channel. (SFW) |
153 | | -* `joke` - Send a joke in the current channel. (SFW) |
154 | | -* `add-poll` - Create a poll! Currently, you can only have 3 polls due to server costs. This will go up in the future! |
155 | | -* `add-raffle` - Create a raffle! Currently, you can only have 3 raffles due to server costs. This will go up in the future! |
156 | | -* `avatar` - Get yours or someone else's avatar image! |
157 | | -* `get-birthday` - Get yours or someone else's birthday! |
158 | | -* `set-birthday` - Set your birthday! `(MM-DD)` |
159 | | -* `remove-birthday` - Remove your birthday. |
160 | | -* `counting-statistics` - Get counting information for your server! |
161 | | -##### 4. **GAMES** |
162 | | -* `8-ball` - Ask a yes or no question! |
163 | | -* `coin-flip` - Flip a coin! |
164 | | -* `dice-roll` - Roll a dice! |
165 | | -* `tic-tac-toe` - Play tic tac toe with someone! |
166 | | -* `connect-four` - Play connect four with someone! |
167 | | -* `get-game-data` - See your win streaks for the mini-games that support it! |
168 | | -##### 5. **SOCIAL** |
169 | | -* `vent` - Anonymously vent to the server! ~~If the server has anonymous venting enabled...~~ |
170 | | -##### 6. **INTERACTION** |
171 | | -* `hug` - Hug someone! |
172 | | -* `punch` - Punch someone! |
173 | | -* `kiss` - Kiss someone! |
174 | | -* `bite` - Bite someone! |
175 | | -* `blush` - Blush at someone! |
176 | | -* `cuddle` - Cuddle someone! |
177 | | -* `nom` - Nom at someone! |
178 | | -* `poke` - Poke someone! |
179 | | -* `slap` - Slap someone! |
180 | | -* `stab` - Stab someone! :O |
181 | | -* `hmph` - Hmph at someone! |
182 | | -* `pout` - Pout at someone! |
183 | | -* `throw` - Throw someone! |
184 | | -* `smile` - Smile at someone! |
185 | | -* `stare` - Stare at someone! |
186 | | -* `tickle` - Tickle someone! |
187 | | -* `rage` - Rage at someone! |
188 | | -* `yell` - Yell at someone! |
189 | | -* `headpat` - Give head pats to someone! |
190 | | -* `cry` - Cry at someone! |
191 | | -* `dance` - Dance with someone! |
192 | | -* `dab` - Dab at someone! |
193 | | -* `bonk` - Bonk someone! Send them to `h o r n i` jail. |
194 | | -* `sleep` - Sleep! (Or sleep with someone...) |
195 | | -* `die` - Just straight up die. |
196 | | -* `welcome` - Welcome someone... for something! |
197 | | -* `lick` - Lick... someone... ummm why? |
198 | | -* `shush` - Shush someone if they're being too loud! |
199 | | -##### 7. **MUSIC** |
200 | | -* `play` - Play a song or playlist! |
201 | | -* `now-playing` - Show the current song playing. |
202 | | -* `pause` - Pause the current song. |
203 | | -* `queue` - Check the current queue. |
204 | | -* `repeat` - Choose to repeat the song or playlist! |
205 | | -* `shuffle` - Shuffle the current playlist. |
206 | | -* `skip` - Skip the current song. |
207 | | -* `stop` - Stop the queue and make the bot leave the channel. |
208 | | -* `play-last` - Puts the song that is at the back of the queue in the front of the queue. |
209 | | -##### 8. **TWITCH** |
210 | | -* `set-live-channel` - Set the current channel to receive twitch live notifications. You need to add twitch channels for this to work. |
211 | | -* `add-twitch-channel` - Add a twitch channel to leave bot notifications for. |
212 | | -* `remove-twitch-channel` - Remove a twitch channel you are currently receiving notifications for. |
213 | | -* `get-twitch-channels` - Get a list of the twitch channels you are currently receiving notifications for. |
214 | | -* `set-live-notifications-role` - Set the role to be mentioned when someone goes live. |
215 | | -##### 9. **MODERATION** |
216 | | -* `set-log-channel` - Sets the log channel for the guild. |
217 | | -* `set-update-channel` - Sets the current channel to the update channel. This means if you have `notify-on-update` set to `Enabled`, you will receive bot updates in this channel. |
218 | | -* `set-counting-channel` - Sets the current channel to the counting channel. This does exactly as it says. Try to count as high as you can without messing up! |
219 | | -* `set-poll-channel` - Sets the current channel to an active poll channel. This is needed if you want to run polls on your server! |
220 | | -* `set-raffle-channel` - Sets the current channel to an active raffle channel. This is needed if you want to run raffles on your server! |
221 | | -* `set-birthday-channel` - Sets the current channel to an active birthday channel. Be notified when one of the members in your server is having a birthday! |
222 | | -* `set-moderator-role` - Set the moderator role for the server. This is needed so that users with this role can run commands that require a moderator role. |
223 | | -* `set-muted-role` - Set the muted role for the server. This is needed so that users with this role can be stopped from talking in channels. This requires you to set it this way in each channel. This will not mute them if the role does not have the right permissions. |
224 | | -* `change-prefix` - Change the prefix from the bot to your desired prefix. |
225 | | -* `kick` - Kick a specified user. |
226 | | -* `ban` - Ban a specified user. |
227 | | -* `clear-chat` - Clear the chat. (Only currently works from 2-99 messages). |
228 | | -* `mute` - Mute a specified user. |
229 | | -* `un-mute` - Unmute a specified user. |
230 | | -* `notify-on-update` - `Enable` or `Disable` bot notifications. This is `Enabled` by default. |
231 | | -* `create-embed` - Send a customised `embedded message` in a specified channel! |
232 | | -* `voice-role-bind` - Bind specific role(s) to a `voice channel`! |
233 | | -* `get-voice-role-binds` - See which `voice channels` have `roles` bound to them! |
234 | | -* `set-venting-channel` - Sets the current channel to an anonymous venting channel! |
235 | | -* `ai-status` - Sets the `AI Status` for the server. This can `enable` or `disable` the AI module. |
236 | | -* `set-daily-channel` - Sets the current channel to a daily channel. This channel is deleted and re-made once a day! |
237 | | -* `get-custom-channels` - Gets ALL of the custom channels currently being used in the server! |
238 | | -* `set-welcome-channel` - Sets the current channel to welcome users when they join! |
239 | | -* `edit-welcome-message` - Edits the welcome message that is sent when users join. (Make sure to check the usage for this command doing `help edit-welcome-message` because this one is a little complicated!) |
240 | | -##### 10. **EXPERIMENTAL** |
241 | | -* `Nothing here yet!` |
242 | | - |
243 | | -<!-- ROADMAP --> |
244 | | -# Roadmap |
245 | | - |
246 | | -See the [open issues](https://github.com/beanbeanjuice/cafeBot/issues) for a list of proposed features (and known issues). |
247 | | - |
248 | | -<!-- CONTRIBUTING --> |
249 | | -# Contributing |
250 | | - |
251 | | -Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. |
252 | | - |
253 | | -1. Fork the Project |
254 | | -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
255 | | -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
256 | | -4. Push to the Branch (`git push origin feature/AmazingFeature`) |
257 | | -5. Open a Pull Request |
258 | | - |
259 | | -<!-- LICENSE --> |
260 | | -# License |
261 | | - |
262 | | -Distributed under the GPL-3.0 License. See `LICENSE` for more information. |
263 | | - |
264 | | -<!-- DATA THIS BOT STORED --> |
265 | | -# Data |
266 | | - |
267 | | -Here is ALL of the data that this bot could *possibly* store on you. This, of course, is subject to change. None of these can be accessed by other servers (that you are not a part of) by the bot. |
268 | | - |
269 | | -- *__Discord Data__* |
270 | | - - Your Discord ID.`*` |
271 | | - - This data is needed in order to keep track of the amount of money `(beanCoins)` with the bot. Additionally, it is used for the counting module to enforce the rule that the same Discord user cannot play the counting game twice in a row. |
272 | | - - Your Discord Server ID.`*` |
273 | | - - This data is needed in order to remember specific settings you have for the server, such as the prefix you use for the bot, the twitch channels you have added, the moderation role ID, the log channel ID, etc. |
274 | | - - Your Discord Server Role IDs.`**` |
275 | | - - Needed in conjunction with your `Discord Server ID` in order to keep track of specific roles to add to users when they join a VC or a moderation role ID. |
276 | | - - Your Discord Server Text Channel IDs.`**` |
277 | | - - Needed in order to keep track of which channels are which. For example, to know if the text channel you are talking in is the `counting` channel. |
278 | | - - Your Discord Server Voice Channel IDs.`**` |
279 | | - - Needed in order to know what role to add to what voice channel when joining. |
280 | | - |
281 | | -- *__Other Data__* |
282 | | - - Your birthday.`***` |
283 | | - - Your birthday can be removed any time. It can only be accessed by people in the same server as you. If they are not in the same server as you, they cannot see this. |
284 | | - |
285 | | -##### * - This is already public information anyway, and is crucial for having the bot work. |
286 | | -##### ** - This is something that is needed for the bot to do things like apply a role to someone when they join a specific voice channel, or to duplicate a voice channel when needed. |
287 | | -##### *** - Your birthday is only stored WHEN specified, and can even be removed at anytime by simply using the `remove-birthday` command. |
288 | | - |
289 | | -<!-- CONTACT --> |
290 | | -# Contact |
291 | | - |
292 | | -- beanbeanjuice |
293 | | -- Twitter [@beanbeanjuice](https://twitter.com/beanbeanjuice) |
294 | | -- Email - beanbeanjuice@outlook.com |
295 | | -- Project Link: [GitHub](https://github.com/beanbeanjuice/cafeBot) |
296 | | - |
297 | | -<!-- ACKNOWLEDGEMENTS --> |
298 | | -# Acknowledgements |
299 | | - |
300 | | -* *There's nothing here yet... maybe in the future?* |
301 | | - |
302 | | -<!-- MARKDOWN LINKS & IMAGES --> |
303 | | -<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> |
304 | | -[contributors-shield]: https://img.shields.io/github/contributors/beanbeanjuice/cafeBot.svg?style=for-the-badge |
305 | | -[contributors-url]: https://github.com/beanbeanjuice/cafeBot/graphs/contributors |
306 | | -[forks-shield]: https://img.shields.io/github/forks/beanbeanjuice/cafeBot.svg?style=for-the-badge |
307 | | -[forks-url]: https://github.com/beanbeanjuice/cafeBot/network/members |
308 | | -[stars-shield]: https://img.shields.io/github/stars/beanbeanjuice/cafeBot.svg?style=for-the-badge |
309 | | -[stars-url]: https://github.com/beanbeanjuice/cafeBot/stargazers |
310 | | -[issues-shield]: https://img.shields.io/github/issues/beanbeanjuice/cafeBot.svg?style=for-the-badge |
311 | | -[issues-url]: https://github.com/beanbeanjuice/cafeBot/issues |
312 | | -[license-shield]: https://img.shields.io/github/license/beanbeanjuice/cafeBot.svg?style=for-the-badge |
313 | | -[license-url]: https://github.com/beanbeanjuice/cafeBot/blob/master/LICENSE.txt |
314 | | -[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 |
315 | | -[linkedin-url]: https://linkedin.com/in/beanbeanjuice |
316 | | -[wakatime-shield]: https://wakatime.com/badge/github/beanbeanjuice/cafeBot.svg?style=for-the-badge |
317 | | -[wakatime-url]: https://wakatime.com/badge/github/beanbeanjuice/cafeBot |
318 | | -[product-title]: http://cdn.beanbeanjuice.com/images/cafeBot/readme/cafeBot.png |
| 1 | +# This is a placeholder |
0 commit comments