{"id":13440185,"url":"https://github.com/mamoe/mirai","last_synced_at":"2025-05-08T23:34:54.618Z","repository":{"id":37431681,"uuid":"201025777","full_name":"mamoe/mirai","owner":"mamoe","description":"高效率 QQ 机器人支持库","archived":false,"fork":false,"pushed_at":"2024-09-23T11:25:50.000Z","size":96914,"stargazers_count":14761,"open_issues_count":287,"forks_count":2543,"subscribers_count":137,"default_branch":"dev","last_synced_at":"2025-05-08T20:53:45.542Z","etag":null,"topics":["chatbot","java","kotlin","mirai"],"latest_commit_sha":null,"homepage":"https://mirai.mamoe.net","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mamoe.png","metadata":{"files":{"readme":"README-eng.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-07T10:14:28.000Z","updated_at":"2025-05-08T14:38:38.000Z","dependencies_parsed_at":"2022-07-13T10:30:32.884Z","dependency_job_id":"5eae78c1-f119-47f2-b973-4c6b782a0350","html_url":"https://github.com/mamoe/mirai","commit_stats":{"total_commits":7744,"total_committers":140,"mean_commits":55.31428571428572,"dds":"0.25619834710743805","last_synced_commit":"f7649d225d8740f411a4634eba4128e7f740c122"},"previous_names":[],"tags_count":330,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamoe%2Fmirai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamoe%2Fmirai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamoe%2Fmirai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamoe%2Fmirai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mamoe","download_url":"https://codeload.github.com/mamoe/mirai/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253155198,"owners_count":21862653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","java","kotlin","mirai"],"created_at":"2024-07-31T03:01:20.502Z","updated_at":"2025-05-08T23:34:54.596Z","avatar_url":"https://github.com/mamoe.png","language":"Kotlin","funding_links":[],"categories":["HarmonyOS","Kotlin","机器人","Other AI Tools","网络服务"],"sub_categories":["Windows Manager","网络服务_其他"],"readme":"# Mirai\n\nMirai is a high-performance multi-platform library, as well as a framework, providing protocol support for Tencent QQ.\n\nMirai is designed to handle all sorts of messaging works that can be automatically done by bots **in a perfect way**.\n\n\u003e Tencent QQ: A modern messaging software used by all Chinese netizens.\n\n## Start\n**Development document**： [docs](docs)\n\n### Use as a framework\n\nMirai is able to run as a plugin-supported framework.  \nThe community, (with `mirai-console`) that allows developers to share their plugins, and for users to install plugins quickly, is building in progress.\n\n- JVM languages like `Java` or `Kotlin`： Make Jar plugin\n  for [mirai-console](/mirai-console) directly and share with other\n  developers through the plugin center.\n- `Kotlin Script`： [mirai-kts](https://github.com/iTXTech/mirai-kts)\n  supports plugins using Kotlin Scripts (`kts`)（**OpenJDK 8+ only，except\n  Android**）\n- Native languages like `C`, `C++`： [mirai-native](https://github.com/iTXTech/mirai-native) supports plugins from CoolQ **(`Windows JREx86` only / with `Wine`)**\n- `JavaScript`： [mirai-js](https://github.com/iTXTech/mirai-js) supports plugins using `JavaScript` and inter-operate with **mirai** on JVM directly.\n- Any language：Use HTTP API from [mirai-api-http](https://github.com/mamoe/mirai-api-http)\n\n**Though only Jar plugins are supported officially, language bridges that are maintained by the community can connect with your knowledge.**:\n\n- `Python`: [python-mirai](https://github.com/NatriumLab/python-mirai) A Bot framework based on `mirai-api-http`.\n- `JavaScript`(`Node.js`): [node-mirai](https://github.com/RedBeanN/node-mirai) The Node.js SDK for mirai.\n- `Go`: [gomirai](https://github.com/Logiase/gomirai) The GoLang SDK for mirai.\n- `Mozilla Rhino`: [mirai-rhinojs-sdk](https://github.com/StageGuard/mirai-rhinojs-sdk) The Mozilla Rhino (JavaScript) SDK for mirai.\n- `Lua`: [lua-mirai](https://github.com/only52607/lua-mirai) The Lua SDK for mirai-core, supporting Java extensions that act as a bridge between Java and native Lua.\n- `C++`: [miraiCP](https://github.com/Nambers/MiraiCP) A C++ SDK using the `JNI` technique to connect the Mirai.\n- `C++`: [mirai-cpp](https://github.com/cyanray/mirai-cpp) A simple C++ SDK using `mirai-api-http` for ALL platforms.\n- `C++`: [miraipp](https://github.com/Chlorie/miraipp-template) A sophisticated, modern mapping for `mirai-http-api` to C++, providing development documents.\n- `Rust`: [mirai-rs](https://github.com/HoshinoTented/mirai-rs) The Rust mapping for `mirai-http-api`.\n- `TypeScript`: [mirai-ts](https://github.com/YunYouJun/mirai-ts) TypeScript SDK comes with a declaration file, has good code hints, and can also be used as a JavaScript SDK.\n\n### Use as a library\nYou can install mirai as a library into your project.\n\n#### Import with Gradle\n\nMirai is only published on `jcenter`, therefore please ensure you have the `jcenter()` repository added in your `build.gradle`.\n\n```kotlin\nrepositories{\n  jcenter()\n}\n```\n\nThen add dependency to `dependencies` block, following:  \nIf your project is a multiplatform project, you need to add dependencies for each platform respectively.  \nIf your project is not a multiplatform project, add the platform-specific dependency only.\n\nReplace `VERSION` with the newest version, say [![Download](https://api.bintray.com/packages/him188moe/mirai/mirai-core/images/download.svg)](https://bintray.com/him188moe/mirai/mirai-core/)\n\n**jvm**\n```kotlin\nimplementation(\"net.mamoe:mirai-core:VERSION\")\n```\n**common**\n```kotlin\nimplementation(\"net.mamoe:mirai-core-common:VERSION\")\n```\n**android**\n```kotlin\nimplementation(\"net.mamoe:mirai-core-android:VERSION\")\n```\n\n#### Import with Maven\n\n```xml\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003ejcenter\u003c/id\u003e\n        \u003curl\u003ehttps://jcenter.bintray.com/\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n```\n\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003enet.mamoe\u003c/groupId\u003e\n        \u003cartifactId\u003emirai-core-qqandroid\u003c/artifactId\u003e\n        \u003cversion\u003e0.23.0\u003c/version\u003e \u003c!-- Replace to the newest --\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n## Contribution\n**All kinds of contributions are welcomed.**  \nIf you hold an interest in helping us implementing Mirai on JS, iOS or Native platforms, please email us `support@mamoe.net`.  \nIf you meet any problem or have any questions, feel free to file an issue. Our goal is to make Mirai easy to use.\n\n## Acknowledgements\n\nThanks to [JetBrains](https://www.jetbrains.com/?from=mirai) for allocating free open-source licences for IDEs such as [IntelliJ IDEA](https://www.jetbrains.com/idea/?from=mirai).  \n[\u003cimg src=\".github/jetbrains-variant-3.png\" width=\"200\"/\u003e](https://www.jetbrains.com/?from=mirai)\n\n## License\n\n    Copyright (C) 2019-2021 Mamoe Technologies and mirai contributors\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU Affero General Public License as\n    published by the Free Software Foundation, either version 3 of the\n    License, or (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU Affero General Public License for more details.\n\n    You should have received a copy of the GNU Affero General Public License\n    along with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmamoe%2Fmirai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmamoe%2Fmirai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmamoe%2Fmirai/lists"}