Skip to content

Commit

Permalink
doc: readme separate language (#23)
Browse files Browse the repository at this point in the history
* doc: refine README move Chinese text to another file

* doc: add nexus blitz to supported gamemode

* doc: correct release package name

* doc: add chinese readme
  • Loading branch information
SivWatt authored Oct 18, 2021
1 parent d6d9a99 commit 63a2e98
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 16 deletions.
26 changes: 10 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# LOL Report Tool
![version](https://img.shields.io/github/v/release/SivWatt/LOL_report_tool)
![Test Status](https://github.com/SivWatt/LOL_report_tool/actions/workflows/BuildExecutable.yaml/badge.svg)
Automatically report players after a game at statistic window.
[![version](https://img.shields.io/github/v/release/SivWatt/LOL_report_tool)](https://github.com/SivWatt/LOL_report_tool/releases)
[![Build Status](https://github.com/SivWatt/LOL_report_tool/actions/workflows/BuildExecutable.yaml/badge.svg?branch=master)](https://github.com/SivWatt/LOL_report_tool/actions/workflows/BuildExecutable.yaml)
[![Python Checks](https://github.com/SivWatt/LOL_report_tool/actions/workflows/python-checks.yaml/badge.svg?branch=master)](https://github.com/SivWatt/LOL_report_tool/actions/workflows/python-checks.yaml)
This tool automatically reports players after a game at statistic window in __League of Legends__.
It is written in __Python 3.7__, and __pyautogui__ does most of the work.
Currently, it works well in __Taiwan__ client, not sure if it works in clients with other languages.
Here is __Traditional Chinese__ version of README. [繁體中文版](/README_Chinese.md)

## Download
Go to [Release](https://github.com/SivWatt/LOL_report_tool/releases/latest) page and download __LOL_report_tool.zip__
Go to [Release](https://github.com/SivWatt/LOL_report_tool/releases/latest) page and download __LeagueReport.zip__.

## Usage
### English
Run `League.exe` as administrator and the GUI will show.
Run `League.exe` as __administrator__ and the GUI will show.
![GUI](/doc/main-window.PNG?raw=true)
- Press `TEAM` to report __ALL__ of the players in your team
- Press `ENEMY` to report __ALL__ of the players in opponent team
Expand All @@ -18,21 +21,12 @@ The report message is copied from `reportText.txt`.
User can modify the content to whatever he wants to meet his need.
_Note that modifying `reportText.txt` takes effect after next time you restart `League.exe`_

### 中文
以系統管理員執行 `League.exe` 即可看到圖形化介面。
![GUI](/doc/main-window.PNG?raw=true)
- 按下 `TEAM` 以檢舉**所有**同隊的隊友
- 按下 `ENEMY` 以檢舉**所有**同隊的隊友
- 按下 `ALL` 以檢舉**所有**同隊的隊友

檢舉的訊息來自 `reportText.txt`,使用者可以自行編輯其內容以達到個人的需求。
_注意:如果更改了`reportText.txt`的內容,必須重新啟動`League.exe`,檢舉訊息的更改才會生效。_

## Supported Modes
Currently, this tool recognizes game mode image on the upper-left corner of __League of Legend Client__ window.
If the game mode image is not included, it won't start reporting players.
### Supports
- ARAM
- Nexus Blitz

## Troubleshooting
Most of the problems users come into are about images recognizing.
Expand Down
32 changes: 32 additions & 0 deletions README_Chinese.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 英雄聯盟自動檢舉程式
這個應用程式可以幫助你在一場__英雄聯盟__遊戲結束後的統計畫面檢舉玩家。
這個程式使用的語言是 __Python 3.7__ ,並且絕大部分的功能是透過 __pyautogui__ 來完成。
現階段這個程式只支援台灣的英雄聯盟客戶端,使用在其他語言的客戶端可能會有一些不預期的行為。

## 下載
[Release](https://github.com/SivWatt/LOL_report_tool/releases/latest) 即可下載打包好的應用程式 __LeagueReport.zip__

## 使用方法
以系統管理員執行 `League.exe` 即可看到圖形化介面。
![GUI](/doc/main-window.PNG?raw=true)
- 按下 `TEAM` 以檢舉**所有**同隊的隊友
- 按下 `ENEMY` 以檢舉**所有**同隊的隊友
- 按下 `ALL` 以檢舉**所有**同隊的隊友

檢舉的訊息來自 `reportText.txt`,使用者可以自行編輯其內容以達到個人的需求。
_注意:如果更改了 `reportText.txt` 的內容,必須重新啟動 `League.exe` ,檢舉訊息的更改才會生效。_

## 支援的遊戲模式
這個程式主要是透過偵測左上角的遊戲模式圖示的位置,再透過移動鼠標來達成檢舉的動作。
如果在不支援的遊戲模式的結算畫面使用,他將不會檢舉任何人。

### 支援
- 咆嘯深淵
- 閃電急集

## 排解疑難
大部分使用上的問題都來自於圖像辨識,如果碰到程式沒有正常運作,可以檢查 `debuglog.log` 這個檔案來看看是哪裡出了問題。
如果是特定的圖片辨識失敗的話,基本上可以透過自行截圖替換掉相對應黨名的圖片來解決。

## 開發
如果有碰到任何問題,歡迎透過開立 [issues](https://github.com/SivWatt/LOL_report_tool/issues) 的方式讓我知道。

0 comments on commit 63a2e98

Please sign in to comment.