{"id":13623749,"url":"https://github.com/latorc/MahjongCopilot","last_synced_at":"2025-04-15T20:32:15.074Z","repository":{"id":229933757,"uuid":"778050757","full_name":"latorc/MahjongCopilot","owner":"latorc","description":"雀魂游戏实时 AI 指导 / In-game step-by-step AI Assistant for Maj-soul","archived":false,"fork":false,"pushed_at":"2024-04-13T14:10:52.000Z","size":105625,"stargazers_count":45,"open_issues_count":5,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-14T04:23:02.633Z","etag":null,"topics":["mahjong-ai","majsoul"],"latest_commit_sha":null,"homepage":"https://mjcopilot.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/latorc.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"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},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":["https://github.com/shinkuan/Akagi/blob/main/README_CH.md#%E6%94%AF%E6%8C%81%E4%BD%9C%E8%80%85","https://github.com/shinkuan/Akagi?tab=readme-ov-file#support-me"]}},"created_at":"2024-03-27T01:28:26.000Z","updated_at":"2024-04-15T10:32:40.820Z","dependencies_parsed_at":"2024-04-13T15:37:15.688Z","dependency_job_id":null,"html_url":"https://github.com/latorc/MahjongCopilot","commit_stats":null,"previous_names":["latorc/mahjongcopilot"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/latorc%2FMahjongCopilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/latorc%2FMahjongCopilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/latorc%2FMahjongCopilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/latorc%2FMahjongCopilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/latorc","download_url":"https://codeload.github.com/latorc/MahjongCopilot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249148069,"owners_count":21220469,"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":["mahjong-ai","majsoul"],"created_at":"2024-08-01T21:01:35.227Z","updated_at":"2025-04-15T20:32:15.059Z","avatar_url":"https://github.com/latorc.png","language":"Python","funding_links":["https://github.com/shinkuan/Akagi/blob/main/README_CH.md#%E6%94%AF%E6%8C%81%E4%BD%9C%E8%80%85","https://github.com/shinkuan/Akagi?tab=readme-ov-file#support-me"],"categories":["Python"],"sub_categories":[],"readme":"# 麻将 Copilot / Mahjong Copilot\n\n麻将 AI 助手，基于 mjai (Mortal模型) 实现的机器人。会对游戏对局的每一步进行指导。现支持雀魂三人、四人麻将。\n\n加入QQ群：1031865144\n\u003cbr\u003e\nClick to \u003ca href=\"https://discord.gg/7hcZYTFw5r\" target=\"_blank\"\u003eJoin Discord\u003c/a\u003e\n\nMahjong AI Assistant for Majsoul, based on mjai (Mortal model) bot impelementaion. When you are in a Majsoul game, AI will give you step-by-step guidance. Now supports Majsoul 3-person and 4-person game modes.\n\n下载、帮助和更多信息请访问网站 Please see website for download, help, and more information  \n\u003ca href=\"https://mjcopilot.com/help\" target=\"_blank\"\u003e帮助信息 Help Info \u003c/a\u003e | \u003ca href=\"https://mjcopilot.com\" target=\"_blank\"\u003ehttps://mjcopilot.com\u003c/a\u003e\n\n---\n\n![](assets/shot3_lower.png)\n\n特性：\n\n- 对局每一步 AI 指导，可在游戏中覆盖显示\n- 自动打牌，自动加入游戏\n- 多语言支持\n- 支持本地 Mortal 模型和在线模型，支持三麻和四麻\n\nFeatures:\n\n- Step-by-step AI guidance for the game, with optional in-game overlay.\n- Auto play \u0026 auto joining next game\n- Multi-language support\n- Supports Mortal local models and online models, 3p and 4p mahjong modes.\n\n\u003ca id=\"instructions\"\u003e\u003c/a\u003e\n\n## 使用方法 / Instructions\n\n### 开发\n\n1. 克隆 repo\n2. 安装 Python 虚拟环境。Python 版本推荐 3.11.\n3. 安装 requirements.txt 中的依赖。\n4. 安装 Playwright + Chromium\n5. 主程序入口: main.py\n\n### To Develope\n\n1. Clone the repo\n2. Install Python virtual environment. Python version 3.11 recommended.\n3. Install dependencies from requirements.txt\n4. Install Playwright + Chromium\n5. Main entry: main.py\n\n### 示例脚本 Sample script：\n```batch\ngit clone https://github.com/latorc/MahjongCopilot.git\ncd MahjongCopilot\npython -m venv venv\nCALL venv\\Scripts\\activate.bat\npip install -r requirements.txt\nset PLAYWRIGHT_BROWSERS_PATH=0\nplaywright install chromium\npython main.py\n```\n### 配置模型\n本程序支持几种模型来源。其中，本地模型（Local）是基于 Akagi 兼容的 Mortal 模型。要获取 Akagi 的模型，请参见 \u003ca href=\"https://github.com/shinkuan/Akagi\" target=\"_blank\"\u003e Akagi Github \u003c/a\u003e 的说明。\n### Model Configuration\nThis program supports different types of AI models. The 'Local' Model type uses Mortal models compatible with Akagi. To acquire Akagi's models, please refer to \u003ca href=\"https://github.com/shinkuan/Akagi\" target=\"_blank\"\u003e Akagi Github \u003c/a\u003e.\n\n\n## 截图 / Screenshots\n\n界面 / GUI\n\n![](assets/shot1.png)\n![](assets/settings.png)\n\n游戏中覆盖显示 (HUD）/ In-game Overlay (HUD)\n\n![](assets/shot2.png)\n\n![](assets/shot3.png)\n\n## 设计 / Design\n\n![](assets/design_struct.png)\n\n  \n目录说明 Description for folders：\n* gui: tkinter GUI 相关类 / tkinter GUI related classes\n* game: 雀魂游戏相关类 / classes related to Majsoul game\n* bot: AI 模型和机器人实现 / implementations for AI models and bots \n* common: 共同使用的支持代码 commonly used supporting code\n* libriichi \u0026 libriichi3p: 编译完成的 libriichi 库文件 / For compiled libriichi libraries\n\n## 鸣谢 / Credit\n\n- 基于 Mortal 模型和 MJAI 协议\n  Based on Mortal Model an MJAI protocol\n  \n  Mortal: https://github.com/Equim-chan/Mortal\n- 设计和功能实现基于 Akagi\n  Design and implementation based on Akagi\n  \n  Akagi: https://github.com/shinkuan/Akagi\n- 参考 Reference\n  Mahjong Soul API: https://github.com/MahjongRepository/mahjong_soul_api\n- MJAI协议参考 / MJAI Protocol Reference\n  \n  MJAI: https://mjai.app\n\n## 许可 / License\n本项目使用 GNU GPL v3 许可协议。  \n协议全文请见 [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flatorc%2FMahjongCopilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flatorc%2FMahjongCopilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flatorc%2FMahjongCopilot/lists"}