Không có mô tả

Him188 c573bb8a5b [core] 更新 `MiraiProtocol` 注释, 注明 `ANDROID_WATCH` 不支持戳一戳, 删除 `ANDROID_PAD` 的错误注释 (#2572) 2 năm trước cách đây
.github 8836ca9d12 workflow force 2 năm trước cách đây
.idea 1acf51e308 Update copyright in README and code template to 2023 2 năm trước cách đây
.run 35866143f8 [build] Add IDEA Run Configuration: Dump API Changes for mirai-console-frontend-base 2 năm trước cách đây
buildSrc ca9c1f59e0 Version 2.15.0-M1 2 năm trước cách đây
ci-release-helper e81de8a581 rerun 2 năm trước cách đây
docs ba03bd472c typo: 群参数说明 (#2577) 2 năm trước cách đây
gradle d7a7a5044b [build] Delete unused Groovy code 2 năm trước cách đây
logging 1844d19602 [core/logging] Bind slf4j to 2.x; Bump log4j to 2.19.0 2 năm trước cách đây
mirai-bom 889a78e572 [publish] Delete GpgSigner 2 năm trước cách đây
mirai-console 427c37e649 [build] Update to Kotlin 1.8.10 2 năm trước cách đây
mirai-core 427c37e649 [build] Update to Kotlin 1.8.10 2 năm trước cách đây
mirai-core-all cc7f35519e Update login protocol (#2433) 2 năm trước cách đây
mirai-core-api c573bb8a5b [core] 更新 `MiraiProtocol` 注释, 注明 `ANDROID_WATCH` 不支持戳一戳, 删除 `ANDROID_PAD` 的错误注释 (#2572) 2 năm trước cách đây
mirai-core-mock 427c37e649 [build] Update to Kotlin 1.8.10 2 năm trước cách đây
mirai-core-utils 427c37e649 [build] Update to Kotlin 1.8.10 2 năm trước cách đây
mirai-deps-test cc7f35519e Update login protocol (#2433) 2 năm trước cách đây
mirai-dokka d96641dedb Configure HMPP project structure 3 năm trước cách đây
.editorconfig 476a9fa3d7 editorconfig: add config for Markdown wrap text 3 năm trước cách đây
.gitattributes ad1d75687a Update `.gitattributes` 3 năm trước cách đây
.gitignore 8663978d65 Add `RecordingNoticeProcessor` 4 năm trước cách đây
CONTRIBUTING.md a8e90c6e89 [skip ci] Create CONTRIBUTING.md 2 năm trước cách đây
LICENSE adf0299c5d Original AGPLv3 5 năm trước cách đây
README-eng.md aa98a10d12 Migrate references in docs 3 năm trước cách đây
README.md 1acf51e308 Update copyright in README and code template to 2023 2 năm trước cách đây
build.gradle.kts 427c37e649 [build] Update to Kotlin 1.8.10 2 năm trước cách đây
gradle.properties 3bcdf9b640 Optimize gradle properties 3 năm trước cách đây
gradlew 78ae44d0e6 Add gradlew executable permission (#972) 4 năm trước cách đây
gradlew.bat 78ae44d0e6 Add gradlew executable permission (#972) 4 năm trước cách đây
install.sh ff2a8acb0c Implement multiplatform modules 3 năm trước cách đây
settings.gradle.kts 2db9804cf2 Mock Testing Framework (#1521) 2 năm trước cách đây

README-eng.md

Mirai

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.

Start

Development documentdocs

Use as a framework

Mirai is able to run as a plugin-supported framework.
The community, (with mirai-console) that allows developers to share their plugins, and for users to install plugins quickly, is building in progress.

  • JVM languages like Java or Kotlin: Make Jar plugin for mirai-console directly and share with other developers through the plugin center.
  • Kotlin Scriptmirai-kts supports plugins using Kotlin Scripts (kts)(OpenJDK 8+ only,except Android
  • Native languages like C, C++mirai-native supports plugins from CoolQ (Windows JREx86 only / with Wine)
  • JavaScriptmirai-js supports plugins using JavaScript and inter-operate with mirai on JVM directly.
  • Any language:Use HTTP API from mirai-api-http

Though only Jar plugins are supported officially, language bridges that are maintained by the community can connect with your knowledge.:

  • Python: python-mirai A Bot framework based on mirai-api-http.
  • JavaScript(Node.js): node-mirai The Node.js SDK for mirai.
  • Go: gomirai The GoLang SDK for mirai.
  • Mozilla Rhino: mirai-rhinojs-sdk The Mozilla Rhino (JavaScript) SDK for mirai.
  • Lua: lua-mirai The Lua SDK for mirai-core, supporting Java extensions that act as a bridge between Java and native Lua.
  • C++: miraiCP A C++ SDK using the JNI technique to connect the Mirai.
  • C++: mirai-cpp A simple C++ SDK using mirai-api-http for ALL platforms.
  • C++: miraipp A sophisticated, modern mapping for mirai-http-api to C++, providing development documents.
  • Rust: mirai-rs The Rust mapping for mirai-http-api.
  • TypeScript: mirai-ts TypeScript SDK comes with a declaration file, has good code hints, and can also be used as a JavaScript SDK.

Use as a library

You can install mirai as a library into your project.

Import with Gradle

Mirai is only published on jcenter, therefore please ensure you have the jcenter() repository added in your build.gradle.

repositories{
  jcenter()
}

Then add dependency to dependencies block, following:
If your project is a multiplatform project, you need to add dependencies for each platform respectively.
If your project is not a multiplatform project, add the platform-specific dependency only.

Replace VERSION with the newest version, say Download

jvm

implementation("net.mamoe:mirai-core:VERSION")

common

implementation("net.mamoe:mirai-core-common:VERSION")

android

implementation("net.mamoe:mirai-core-android:VERSION")

Import with Maven

<repositories>
    <repository>
        <id>jcenter</id>
        <url>https://jcenter.bintray.com/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>net.mamoe</groupId>
        <artifactId>mirai-core-qqandroid</artifactId>
        <version>0.23.0</version> <!-- Replace to the newest -->
    </dependency>
</dependencies>

Contribution

All kinds of contributions are welcomed.
If you hold an interest in helping us implementing Mirai on JS, iOS or Native platforms, please email us support@mamoe.net.
If you meet any problem or have any questions, feel free to file an issue. Our goal is to make Mirai easy to use.

Acknowledgements

Thanks to JetBrains for allocating free open-source licences for IDEs such as IntelliJ IDEA.

License

Copyright (C) 2019-2021 Mamoe Technologies and mirai contributors

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.