Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bearts/mai
A multi-functional Discord Bot
https://github.com/bearts/mai
anime bot discord discordjs discordjs-bot discordjsbot mai mai-sakurajima meme subreddit
Last synced: about 1 month ago
JSON representation
A multi-functional Discord Bot
- Host: GitHub
- URL: https://github.com/bearts/mai
- Owner: BearTS
- License: mit
- Created: 2020-04-29T05:01:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-19T11:36:26.000Z (about 2 years ago)
- Last Synced: 2024-10-12T02:41:55.556Z (about 1 month ago)
- Topics: anime, bot, discord, discordjs, discordjs-bot, discordjsbot, mai, mai-sakurajima, meme, subreddit
- Language: JavaScript
- Homepage: https://invite.mai-san.ml/
- Size: 84.8 MB
- Stars: 135
- Watchers: 14
- Forks: 58
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Announcements
###### π 17th August, 2021
### π’ Rewrite Coming Soon
Rewrite for Mai that will be written on the freshly released [v13](https://github.com/discordjs/discord.js/releases/tag/13.1.0) of djs is just around the corner. Be wary that the newer release [v5-Public] may have less features than the current version of the bot [v4]. This might include discontinued support for sharding and music, and the removal of message based command entirely to fully utilize the slash command feature specifically made for bots.
---
###### π 23rd June, 2021
### π’ Migration from Public to Private
This repository will be updated with the code for the rewritten bot following the __official__ version 13 release of discord.js, once both the library and the updated bot have been deemed stable. Our hosted version of the bot, [__Mai__](https://mai.gg/) **does not run the code in this repository**. The official bot's source code has been made private and moved to a [Github Organization](https://github.com/mai-bot/). We will still maintain this repository over time with patches and slowly release new features once they have been tested throughly to ensure they are of the utmost quality. We will only be providing limited, non-obligatory support to self-hosting users **who have not made changes to the code we deem to be significant**.
---
Mai
A Discord Bot Based Around Anime, and Mai
---
Check the docs on https://mai-san.ml/
### Hosting
#### Deploy Using Docker
We have docker images available so Just Do This:
```
docker run -v /mai:/data -e DISCORD_TOKEN=bot_token bearts/mai:v4.0
```
Optional environment variables
- `MONGO_URI`: The Mongo URI, if you want to use the database-reliant features
- `chatbot_id` `chatbot_key`: Chatbot id and key, if you want to use the chatbot feature
#### Deploying (Without Using Docker)
Create Env file:
*Refer to .env_example file for other usable environment variables*
```
DISCORD_TOKEN=
```
Run the following command on your CLI
```
npm install
npm start
```
### Why should you invite Mai?
Mai is a simple yet powerful Discord Bot that aims to give discord users an enhanced "Discord Experience". Mai provides a variety of fun and informative commands that you can use with your friends.
Mai can:
- Spice up chat environment with the use of roleplay/action commands such as pat, hug, slap, and more!
- Search through the internet for information resources through various functions such as anime information lookup (series, characters, and even seiyuus!), games (via steam), or even time on some cities.
- Ease the work of moderators by managing the server through various single commands.
- Provide Airing Information automagically, implement user experience system, as well as economy system.
- Acquire totally random fun facts from various sources Mai has access to.
### Invite
You may invite Mai through https://invite.mai-san.ml.
### Support
If you have questions regarding the bot and it's use, please do join our support server at https://support.mai-san.ml/.
### Contribute
Contribution includes, but is not limited to making a Pull Request.
Pull Requests regarding totally new commands without foretelling the developer via creating issue will automatically be rejected.
If you love this work and wish to contribute in another manner, please do join our support server (which isn't much) and ping/mention **Sakurajimai#6742** there.
### License
Mai is Licensed under MIT.
### Disclaimer
*Mai's developer is not, in any way, affiliated with Mai Sakurajima's creator, nor the production team that brought the anime together, and is not, in any way, benefit financially from the sales the series produces.*
*Mai Sakurajima and "Seishun Buta YarΕ wa Bunny Girl Senpai no yume wo Minai" are all owned by Aniplex, Cloverworks, Keeji Mizoguchi and Hajime Kamoshida.*
*Please support the official releases.*
- *[γ’γγ‘](https://ao-buta.com/) (Japanese)*
- *[Anime](http://rascaldoesnotdream.com/) (English)*
- *[γ©γ€γγγγ«](https://dengekibunko.jp/product/aobuta/312044500000.html) (Japanese)*
- *[Light Novel](https://yenpress.com/9781975399351/rascal-does-not-dream-of-bunny-girl-senpai-light-novel/) (English)*
- *[Manga (Kadokawa)](https://www.kadokawa.co.jp/product/321607000727/) (Japanese)*
- *[Twitter](https://twitter.com/aobuta_anime) (Japanese)*