MiraiMC

[![GitHub release](https://img.shields.io/github/v/release/DreamVoid/MiraiMC?style=flat-square )](https://github.com/DreamVoid/MiraiMC/releases/latest) [![CodeFactor](https://www.codefactor.io/Content/badges/A.svg)](https://www.codefactor.io/repository/github/dreamvoid/miraimc) [![GitHub Actions CI](https://img.shields.io/github/actions/workflow/status/DreamVoid/MiraiMC/maven.yml?style=flat-square)](https://github.com/DreamVoid/MiraiMC/actions/workflows/maven.yml?query=is%3Asuccess) ![GitHub all releases](https://img.shields.io/github/downloads/DreamVoid/MiraiMC/total?style=flat-square)

--- MiraiMC is a [mirai](https://github.com/mamoe/mirai) bot for Minecraft servers > Mirai is a high-performance multi-platform library, as well as a framework, providing protocol support for Tencent QQ.
> Mirai is designed to handle all sorts of messaging works that can be automatically done by bots in a perfect way.
> Tencent QQ: A modern messaging software used by all Chinese netizens. ## Features * Support Bukkit/Sponge servers. * Support BungeeCord/Velocity proxies. * Optimized for GUI-less OS such as Linux * Dynamically load dependent libraries to minimize file size. ## Getting Started (Server) Download MiraiMC from "Featured versions" part. Then install it like installing other plugins. Configure any plugins' that depend on MiraiMC (if any) and login to your bot account A more detailed tutorial can be found here: https://docs.miraimc.dreamvoid.me/ ## Getting Started (Plugin Developer) * It is simple to develop a new MiriMC-based plugin by using template: - [Maven](https://github.com/MiraiMC/MiraiMC-Template) - [Gradle KotlinDSL](https://github.com/MiraiMC/MiraiMC-Template-Gradle-KotlinDSL) * MiraiMC javadoc here: https://jd.miraimc.dreamvoid.me * Detailed development tutorial here: https://docs.miraimc.dreamvoid.me/ ### Dependency #### Maven ``` io.github.dreamvoid MiraiMC-Integration 1.8.2 provided ``` #### Gradle ``` implementation 'io.github.dreamvoid:MiraiMC-Integration:1.8.2' ``` ## Commands and permissions ### Commands | Command | Description | Permissions | | ---- | --- | ---- | | /mirai | MiraiMC Robot Command | miraimc.command.mirai | | /mirai login \[protocol] | Log in to a robot (you can execute this command multiple times to log in to multiple robots) | miraimc.command.mirai.login | | /mirai logout | Log out and close a bot | miraimc.command.mirai.logout | | /mirai list | List currently online bots | miraimc.command.mirai.list | | /mirai sendfriendmessage | Send a message to a specified friend | miraimc.command.mirai.sendfriendmessage | | /mirai sendfriendnudge | Send a stamp to a specified friend | miraimc.command.mirai.sendfriendnudge | | /mirai sendgroupmessage | Send a message to the specified group | miraimc.command.mirai.sendgroupmessage | | /mirai checkonline | Check if the specified robot is online | miraimc.command.mirai.checkonline | | /mirai autologin add \[protocol] | Add an autologin robot account | miraimc.command.mirai.autologin | | /mirai autologin remove | Remove an autologin bot account | miraimc.command.mirai.autologin | | /mirai autologin list | View autologin robot account list | miraimc.command.mirai.autologin | | /miraimc | MiraiMC Plugin Command | miraimc.command.miraimc | | /miraimc bind add | Add binding for player and QQ number | miraimc.command.miraimc.bind | | /miraimc bind getplayer | Get the QQ number bound to the specified player name | miraimc.command.miraimc.bind | | /miraimc bind getqq | Get the player name bound to the specified QQ number | miraimc.command.miraimc.bind | | /miraimc bind removeplayer | Removes a player's bind | miraimc.command.miraimc.bind | | /miraimc bind removeqq | Delete the binding of a QQ number | miraimc.command.miraimc.bind | | /miraimc reload | Reload configuration file | miraimc.command.miraimc.reload | ### Permissions | Permission Node | Description | Default | | ------- | ---- | ---- | | miraimc.command.mirai | Allow use of `/mirai` | OP | | miraimc.command.mirai.* | Allow all subcommands of `/mirai` | OP | | miraimc.command.mirai.login | Allow `/mirai login` | OP | | miraimc.command.mirai.logout | Allow `/mirai logout` | OP | | miraimc.command.mirai.list | Allow `/mirai list` | OP | | miraimc.command.mirai.sendfriendmessage | Allow `/mirai sendfriendmessage` | OP | | miraimc.command.mirai.sendfriendnudge | Allow `/mirai sendfriendnudge` | OP | | miraimc.command.mirai.sendgroupmessage | Allow `/mirai sendgroupmessage` | OP | | miraimc.command.mirai.checkonline | Allow `/mirai checkonline` | OP | | miraimc.command.mirai.autologin | Allow `/mirai autologin` | OP | | miraimc.command.miraimc | Allow use of `/miraimc` | OP | | miraimc.command.miraimc.* | Allow all subcommands of `/miraimc` | OP | | miraimc.command.miraimc.bind | Allow `/miraimc bind` and subcommands | OP | | miraimc.command.miraimc.reload | Allow `/miraimc reload` | OP | ## LICENSE [GNU Affero General Public License v3.0](https://github.com/DreamVoid/MiraiMC/blob/main/LICENSE) ## Acknowledgments Thanks to the following people/teams/projects for their contributions to MiraiMC! * [mamoe/mirai](https://github.com/mamoe/mirai): Powerful QQ robot support library, the core and foundation of MiraiMC. * [lucko/helper](https://github.com/lucko/helper): Provide MiraiMC with a solution to dynamically load the mirai core. * [brettwooldridge/HikariCP](https://github.com/brettwooldridge/HikariCP): An efficient SQL connection pool, providing database connection solutions for MiraiMC. * [Anon8281/UniversalScheduler](https://github.com/Anon8281/UniversalScheduler): Provide MiraiMC with a solution for using asynchronous threads in Folia. * [LT_Name](https://github.com/lt-name): Optimized a lot of Nukkit code for MiraiMC, also provided a lot of help for MiraiMC. * You. [DreamVoid](https://github.com/DreamVoid) and [MiraiMC](https://github.com/MiraiMC), made with ❤. This file is a translated version of the [original file](https://github.com/DreamVoid/MiraiMC/blob/main/README.md), and some semantics may differ from the original file.