Skip to content

Commit 46a62e5

Browse files
MJ33520MJ33520
committed
Split README into separate zh/en files with cross-links
1 parent 901c4f0 commit 46a62e5

2 files changed

Lines changed: 104 additions & 103 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
# ⚔️ ARAM Tool - 海克斯大乱斗智能助手
22

3-
**[English](#english) | [中文](#中文)**
3+
> **[English](README_EN.md)** | 中文
44
55
![Python](https://img.shields.io/badge/Python-3.10+-blue?logo=python)
66
![Gemini](https://img.shields.io/badge/AI-Gemini-orange?logo=google)
77
![Platform](https://img.shields.io/badge/Platform-Windows-lightgrey?logo=windows)
88

9-
---
10-
11-
## 中文
12-
139
基于 **Gemini AI** 的英雄联盟海克斯大乱斗（ARAM）实时分析助手。在加载界面截图后，AI 自动识别双方阵容，为你提供出装、符文、打法的完整攻略。
1410

15-
### ✨ 功能
11+
## ✨ 功能
1612

1713
- 🎮 **一键截图分析** — 点击浮动按钮，自动截图并发送给 Gemini AI
1814
- 🤖 **智能阵容识别** — AI 从加载界面读取所有英雄名，自动识别你的英雄
@@ -21,40 +17,40 @@
2117
- 🖥️ **悬浮窗显示** — 始终置顶的攻略窗口，支持拖拽和快捷键
2218
- 🌐 **中英文切换** — 一行配置切换界面语言和 AI 分析语言
2319

24-
### 🚀 快速开始
20+
## 🚀 快速开始
2521

26-
#### 1. 获取 Gemini API Key
22+
### 1. 获取 Gemini API Key
2723

2824
前往 [Google AI Studio](https://aistudio.google.com/apikey) 免费获取 API Key。
2925

30-
#### 2. 设置环境变量
26+
### 2. 设置环境变量
3127

3228
```cmd
3329
setx GEMINI_API_KEY "你的API密钥"
3430
```
3531

36-
#### 3. 安装依赖
32+
### 3. 安装依赖
3733

3834
```cmd
3935
pip install -r requirements.txt
4036
```
4137

42-
#### 4. 启动
38+
### 4. 启动
4339

4440
双击 `launch.bat`，或：
4541

4642
```cmd
4743
python main.py
4844
```
4945

50-
### 🎮 使用方法
46+
## 🎮 使用方法
5147

5248
1. 启动助手后，屏幕左上角出现 `[⚔️ 分析 | 📋 攻略]` 浮动按钮
5349
2. 进入大乱斗加载界面后，点击 **⚔️ 分析**
5450
3. 等待 15-30 秒，AI 分析完成后自动弹出攻略窗口
5551
4. 按 **Ctrl+F12** 可随时切换攻略窗口的显示/隐藏
5652

57-
### 🌐 语言切换
53+
## 🌐 语言切换
5854

5955
编辑 `config.py`，修改 `LANGUAGE` 的值：
6056

@@ -65,7 +61,7 @@ LANGUAGE = "en" # English
6561

6662
切换后，界面文字、控制台提示和 AI 分析结果的语言都会相应改变。
6763

68-
### 📁 文件说明
64+
## 📁 文件说明
6965

7066
| 文件 | 说明 |
7167
|------|------|
@@ -77,107 +73,20 @@ LANGUAGE = "en" # English
7773
| `overlay_ui.py` | 独立攻略窗口 UI（备用） |
7874
| `launch.bat` | Windows 启动脚本 |
7975

80-
### 🔧 要求
76+
## 🔧 要求
8177

8278
- **操作系统**: Windows 10/11
8379
- **Python**: 3.10+
8480
- **网络**: 能访问 Google Gemini API
8581
- **游戏**: 英雄联盟（国服/国际服）
8682

87-
### 📝 注意事项
83+
## 📝 注意事项
8884

8985
- 截图分析需要在 **加载界面** 触发（可以看到所有英雄卡片的时候）
9086
- 每次分析耗时约 15-30 秒，取决于网络和 API 响应速度
9187
- 浮动按钮可以右键拖拽移动位置
9288
- 攻略窗口按 Esc 隐藏，点 📋 重新显示
9389

94-
---
95-
96-
## English
97-
98-
A real-time **Gemini AI** powered analysis assistant for League of Legends Hextech Havoc (ARAM). Captures the loading screen and automatically identifies team compositions, providing complete build, augment, and strategy guides.
99-
100-
### ✨ Features
101-
102-
- 🎮 **One-Click Analysis** — Click the floating button to screenshot & send to Gemini AI
103-
- 🤖 **Smart Champion Detection** — AI reads all champion names from the loading screen and auto-identifies yours
104-
- 📋 **Full Guide Output** — Hextech augments, 6-item builds, skill order, playstyle tips, team strategy
105-
- 🗡️ **Teammate Recommendations** — Augment and build suggestions for every teammate
106-
- 🖥️ **Overlay Display** — Always-on-top guide window, supports dragging and hotkeys
107-
- 🌐 **Bilingual Support** — Switch between Chinese and English with one config change
108-
109-
### 🚀 Quick Start
110-
111-
#### 1. Get a Gemini API Key
112-
113-
Visit [Google AI Studio](https://aistudio.google.com/apikey) to get a free API key.
114-
115-
#### 2. Set Environment Variable
116-
117-
```cmd
118-
setx GEMINI_API_KEY "your_api_key"
119-
```
120-
121-
#### 3. Install Dependencies
122-
123-
```cmd
124-
pip install -r requirements.txt
125-
```
126-
127-
#### 4. Launch
128-
129-
Double-click `launch.bat`, or:
130-
131-
```cmd
132-
python main.py
133-
```
134-
135-
### 🎮 How to Use
136-
137-
1. After launching, a floating `[⚔️ Analyze | 📋 Guide]` button appears at the top-left corner
138-
2. On the ARAM loading screen, click **⚔️ Analyze**
139-
3. Wait 15-30 seconds for AI analysis, then the guide overlay pops up automatically
140-
4. Press **Ctrl+F12** to toggle the guide overlay anytime
141-
142-
### 🌐 Language Switch
143-
144-
Edit `config.py` and change the `LANGUAGE` value:
145-
146-
```python
147-
LANGUAGE = "zh" # Chinese (default)
148-
LANGUAGE = "en" # English
149-
```
150-
151-
This changes the UI text, console messages, and AI analysis language.
152-
153-
### 📁 File Structure
154-
155-
| File | Description |
156-
|------|-------------|
157-
| `main.py` | Main entry, floating button & overlay |
158-
| `config.py` | Config (API key, language, UI) |
159-
| `lang.py` | i18n strings & prompts (zh/en) |
160-
| `screenshot.py` | Screenshot module |
161-
| `gemini_analyzer.py` | Gemini API module |
162-
| `overlay_ui.py` | Standalone overlay UI (backup) |
163-
| `launch.bat` | Windows launch script |
164-
165-
### 🔧 Requirements
166-
167-
- **OS**: Windows 10/11
168-
- **Python**: 3.10+
169-
- **Network**: Access to Google Gemini API
170-
- **Game**: League of Legends (any region)
171-
172-
### 📝 Notes
173-
174-
- Trigger analysis on the **loading screen** (when all champion cards are visible)
175-
- Each analysis takes ~15-30 seconds depending on network and API response
176-
- Right-click drag to reposition the floating button
177-
- Press Esc to hide the guide overlay, click 📋 to show it again
178-
179-
---
180-
18190
## 📄 License
18291

18392
MIT

‎README_EN.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# ⚔️ ARAM Tool - Hextech Havoc Assistant
2+
3+
> English | **[中文](README.md)**
4+
5+
![Python](https://img.shields.io/badge/Python-3.10+-blue?logo=python)
6+
![Gemini](https://img.shields.io/badge/AI-Gemini-orange?logo=google)
7+
![Platform](https://img.shields.io/badge/Platform-Windows-lightgrey?logo=windows)
8+
9+
A real-time **Gemini AI** powered analysis assistant for League of Legends Hextech Havoc (ARAM). Captures the loading screen, auto-identifies team compositions, and provides complete build, augment, and strategy guides.
10+
11+
## ✨ Features
12+
13+
- 🎮 **One-Click Analysis** — Click the floating button to screenshot & send to Gemini AI
14+
- 🤖 **Smart Champion Detection** — AI reads all champion names from the loading screen and auto-identifies yours
15+
- 📋 **Full Guide Output** — Hextech augments, 6-item builds, skill order, playstyle tips, team strategy
16+
- 🗡️ **Teammate Recommendations** — Augment and build suggestions for every teammate
17+
- 🖥️ **Overlay Display** — Always-on-top guide window with drag & hotkey support
18+
- 🌐 **Bilingual Support** — Switch between Chinese and English with one config change
19+
20+
## 🚀 Quick Start
21+
22+
### 1. Get a Gemini API Key
23+
24+
Visit [Google AI Studio](https://aistudio.google.com/apikey) to get a free API key.
25+
26+
### 2. Set Environment Variable
27+
28+
```cmd
29+
setx GEMINI_API_KEY "your_api_key"
30+
```
31+
32+
### 3. Install Dependencies
33+
34+
```cmd
35+
pip install -r requirements.txt
36+
```
37+
38+
### 4. Launch
39+
40+
Double-click `launch.bat`, or:
41+
42+
```cmd
43+
python main.py
44+
```
45+
46+
## 🎮 How to Use
47+
48+
1. After launching, a floating `[⚔️ Analyze | 📋 Guide]` button appears at the top-left corner
49+
2. On the ARAM loading screen, click **⚔️ Analyze**
50+
3. Wait 15-30 seconds for AI analysis, then the guide overlay pops up automatically
51+
4. Press **Ctrl+F12** to toggle the guide overlay anytime
52+
53+
## 🌐 Language Switch
54+
55+
Edit `config.py` and change the `LANGUAGE` value:
56+
57+
```python
58+
LANGUAGE = "zh" # Chinese (default)
59+
LANGUAGE = "en" # English
60+
```
61+
62+
This changes the UI text, console messages, and AI analysis language.
63+
64+
## 📁 File Structure
65+
66+
| File | Description |
67+
|------|-------------|
68+
| `main.py` | Main entry, floating button & overlay |
69+
| `config.py` | Config (API key, language, UI) |
70+
| `lang.py` | i18n strings & prompts (zh/en) |
71+
| `screenshot.py` | Screenshot module |
72+
| `gemini_analyzer.py` | Gemini API module |
73+
| `overlay_ui.py` | Standalone overlay UI (backup) |
74+
| `launch.bat` | Windows launch script |
75+
76+
## 🔧 Requirements
77+
78+
- **OS**: Windows 10/11
79+
- **Python**: 3.10+
80+
- **Network**: Access to Google Gemini API
81+
- **Game**: League of Legends (any region)
82+
83+
## 📝 Notes
84+
85+
- Trigger analysis on the **loading screen** (when all champion cards are visible)
86+
- Each analysis takes ~15-30 seconds depending on network and API response
87+
- Right-click drag to reposition the floating button
88+
- Press Esc to hide the guide overlay, click 📋 to show it again
89+
90+
## 📄 License
91+
92+
MIT

0 commit comments

Comments
 (0)