MajsoulAI项目旨在实现在《雀魂》中用AI代替玩家打麻将。MajsoulAI前端使用majsoul_wrapper通过监听《雀魂》websocket对局信息作为输入，以基于图像识别的模拟鼠标点击作为输出。MajsoulAI后端桥接至一个开源的天凤麻将AI(JianYangAI)。
运行时环境推荐使用Python Virtual Environment，以Win10系统python 3.7.7版本为例，首先建立一个venv环境并激活：
$python -m venv ./venv
$cmd
$.\venv\Scripts\activate.bat然后安装必要的依赖：
$python -m pip install --upgrade pip
$pip install -r requirements.txt一个特殊的依赖是pytorch，由于其版本与安装方式经常变化，建议参考官网选择合适的版本的安装命令，例如当前最新的Windows-Pip-Cuda10.2对应的安装命令为：
$pip install torch===1.7.1 torchvision===0.8.2 torchaudio===0.7.2 -f https://download.pytorch.org/whl/torch_stable.html完成上述操作后后理论上即可用该虚拟环境完成后续操作。
MajsoulAI与雀魂的交互依托majsoul_wrapper，我们强烈建议在运行之前阅读majsoul_wrapper的使用说明，里面讲述了交互过程的细节包括如何获取局面信息与如何施加动作到浏览器。
在安装完成majsoul_wrapper之后，一切都将变得水到渠成，因为这个项目并没有什么其他需要安装的了。
运行之前首先需要启动mitmproxy：
$python -m majsoul_wrapper或在majsoul_wrapper目录里执行：
./majsoul_wrapper$ mitmdump -s addons.py此时你应该可以看到一个新启动的Chrome，在这个Chrome窗口里打开雀魂并登陆至主界面（目前雀魂国际化版本只支持繁体中文，简体的button定位未实现）。由于MajsoulAI是基于图像识别的，所以接下来AI启动与运行时需始终保持mitmproxy存活，且校准过程中保持雀魂主界面（段位場、比賽場、友人場）始终完整的置于屏幕顶层（位置与大小不重要，不是太小即可），并且AI一旦确认了浏览器坐标进入运行模式后不能再变更浏览器位置（否则将会点击错误的屏幕坐标）。
MajsoulAI支持两种AI调用模式。一种在本地启动AI，并通过IPC进行数据通信；另一种可以将AI托管在一个有公网IP的远程服务器，并通过网络通信调用AI（远程AI模式会更快，因为本地还需渲染雀魂页面，计算开销较大）。
本地AI模式可直接输入：
$python main.py远程AI模式下，需先在远程服务器上clone MajsoulAI，并打开AI服务进程：
$python remote.py该进程将持续监听14782端口等待客户端连接，然后在本机以remote模式运行客户端进程：
$python main.py --remote_ip REMOTE_ADDRESS成功之后你将看到AI接入的信息。
Majsoul同时支持自动匹配模式与手动匹配模式两种方式，以-l或--level参数区分。手动匹配是默认模式，需在AI启动并校准界面以后，手动选择要进行的对局，当对局开始后AI将自动唤醒并接管鼠标操作；自动模式下AI将从主菜单开始，无限的循环进行段位场匹配。
手动AI模式：
$python main.py自动AI模式：
$python main.py --level L数字L可选值为{0,1,2,3,4}，分别对应{铜/银/金/玉/王座之间}
上述两种模式可以自由搭配，例如在远程服务器173.252.110.21上启动远程AI，并持续进行银之间段位场匹配，那么应在远程服务器启动remote.py后在本地执行：
$python main.py --remote_ip 173.252.110.21 --level 1至此你就可以看到自主出牌的雀魂AI了！