MiraiMC

A mirai bot for Minecraft servers.

5.3K Downloads

bukkitbungeecordfoliaforgepaperpurpurspigotspongevelocitywaterfalllibrarymanagement

Rent Server with this Mod

About this Mod

MiraiMC

GitHub all releases

MiraiMC is a 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
- Gradle KotlinDSL
MiraiMC javadoc here: https://jd.miraimc.dreamvoid.me
Detailed development tutorial here: https://docs.miraimc.dreamvoid.me/

Dependency

Maven

<dependency>
    <groupId>io.github.dreamvoid</groupId>
    <artifactId>MiraiMC-Integration</artifactId>
    <version>1.9</version>
    <scope>provided</scope>
</dependency>

Gradle

implementation 'io.github.dreamvoid:MiraiMC-Integration:1.9'

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

Acknowledgments

Thanks to the following people/teams/projects for their contributions to MiraiMC!

mamoe/mirai: Powerful QQ robot support library, the core and foundation of MiraiMC.
lucko/helper: Provide MiraiMC with a solution to dynamically load the mirai core.
brettwooldridge/HikariCP: An efficient SQL connection pool, providing database connection solutions for MiraiMC.
LT_Name: Optimized a lot of Nukkit code for MiraiMC, also provided a lot of help for MiraiMC.
You.

DreamVoid and MiraiMC, made with ❤.

This file is a translated version of the original file, and some semantics may differ from the original file.

Available Versions

1.9.2release

MC 1.0, 1.1, 1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.2.5, 1.3, 1.3.1, 1.3.2, 1.4, 1.4.2, 1.4.4, 1.4.5, 1.4.6, 1.4.7, 1.5, 1.5.1, 1.5.2, 1.6, 1.6.1, 1.6.2, 1.6.4, 1.7, 1.7.2, 1.7.3, 1.7.4, 1.7.5, 1.7.6, 1.7.7, 1.7.8, 1.7.9, 1.7.10, 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4, 1.10, 1.10.1, 1.10.2, 1.11, 1.11.1, 1.11.2, 1.12, 1.12.1, 1.12.2, 1.13, 1.13.1, 1.13.2, 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8velocity

August 11, 2025

1.9.2release

August 11, 2025

1.9.2release

August 11, 2025

1.9.2release

August 11, 2025

1.9.1release

MC 1.0, 1.1, 1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.2.5, 1.3.1, 1.3.2, 1.4.2, 1.4.4, 1.4.5, 1.4.6, 1.4.7, 1.5.1, 1.5.2, 1.6.1, 1.6.2, 1.6.4, 1.7.2, 1.7.3, 1.7.4, 1.7.5, 1.7.6, 1.7.7, 1.7.8, 1.7.9, 1.7.10, 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4, 1.10, 1.10.1, 1.10.2, 1.11, 1.11.1, 1.11.2, 1.12, 1.12.1, 1.12.2, 1.13, 1.13.1, 1.13.2, 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.15, 1.15.1, 1.15.2, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.17, 1.17.1, 1.18, 1.18.1, 1.18.2, 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7bukkit, bungeecord, folia, paper, purpur, spigot, sponge, velocity, waterfall

July 16, 2025

How to Install MiraiMC on Your Server

Order Server

Order a Minecraft Java server with at least 3 GB RAM (4 GB recommended).

Set bukkit Loader

In the panel under "Egg", select the bukkit loader and matching Minecraft version (1.21.11).

Install Mod

Open the mod browser in the dashboard and search for "MiraiMC". Click "Install" – done! Alternatively, upload the .jar via SFTP to the /mods folder.

Compatibility

Mod Loaders

bukkitbungeecordfoliaforgepaperpurpurspigotspongevelocitywaterfall

Minecraft Versions

1.21.11, 1.21.10, 1.21.9 (+104 more)

Server-side

✗ Unsupported

Recommended RAM

4 GB(min. 3 GB)

Frequently Asked Questions

MiraiMC server crashes on startup – what to do?

Most common cause: wrong bukkit version or insufficient RAM. Check the server log (latest.log) for "OutOfMemoryError" or "Mixin" errors. With Mado Hosting: ensure at least 3 GB RAM is allocated and the loader matches the mod version (1.21.11). You can switch loaders with one click in the panel.

Is MiraiMC compatible with bukkit and bungeecord and folia and forge and paper and purpur and spigot and sponge and velocity and waterfall?

MiraiMC officially supports bukkit, bungeecord, folia, forge, paper, purpur, spigot, sponge, velocity, waterfall for Minecraft 1.21.11, 1.21.10, 1.21.9. The Mado dashboard automatically detects incompatible loader combinations.

Server lagging with MiraiMC – how to optimize performance?

Recommended RAM: 4 GB (per 8 players). Use /spark profiler to check if MiraiMC consumes the most tick time. Common fixes: reduce server view-distance to 8-10, install "performant" or "starlight" as supplementary mods on Forge. With Mado Hosting, your server runs on NVMe SSDs with dedicated CPU cores for minimal latency.