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)

1. Download MiraiMC from "Featured versions" part. Then install it like installing other plugins.
2. 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

Permissions

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.