shinkuan / akagi Goto Github PK

View Code? Open in Web Editor NEW

265.0 3.0 35.0 53.96 MB

A helper client for Majsoul. Using Mortal AI model.

License: Other

Python 95.29% Batchfile 0.04% Shell 1.72% PowerShell 2.95%

game-ai japanese-mahjong mahjong mahjong-ai mahjong-bot majsoul majsoul-ai majsoul-plus riichi-mahjong

akagi's Introduction

Akagi

「死ねば助かるのに………」- 赤木しげる

Ask me anything about this at Discord

中文
 Report Bug . Request Feature

About The Project

"The purpose of this project is to provide people with a convenient way to real-time understand their performance in Majsoul game matches and to learn and improve from it. This project is intended for educational purposes only, and the author is not responsible for any actions taken by users using this project. Majsoul officials may detect abnormal behavior, and any consequences such as account suspension are not related to the author."

Akagi.mp4

Usage

Flowchart

Setup

Installation.

YouTube Video for you to follow.

You will need:

A mortal.pth. (Get one from Discord server if you don't have one.)
(Optional, Recommend) Use Windows Terminal to open client.py for a nice looking TUI.
(Optional) If you want to use Steam, Majsoul Plus, or anything other client, proxy the client using tools like proxifier.

Get mortal.pth at Discord

Go to #verify and click the ✅ reaction.
Go to #bot-zip
Download a bot you like.
Extract the zip.
And mortal.pth is there.

Akagi:

Windows

Download install_akagi.ps1 at Release

Put install_akagi.ps1 at the location you want to install Akagi.
Open Powershell as Administrator
cd in to the directory
Run: Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
Run: install_akagi.ps1
Open mitmproxy if this is your first time using it.
Close it.
Go to your user home directory ~/.mitmproxy
Install the certificate.
Put mortal.pth into ./Akagi/mjai/bot

Mac

Download install_akagi.command from Release

Place install_akagi.command in the location where you want to install Akagi.
Download the latest Python installation package from the Python official website and install it (skip this step if you already have a compatible version of Python installed).
Open Terminal and cd to the directory where install_akagi.command is located.
Execute: bash install_akagi.command
After installation is complete, enter the Akagi folder.
Double-click run_agaki.command to start Akagi.
If you are using mitmproxy for the first time, click on "start mitm".
Close it.
Go to your user home directory ~/.mitmproxy.
Install the certificate.
Put mortal.pth into ./Akagi/mjai/bot.

settings.json

Unlocker: Decide to use MajsoulUnlocker or not.
v10: If your Majsoul client in still in v0.10.x and you want to use MajsoulUnlocker, set it to true.
Autoplay: Autoplay.
Helper: To use mahjong-helper or not
Autohu: Auto Ron.
Port:
- MITM: The MITM Port, you should redirect Majsoul connection to this port.
- XMLRPC: The XMLRPC Port.
- MJAI: The port bind to MJAI bot container.
Playwright:
- enable: Enable the playwright
- width: width of the viewport of playwright
- height: height of the viewport of playwright
The rest are the setting for MajsoulUnlocker.

Instructions

Main Screen

You can see that there are two flows here, usually the top one is the "Lobby" websocket flow, and the bottom one is the "Game" websocket flow which appears after you join a match.

Click on the bottom flow to start. (It can take a while, click once and wait, don't click it for multiple times)

Flow Screen

After you are in the Flow Screen, this is what you should see. On top left is the LiqiProto Message we captured using MITM. The LiqiProto Message is then transcribe to mjai format and send to the bot(AI).

On top right is the MJAI Messages, this is the message our bot sent back to us, indicating the action we should do.

Then below is our tehai, it is composed using unicode characters.

Bottom left is the settings.

Bottom right is the bot's action.

How to keep your account safe

Following guide can minimum the probility of account suspension.

Don't use steam, use web instead.
Use safe_code.js from Majsoul Mod Plus
Don't use MajsoulUnlocker as it modifies websocket.
Don't use autoplay, play it yourself.
Try to use stickers often.
Don't completely follow what bot told you to do.
Don't play 24hr a day using autoplay.

There is no way to guarantee 100% no account suspension currently.

TODO

Need Help!

Any PR is welcomed.
Tell me if the MajsoulUnlocker is working well, is there any trace about we modified the message leaked to Majsoul server?
A stable and safe way to autoplay.
Report any bug you encounter.
Share your bot.zip if it is good.

Authors

Shinkuan - Shinkuan

Support me

Donating is optional, and the full functionality of this program is avaliable even without a donation.

ETH Mainnet: 0x83095C4355E43bDFe9cEf2e439F371900664D41F

Paypal or Others: Contact me on Discord.

You can find me at Discord.

What can I get after donating?

Firstly, thank you very much for your willingness to support the author.

I will prioritize the opinions of donors, such as feature requests and bug fixes.

Next, you can find me on Discord, where I will assign you a donor role.

Special Thanks

Equim-chan/Mortal

Majsoul Mod Plus

mahjong-helper

MahjongRepository/mahjong_soul_api

smly/mjai.app

LICENSE

“Commons Clause” License Condition v1.0

The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.

Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.

For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.

Software: Akagi

License: GNU Affero General Public License version 3 with Commons Clause

Licensor: shinkuan

akagi's People

Contributors

Stargazers

Watchers

akagi's Issues

Sorry for writing here. I can't join Discord because invitation has expired.

I apologize again for writing here. I can't access Discord. Is it possible to solve this problem?

活动场问题

在某些不影响主要游戏规则的活动场（如宝牌狂热或龙之目玉），轮到自己当庄会存在读牌与autoplay失效，我不知道1.6版本是否修复了，如已修复请关闭
Desktop (please complete the following information):

OS: [Windows]
Browser [chrome]
Version [1.5.0]

macOS端安装时的python版本问题

Describe the bug
在macOS端进行安装时，反复遇到报错：”Python version is not in the acceptable range. Please install Python between 3.10 and 3.12.”

使用conda配置了3.10.0, 3.11.x, 3.12.x三个环境进行安装，都出现同样的报错。在安装结束后，文件夹下缺失mitm，并有如下报错：

To Reproduce
进行安装就会出现问题，在我的机器上稳定复现。

autoplay时点击的坐标错误问题，

autopaly打开后每次点击的位置大概都在上家头像的位置

运行过程中报错

╭───────────────────────────────────────── Traceback (most recent call last) ──────────────────────────────────────────╮
│ E:\Akagi\client.py:470 in get_messages                                                                               │
│                                                                                                                      │
│   467 │   │   │   │   │   if liqi_msg['method'] == '.lq.FastTest.authGame' and liqi_msg['type'                       │
│   468 │   │   │   │   │   │   self.app.push_screen(FlowScreen(flow_id))                                              │
│   469 │   │   │   │   │   │   pass                                                                                   │
│ ❱ 470 │   │   │   │   │   mjai_msg = self.bridge[flow_id].input(self.four_mjai_client, liqi_ms                       │
│   471 │   │   │   │   │   if mjai_msg is not None:                                                                   │
│   472 │   │   │   │   │   │   if self.bridge[flow_id].reach and mjai_msg["type"] == "dahai":                         │
│   473 │   │   │   │   │   │   │   mjai_msg["type"] = "reach"                                                         │
│                                                                                                                      │
│ ╭───────────────────────────────────────────────────── locals ─────────────────────────────────────────────────────╮ │
│ │  flow_id = '2c6204bd-b88c-4796-bf76-eb7b4ab3c13a'                                                                │ │
│ │ liqi_msg = {                                                                                                     │ │
│ │            │   'id': -1,                                                                                         │ │
│ │            │   'type': <MsgType.Notify: 1>,                                                                      │ │
│ │            │   'method': '.lq.ActionPrototype',                                                                  │ │
│ │            │   'data': {                                                                                         │ │
│ │            │   │   'step': 12,                                                                                   │ │
│ │            │   │   'name': 'ActionDiscardTile',                                                                  │ │
│ │            │   │   'data': {                                                                                     │ │
│ │            │   │   │   'seat': 1,                                                                                │ │
│ │            │   │   │   'tile': '8s',                                                                             │ │
│ │            │   │   │   'moqie': True,                                                                            │ │
│ │            │   │   │   'isLiqi': False,                                                                          │ │
│ │            │   │   │   'zhenting': False,                                                                        │ │
│ │            │   │   │   'tingpais': [],                                                                           │ │
│ │            │   │   │   'doras': [],                                                                              │ │
│ │            │   │   │   'isWliqi': False,                                                                         │ │
│ │            │   │   │   'tileState': 0,                                                                           │ │
│ │            │   │   │   'revealed': False,                                                                        │ │
│ │            │   │   │   ... +2                                                                                    │ │
│ │            │   │   }                                                                                             │ │
│ │            │   }                                                                                                 │ │
│ │            }                                                                                                     │ │
│ │ messages = b'\x01\n\x13.lq.ActionPrototype\x12%\x08\x0c\x12\x11ActionDiscardTile\x1a\x0e\x95}ch^\xa7N\x9cu\xcb\… │ │
│ │ mjai_msg = None                                                                                                  │ │
│ │     self = Akagi(title='Akagi', classes={'-dark-mode'})                                                          │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
│                                                                                                                      │
│ E:\Akagi\majsoul2mjai.py:208 in input                                                                                │
│                                                                                                                      │
│   205 │   │   │   │   │   │   self.my_tsumohai = "?"                                                                 │
│   206 │   │   │   │   │   else:                                                                                      │
│   207 │   │   │   │   │   │   self.my_tehais.append("?")                                                             │
│ ❱ 208 │   │   │   │   │   self.my_tehais.remove(pai)                                                                 │
│   209 │   │   │   │   │   self.my_tehais = sorted(self.my_tehais, key=cmp_to_key(compare_pai))                       │
│   210 │   │   │   # Reach                                                                                            │
│   211 │   │   │   if parse_msg['data']['name'] == 'ActionReach':                                                     │
│                                                                                                                      │
│ ╭──────────────────────────────────── locals ────────────────────────────────────╮                                   │
│ │       actor = 1                                                                │                                   │
│ │ mjai_client = [                                                                │                                   │
│ │               │   <mjai.player.MjaiPlayerClient object at 0x000001B6F9203C50>, │                                   │
│ │               │   <mjai.player.MjaiPlayerClient object at 0x000001B6F9203910>, │                                   │
│ │               │   <mjai.player.MjaiPlayerClient object at 0x000001B6F9200E90>, │                                   │
│ │               │   <mjai.player.MjaiPlayerClient object at 0x000001B6F9206E90>  │                                   │
│ │               ]                                                                │                                   │
│ │         pai = '8s'                                                             │                                   │
│ │   parse_msg = {                                                                │                                   │
│ │               │   'id': -1,                                                    │                                   │
│ │               │   'type': <MsgType.Notify: 1>,                                 │                                   │
│ │               │   'method': '.lq.ActionPrototype',                             │                                   │
│ │               │   'data': {                                                    │                                   │
│ │               │   │   'step': 12,                                              │                                   │
│ │               │   │   'name': 'ActionDiscardTile',                             │                                   │
│ │               │   │   'data': {                                                │                                   │
│ │               │   │   │   'seat': 1,                                           │                                   │
│ │               │   │   │   'tile': '8s',                                        │                                   │
│ │               │   │   │   'moqie': True,                                       │                                   │
│ │               │   │   │   'isLiqi': False,                                     │                                   │
│ │               │   │   │   'zhenting': False,                                   │                                   │
│ │               │   │   │   'tingpais': [],                                      │                                   │
│ │               │   │   │   'doras': [],                                         │                                   │
│ │               │   │   │   'isWliqi': False,                                    │                                   │
│ │               │   │   │   'tileState': 0,                                      │                                   │
│ │               │   │   │   'revealed': False,                                   │                                   │
│ │               │   │   │   ... +2                                               │                                   │
│ │               │   │   }                                                        │                                   │
│ │               │   }                                                            │                                   │
│ │               }                                                                │                                   │
│ │        self = <majsoul2mjai.MajsoulBridge object at 0x000001B6F9386910>        │                                   │
│ │   tsumogiri = True                                                             │                                   │
│ ╰────────────────────────────────────────────────────────────────────────────────╯                                   │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
ValueError: list.remove(x): x not in list

win11下频发，不知道原因，感觉可能是因为我把docker镜像目录迁移了所以不太稳定（？

你好，请问那个bot.zip在哪里呀，我没有在discord里找到

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

Go to '...'
Click on '....'
Scroll down to '....'
See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]
Browser [e.g. chrome, safari]
Version [e.g. 22]

Smartphone (please complete the following information):

Device: [e.g. iPhone6]
OS: [e.g. iOS8.1]
Browser [e.g. stock browser, safari]
Version [e.g. 22]

Additional context
Add any other context about the problem here.

今早发的lssues被屏蔽了

使用mitm自带的chrome加载游戏非常非常慢

进入游戏界面就要20-30分钟，进入对局常常卡在整理牌桌78%，要10-20分钟才能进入对局。很多贴图加载不出来，看起来像是网速很慢的样子。但是用我自己的浏览器就不会这样。请问这是怎么回事呢

Setup Issue: MJAI Not Responding To POST Requests

Describe the bug
I get this bug when starting a friendly game in web browser

I get a Remote Disconnection error on the terminal when entering a game.

I started up my own docker instances from akagi.log and I can do GET request with 200 OK. But the code always fails when attempting this POST request:

[{"type": "start_game", "id": 2}]

I cannot do POST requests to my docker instances with the above payload (and neither can the code in player.py react function.

I think the MJAI Server is not setup properly or something?

To Reproduce
Steps to reproduce the behavior:

Run python mitm_playwright.py
Run Proxifier
Run python client.py
Start a friendly game with AI bots

Expected behavior
The client.py terminal to show the normal screen reading information for the game.

Screenshots
Full Error:

Docker instances:

MITM Running correctly:

Proxifier setup:

Web browser playing the game from playwright:

Desktop (please complete the following information):

OS: Windows
Browser: Chrome

Additional context
I debugged the problem to the following:

要不要考虑把三麻需要的 libriichi 直接放在源代码里？

我发现群里三麻安装对有些人比较困难，要不要考虑一下直接把三麻的libriichi包含在repo里，只需下载三麻的模型文件就能用？

例如这样：
https://github.com/latorc/MahjongCopilot/tree/main/libriichi3p

EngineRuntimeError

C:\Users\akgai\Akagi\mjai\player.py:218 in react │
│ │
│ 215 │ │ except requests.Timeout: │
│ 216 │ │ │ raise TimeoutExpired(self.player_id) │
│ 217 │ │ except Exception as e: │
│ ❱ 218 │ │ │ raise EngineRuntimeError(f"RuntimeError: {str(e)}", self.player_id) │
│ 219 │ │ │
│ 220 │ │ return outs │
│ 221 │
│ │
│ ╭───────────────────────────────────── locals ─────────────────────────────────────╮ │
│ │ events = '[{"type": "start_game", "id": 2}]' │ │
│ │ input_data = b'[{"type": "start_game", "id": 2}]' │ │
│ │ self = <mjai.player.MjaiPlayerClient object at 0x00000191C404EDD0> │ │
│ │ timeout_per_action = 100.0 │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────╯ │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
EngineRuntimeError: ("RuntimeError: ('Connection aborted.', RemoteDisconnected('Remote end closed connection without
response'))", 2)

autoplay在吃碰杠立/跳过选择的时候有时候定位不准

autoplay会出现我lichi之后，别人lichi打出来的第一张牌不胡别人

出现了两次，大概是log的 1月25日19:25 左右
akagi.log

shinkuan / akagi Goto Github PK

akagi's Introduction

Akagi

About The Project

Usage

Flowchart

Setup

Installation.

You will need:

Akagi:

Windows

Mac

settings.json

Instructions

Main Screen

Flow Screen

How to keep your account safe

There is no way to guarantee 100% no account suspension currently.

TODO

Need Help!

Authors

Support me

Donating is optional, and the full functionality of this program is avaliable even without a donation.

What can I get after donating?

See Also

Special Thanks

LICENSE

akagi's People

Contributors

Stargazers

Watchers

Forkers

akagi's Issues

Recommend Projects

Recommend Topics

Recommend Org