This game contains methods or game modes to play together with your friends

Cooperative Play

This game allows you to trade items or currency with other players

This game allows you to trade any item to any user

This game allows for trading, but limits it to certain items

Trading Allowed

This project has a complementary web interface that you can use to control or configure your experience

Web Interface

This game contains the ability for players to obtains achievements

Achievements

This game hosts seasonal events to earn rewards

Seasonal Events

This project has leaderboards highlighting the top players within either the server or globally

Leaderboards

Whether the current project contains any paid features, is paid only, or is 100% free to use.

This project is free to use and contains no paywalls for core functionality.

Has Paid Features

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![WakaTime][wakatime-shield]][wakatime-url]
[![CodeFactor][codefactor-shield]][codefactor-url]
![GitHub release (latest by date)](https://img.shields.io/github/v/release/beanbeanjuice/cafebot?style=for-the-badge)

<br />
<p align="center">
  <a href="https://www.cafebot.dev">
      <img src="/assets/signature.png" alt="signature" />
  </a>

  <h1 align="center">cafeBot</h1>

  <p align="center">
    A cafe bot for your discord server!
    <br />
    <a href="https://www.cafebot.dev"><strong>The Dashboard »</strong></a>
    <br />
    <br />
    <a href="https://github.com/beanbeanjuice/cafeBot">View Demo</a>
    ·
    <a href="https://github.com/beanbeanjuice/cafeBot/issues">Report Bug</a>
    ·
    <a href="https://github.com/beanbeanjuice/cafeBot/issues">Request Feature</a>
  </p>
  <p align="center">
    <a href="https://top.gg/bot/787162619504492554">
      <img src="https://top.gg/api/widget/787162619504492554.svg">
    </a>
  </p>
  <p align="center">
    <a href="https://www.buymeacoffee.com/beanbeanjuice">
      <img src="https://cdn.buymeacoffee.com/buttons/v2/default-violet.png" width="200px"/>
    </a>
  </p>
</p>


<details open="open">
  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>

1. [About the Project](#about-the-project)
    * [Built With](#built-with)
    * [About the Bot](#about-the-bot)

2. [Getting Started](#getting-started)
    * [Prerequisites](#prerequisites)
    * [Installation](#installation)

3. [Usage](#usage)
    * [Command List](#command-list)
    * [Custom Channels](#custom-channels)
    * [Custom Roles](#custom-roles)

4. [Roadmap](#roadmap)
5. [Contributing](#contributing)
6. [License](#license)
7. [Privacy Policy](#privacy-policy)
8. [Terms and Conditions](#terms-and-conditions)
9. [Contact](#contact)
10. [Acknowledgements](#acknowledgements)

</details>

## About The Project

<p align="center">
  <a href="https://www.cafebot.dev">
    <img src="/assets/cafeBot.gif" alt="Logo" width="260" height="186">
  </a>
</p>

### Built With

* [Java](https://openjdk.org)
* [Gradle](https://gradle.org/)
* [Discord JDA](https://github.com/DV8FromTheWorld/JDA)
* [Twitch4J](https://github.com/twitch4j/twitch4j)
* [NextJS](https://nextjs.org/)
* [ExpressJS](https://expressjs.com/)
* [KawaiiAPI](https://kawaii.red/)

### About the Bot
`cafeBot`, formerly `beanBot` is a general purpose bot that has many features. Many features work across Discord servers. Some features include;

* Global Birthday Checker
* Global Currency
* Global Counting Leaderboard
* Interaction Commands
* Moderation Commands
* Poll/Raffle Commands
* Bind Roles to Voice Channels
* AI Responses to Certain Words/Phrases
* And more to come...

## Getting Started

To add this bot to your server, follow these steps:

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.
* A Discord Server
* Administrative Access

### Installation

1. Head over to [https://www.cafebot.dev](https://www.cafebot.dev).
2. Click "Add Bot".

## Usage

* `/help` - Shows a list of commands.

> This command is your main source of truth for the bot. It gives you a list of all the commands and how to use them.

Commands are separated by sections. Each section has a different set of commands.


### Command List

#### 1. Cafe Commands

* `/balance` - Get your cafeCoin balance!
* `/donate` - Donate your cafeCoins to another user!
* `/menu` - Order something from the virtual menu!
* `/serve` - Serve something to get some more cafeCoins!

#### 2. Fun Commands

* `/8ball` - Ask the mythical 8ball a question!
* `/ai` - Toggle the "ai" for the server!
* `/avatar` - Get someone's profile picture!
* `/banner` - Get someone's profile banner!
* `/birthday` - Get someone's birthday, or set your own!
* `/meme` - Get a meme!
* `/rate` - Rate something!
* `/snipe` - Snipe a recently deleted message!

#### 3. Game Commands

* `/coinflip` - Flip a coin!
* `/counting-statistics` - Get the server's global counting statistics!
* `/roll` - Roll dice!
* `/game` - Get your game data!
* `/tictactoe` - Play a game of tictactoe!

#### 4. Generic Commands

* `/bot-donate` - Donate to the creator (me) to help keep this bot running! (Optional, of course!)
* `/bot-invite` - Get an invite link for the bot!
* `/bot-upvote` - Upvote this bot so more users can use it!
* `/bug` - Report any bugs found!
* `/define` - Define something!
* `/embed` - Create a customized embed of your own!
* `/feature` - Request a new feature for the bot.
* `/help` - Get a list of all the commands the bot has.
* `/info` - Get some information about the bot!
* `/ping`- Pong!
* `/remove-my-data` - Remove your data from this bot!
* `/stats` - Get some statistics about the bot!
* `/support` Get some support for the bot!
* `/twitch` - Add or remove twitch channels to be notified for!
* `/version` - Get the current bot version!
* `/who` - Get some information about yourself or another user!

#### 5. Interaction Commands

* `/interaction` - The generic command! Here you can block pesky people, or even completely disable interactions!
* `/amaze` - Be amazed at someone!
* `/ask` - Ask someone a question!
* `/bite` - Bite someone!
* `/blush` - Blush at someone!
* `/bonk` - Bonk someone! Send them to `h o r n i` jail.
* `/boop` - Boop someone!
* `/cry` - Cry at someone!
* `/cuddle` - Cuddle someone!
* `/dab` - Dab at someone!
* `/dance` - Dance with someone!
* `/die` - Just straight up die.
* `/greet` - Greet someone!
* `/headpat` - Give head pats to someone!
* `/hide` - Hide from someone!
* `/hmph` - Hmph at someone!
* `/hug` - Hug someone!
* `/kiss` - Kiss someone!
* `/lick` - Lick... someone... ummm why?
* `/love` - Show someone your love for them!
* `/nom` - Nom at someone!
* `/nosebleed` - Have a nosebleed... why would you do that?
* `/ok` - Show someone your dissatisfaction.
* `/poke` - Poke someone!
* `/pout` - Pout at someone!
* `/punch` - Punch someone!
* `/rage` - Rage at someone!
* `/shoot` - Shoot someone (in-game)!
* `/shush` - Shush someone if they're being too loud!
* `/slap` - Slap someone!
* `/sleep` - Sleep! (Or sleep with someone...)
* `/smile` - Smile at someone!
* `/stab` - Stab someone! :O
* `/stare` - Stare at someone!
* `/throw` - Throw someone!
* `/tickle` - Tickle someone!
* `/uwu` - UwU at someone!
* `/wave` - Wave at someone!
* `/wink` - Wink at someone!
* `/yell` - Yell at someone!

#### 6. Social Commands

* `/confess` - Confess something! This only works if the server has a confession channel set-up!
* `/membercount` - Get the member count for the server!

#### 7. Moderation Commands

* `/clearchat` - Clear the chat!

#### 8. Settings Commands

* `/airport` - Set or remove the airport message. This means setting messages for when users join/leave your server!
* `/bind` - Bind a role to a voice channel! This means if a user joins a voice channel, they are granted a role. When they leave the voice channel, the role is removed.
* `/channel` - Set, remove, and list all of your custom channels!
* `/poll` - Create or delete polls!
* `/raffle` - Create or delete raffles!
* `/role` - Set, remove, and list all of your custom roles!

### Custom Channels

* `WELCOME` - The channel that will receive all notices of when a user joins your server.
* `GOODBYE` - The channel that will receive all notices of when a user leaves your server.
* `COUNTING` - The channel for the counting mini-game!
* `UPDATE NOTIFICATIONS` - The channel that will receive update notifications for this bot!
* `TWITCH NOTIFICATIONS` - The channel that will receive notifications when your specified twitch account(s) go live.
* `POLL` - The channel that will receive polls.
* `RAFFLE` - The channel that will receive raffles.
* `BIRTHDAY` - The channel that will receive birthday messages for those in your server!
* `CONFESSIONS` - The channel that will receive messages when users use the `/confess` command!
* `HONEYPOT` - The channel that, when typed in, will ban users. This is mainly used to prevent spam bots on your server.
* `DAILY` - This channel will reset daily!
* `LOG` - This channel will receive logs that I need to notify you about!

### Custom Roles

* `WELCOME NOTIFICATIONS` - WIP.
* `GOODBYE NOTIFICATIOSN` - WIP.
* `COUNTING FAILURE` - The role that will be given to users when they fail at counting in the counting channel.
* `TWITCH NOTIFICATIONS` - The role that will be pinged when a user goes live on twitch!

## Roadmap

See the [open issues](https://github.com/beanbeanjuice/cafeBot/issues) for a list of proposed features (and known issues).

## Contributing

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**.

Please follow the contributing guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

Distributed under a custom license. See [`LICENSE.md`](./LICENSE.md) for more information.

## Privacy Policy

You can view the updated privacy policy [here](https://www.cafebot.dev/cafeBot/privacy_policy.html). All data can be removed in the **profile** section on the [dashboard](https://www.cafebot.dev).

## Terms and Conditions

By using [cafeBot](https://www.github.com/beanbeanjuice/cafeBot), you are agreeing to the [privacy policy](https://www.cafebot.dev/cafeBot/terms_and_conditions.html) and [terms and conditions](https://www.cafebot.dev/cafeBot/terms_and_conditions.html). Again, other than the things you provide through commands, nothing is saved and no personal information is saved.

## Contact

- beanbeanjuice
- Discord: [@beanbeanjuice](https://discord.gg/KrUFw3uHST)
- YouTube: [beanbeanjuice](https://www.youtube.com/beanbeanjuice)
- TikTok: [@beanbeanjuiceofficial](https://www.tiktok.com/@beanbeanjuiceofficial)
- Twitter: [@beanbeanjuice](https://twitter.com/beanbeanjuice)
- Email: beanbeanjuice [@] outlook.com
- Project Link: [GitHub](https://github.com/beanbeanjuice/cafeBot)

## Acknowledgements

* *There's nothing here yet... maybe in the future?*

[contributors-shield]: https://img.shields.io/github/contributors/beanbeanjuice/cafeBot.svg?style=for-the-badge
[contributors-url]: https://github.com/beanbeanjuice/cafeBot/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/beanbeanjuice/cafeBot.svg?style=for-the-badge
[forks-url]: https://github.com/beanbeanjuice/cafeBot/network/members
[stars-shield]: https://img.shields.io/github/stars/beanbeanjuice/cafeBot.svg?style=for-the-badge
[stars-url]: https://github.com/beanbeanjuice/cafeBot/stargazers
[issues-shield]: https://img.shields.io/github/issues/beanbeanjuice/cafeBot.svg?style=for-the-badge
[issues-url]: https://github.com/beanbeanjuice/cafeBot/issues
[wakatime-shield]: https://wakatime.com/badge/github/beanbeanjuice/cafeBot.svg?style=for-the-badge
[wakatime-url]: https://wakatime.com/badge/github/beanbeanjuice/cafeBot
[product-title]: ./assets/signature.png
[codefactor-shield]: https://www.codefactor.io/repository/github/beanbeanjuice/cafebot/badge?style=for-the-badge
[codefactor-url]: https://www.codefactor.io/repository/github/beanbeanjuice/cafebot

cafeBot

A general-purpose cafe bot with a global currency system, mini-games, and much more!

التصويت لـcafeBot

هل ترغب في دعمنا؟