Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shinkuan committed Jan 22, 2024
1 parent 1814a39 commit f03687c
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 24 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ https://github.com/shinkuan/RandomStuff/assets/35415788/ce1b598d-b1d7-49fe-a175-

[YouTube Video for you to follow.](https://youtu.be/ZN3qbMyZeus)

You will need:
### You will need:
1. Docker
2. Proxifier or something that can redirect connection to mitmproxy.
1. __Remember to trust mitmproxy's Certificate!!!__ Don't know how? Google it.
Expand All @@ -54,15 +54,25 @@ __Don't know how to make a bot.zip yourself? Don't worry!__

__Get bot.zip at [Discord](https://discord.gg/Z2wjXUK8bN)__

Docker:
### Docker:
1. Install Docker on your PC
2. `docker pull smly/mjai-client:v3`

Akagi:
### Akagi:

`install.bat` is found to have some problem on some machines.
Download `install_akagi.ps1` at [Release](https://github.com/shinkuan/Akagi/releases/latest)

I suggest you follow the [video](https://youtu.be/ZN3qbMyZeus).
1. Place `install_akagi.ps1` at the folder you want to install Akagi.
2. Open Powershell as admin.
3. Go to the folder.
4. To prevent your PC restrict from executing powershell script, run:
- `Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass`
5. Run `install_akagi.ps1`
6. put `bot.zip` into ./players folder

### if `install_akagi.ps1` not working for you:

Follow the [video](https://youtu.be/ZN3qbMyZeus).

1. `git clone this`
2. `cd into this repo`
Expand All @@ -72,10 +82,6 @@ I suggest you follow the [video](https://youtu.be/ZN3qbMyZeus).
6. `playwright install chromium`
7. put `bot.zip` into ./players folder

or
1. Run `install.bat`
2. put `bot.zip` into ./players folder

### Run

After you __activate the venv__:
Expand All @@ -92,6 +98,10 @@ After you __activate the venv__:
- `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
Expand Down Expand Up @@ -135,12 +145,12 @@ Following guide can minimum the probility of account suspension.
### There is no way to guarantee 100% no account suspension currently.

# TODO
- [ ] Change Setting inside application.
- [x] Autoplay - (Working now, but it is __not__ stable)
- [x] Change Setting inside application.
- [x] Autoplay
- [ ] Auto use stickers to make opponent think we are not a bot.
- [ ] Add random time in settings.json to let user choose time they want.
- [ ] Mix multiple AI's decision to make we more like a human but not a perfect bot.
- [ ] Reduce Startup time of the bot. (Maybe start it before match begin?)
- [x] Reduce Startup time of the bot. (Maybe start it before match begin?)
- [x] Intergrade with [MajsoulUnlocker](https://github.com/shinkuan/MajsoulUnlocker)
- [ ] Don't use MITM at all for the gameplay, use image recognition.
- [ ] Decide use what model
Expand All @@ -149,7 +159,7 @@ Following guide can minimum the probility of account suspension.
- [ ] Delta Score Recognition.
- [ ] Ryukyoku Recognition.
- [ ] Implement
- [ ] Easier installation.
- [x] Easier installation.

## Need Help!

Expand Down
33 changes: 22 additions & 11 deletions README_CH.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ https://github.com/shinkuan/RandomStuff/assets/35415788/ce1b598d-b1d7-49fe-a175-

## 教程

### 安裝, 建議觀看影片
### 安裝

[點我到Youtube觀看安裝影片](https://youtu.be/ZN3qbMyZeus)

Expand All @@ -54,10 +54,23 @@ Docker:

Akagi:

### 部分內容已過時:
### 影片部分內容已過時:
- 現在已經有自動化安裝 `install_akagi.ps1`
- 現在你不再需要安裝mjai
- 如果你想使用playwright記得安裝chromium: `playwright install chromium`

[Release](https://github.com/shinkuan/Akagi/releases/latest)下載`install_akagi.ps1`

1.`install_akagi.ps1`放到你想安裝的位置
2. 以管理員開啟Powershell
3. cd到安裝位置
4. 有些電腦會限制Powershell腳本的執行,這也是為什麼我們需要管理員權限,執行以下指令以讓腳本能夠運行:
- `Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass`
5. 執行 `install_akagi.ps1`
6.`bot.zip`放入 ./players

### 如果 `install_akagi.ps1` 有問題:

建議你跟著[影片](https://youtu.be/ZN3qbMyZeus)中的教學安裝。

1. 下載這個Repo到你電腦內,或在cmd輸入`git clone <repo>`
Expand All @@ -68,12 +81,6 @@ Akagi:
6. `playwright install chromium`
7. put `bot.zip` into ./players folder


`install.bat` 在某些電腦上可能會有問題,如果遇到問題,請改使用上面的方式安裝。
1. 執行`install.bat`
2.`bot.zip`放入 ./players

### 執行

**啟動venv**後:
Expand All @@ -90,6 +97,10 @@ Akagi:
- `MITM`: MITM Port, 你應該將雀魂連線導向到這個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.

## 如何使用
Expand Down Expand Up @@ -136,12 +147,12 @@ LiqiProto訊息隨後被轉錄為mjai格式並發送給機器人。

# TODO

- [ ] 在應用程式內更改Setting。
- [x] 在應用程式內更改Setting。
- [x] 自動打牌 - (能運作,但 ____ 穩定)
- [ ] 自動使用貼圖,讓對手認為我們不是機器人。
- [ ] 在settings.json中添加隨機時間,讓用戶選擇他們想要的時間。
- [ ] 混合多個AI的決策,讓我們看起來更像人類,而不是完美的機器人。
- [ ] 縮短機器人的啟動時間。(也許在遊戲開始前就啟動?)
- [x] 縮短機器人的啟動時間。(也許在遊戲開始前就啟動?)
- [x][MajsoulUnlocker](https://github.com/shinkuan/MajsoulUnlocker)整合
- [ ] 完全不使用MITM進行遊戲,使用圖像識別。
- [ ] 決定使用哪種模型
Expand All @@ -150,7 +161,7 @@ LiqiProto訊息隨後被轉錄為mjai格式並發送給機器人。
- [ ] 得分差異識別。
- [ ] 流局識別。
- [ ] 實施
- [ ] 更簡單的安裝流程
- [x] 更簡單的安裝流程

## Need Help!

Expand Down

0 comments on commit f03687c

Please sign in to comment.