@rookiestar/eng-lang-tutor 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of @rookiestar/eng-lang-tutor might be problematic. Click here for more details.
- package/README.md +84 -5
- package/README_EN.md +84 -3
- package/package.json +1 -1
- package/requirements.txt +2 -2
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
## 功能特性
|
|
8
8
|
|
|
9
9
|
- 📚 **每日知识点** - 地道美式表达，包含场景语境、可替换说法和中式英语陷阱
|
|
10
|
-
- 🔊 **语音版知识点** - 支持 TTS
|
|
10
|
+
- 🔊 **语音版知识点** - 支持 Edge-TTS 语音合成，免费高质量，可调节语速
|
|
11
11
|
- 📝 **测验系统** - 4种题型：选择题、填空题、对话补全、中式英语修正
|
|
12
12
|
- 🎮 **多邻国风格游戏化** - XP经验值、等级、连胜、徽章、宝石
|
|
13
13
|
- ⏰ **可自定义推送时间** - 通过 cron 设置您偏好的推送时间
|
|
@@ -19,9 +19,19 @@
|
|
|
19
19
|
|
|
20
20
|
- 服务器上已安装 OpenClaw Gateway
|
|
21
21
|
- Python 3.8+
|
|
22
|
-
- ffmpeg
|
|
22
|
+
- ffmpeg（用于音频合成）
|
|
23
23
|
- Discord Bot（或其他 IM 通道）
|
|
24
24
|
|
|
25
|
+
**系统依赖：**
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# macOS
|
|
29
|
+
brew install ffmpeg python3
|
|
30
|
+
|
|
31
|
+
# Ubuntu/Debian
|
|
32
|
+
sudo apt-get install ffmpeg python3 python3-venv
|
|
33
|
+
```
|
|
34
|
+
|
|
25
35
|
### 安装步骤
|
|
26
36
|
|
|
27
37
|
**方式一：npm 安装（推荐）**
|
|
@@ -36,10 +46,25 @@ npm install -g @rookiestar/eng-lang-tutor
|
|
|
36
46
|
|
|
37
47
|
```bash
|
|
38
48
|
cd ~/.openclaw/skills/
|
|
39
|
-
git clone https://github.com/rookiestar/
|
|
49
|
+
git clone --depth 1 --filter=blob:none --sparse https://github.com/rookiestar/Skills.git temp-skills
|
|
50
|
+
cd temp-skills
|
|
51
|
+
git sparse-checkout set eng-lang-tutor
|
|
52
|
+
mv eng-lang-tutor ../eng-lang-tutor
|
|
53
|
+
cd .. && rm -rf temp-skills
|
|
40
54
|
pip install -r eng-lang-tutor/requirements.txt
|
|
41
55
|
```
|
|
42
56
|
|
|
57
|
+
**手动安装依赖（如需要）：**
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# 创建 Python 虚拟环境
|
|
61
|
+
python3 -m venv ~/.venvs/eng-lang-tutor
|
|
62
|
+
source ~/.venvs/eng-lang-tutor/bin/activate # Linux/macOS
|
|
63
|
+
|
|
64
|
+
# 安装依赖
|
|
65
|
+
pip install -r ~/.openclaw/skills/eng-lang-tutor/requirements.txt
|
|
66
|
+
```
|
|
67
|
+
|
|
43
68
|
**验证安装：**
|
|
44
69
|
|
|
45
70
|
```bash
|
|
@@ -71,14 +96,68 @@ openclaw pairing approve discord YOUR_PAIRING_CODE
|
|
|
71
96
|
|
|
72
97
|
### 首次使用
|
|
73
98
|
|
|
74
|
-
首次与 Bot 交互时，它会引导您完成
|
|
99
|
+
首次与 Bot 交互时，它会引导您完成 7 步引导流程：
|
|
75
100
|
|
|
76
101
|
1. 选择您的 CEFR 等级（A1-C2）
|
|
77
102
|
2. 选择您的兴趣主题
|
|
78
103
|
3. 选择导师风格（幽默/严谨/随意/专业）
|
|
79
104
|
4. 设置口语/书面语比例
|
|
80
105
|
5. 配置推送时间（知识点和测验时间）
|
|
81
|
-
6.
|
|
106
|
+
6. 选择是否启用语音教学，如启用可调节语速
|
|
107
|
+
7. 确认您的设置并创建定时任务
|
|
108
|
+
|
|
109
|
+
## TTS 语音配置
|
|
110
|
+
|
|
111
|
+
本 Skill 默认使用 **Edge-TTS**（Microsoft Edge 语音合成服务），完全免费且无需 API 密钥。
|
|
112
|
+
|
|
113
|
+
### 支持的 TTS Provider
|
|
114
|
+
|
|
115
|
+
| Provider | 说明 | 配置方式 |
|
|
116
|
+
|----------|------|----------|
|
|
117
|
+
| **edge-tts** (默认) | Microsoft Edge TTS，免费高质量 | 无需配置 |
|
|
118
|
+
| xunfei | 讯飞 TTS，国内稳定 | 需设置环境变量 |
|
|
119
|
+
|
|
120
|
+
切换 Provider：
|
|
121
|
+
```bash
|
|
122
|
+
# 使用 Edge-TTS（默认）
|
|
123
|
+
export TTS_PROVIDER=edge-tts
|
|
124
|
+
|
|
125
|
+
# 使用讯飞（需先配置密钥）
|
|
126
|
+
export TTS_PROVIDER=xunfei
|
|
127
|
+
export XUNFEI_APPID=xxx
|
|
128
|
+
export XUNFEI_API_KEY=xxx
|
|
129
|
+
export XUNFEI_API_SECRET=xxx
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### 可用音色
|
|
133
|
+
|
|
134
|
+
**Edge-TTS (en-US)：**
|
|
135
|
+
|
|
136
|
+
| 角色 | 默认音色 | 说明 |
|
|
137
|
+
|------|----------|------|
|
|
138
|
+
| 旁白 (Narrator) | JennyNeural | 女声，友好亲切 |
|
|
139
|
+
| 对话 A | EricNeural | 男声，专业理性 |
|
|
140
|
+
| 对话 B | JennyNeural | 女声，友好亲切 |
|
|
141
|
+
|
|
142
|
+
**XunFei (美式英语)：**
|
|
143
|
+
|
|
144
|
+
| 角色 | 默认音色 | 说明 |
|
|
145
|
+
|------|----------|------|
|
|
146
|
+
| 旁白 (Narrator) | catherine | 女声，自然流畅 |
|
|
147
|
+
| 对话 A | henry | 男声，沉稳专业 |
|
|
148
|
+
| 对话 B | catherine | 女声，自然流畅 |
|
|
149
|
+
|
|
150
|
+
### 语速选项
|
|
151
|
+
|
|
152
|
+
在引导流程中可选择语速：
|
|
153
|
+
|
|
154
|
+
| 语速 | 值 | 适用场景 |
|
|
155
|
+
|------|-----|----------|
|
|
156
|
+
| 非常慢 | 0.5 | 初学者跟读 |
|
|
157
|
+
| 慢速 | 0.7 | 学习发音 |
|
|
158
|
+
| **正常（推荐）** | **0.9** | 日常学习 |
|
|
159
|
+
| 快速 | 1.3 | 听力挑战 |
|
|
160
|
+
| 非常快 | 1.7 | 进阶训练 |
|
|
82
161
|
|
|
83
162
|
## 命令列表
|
|
84
163
|
|
package/README_EN.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
## Features
|
|
8
8
|
|
|
9
9
|
- 📚 **Daily Knowledge Points** - Authentic American expressions with scene context, alternatives, and Chinglish traps
|
|
10
|
+
- 🔊 **Audio Keypoints** - Edge-TTS voice synthesis, free high-quality, adjustable speed
|
|
10
11
|
- 📝 **Quiz System** - 4 question types: multiple choice, fill blank, dialogue completion, Chinglish fix
|
|
11
12
|
- 🎮 **Duolingo-style Gamification** - XP, levels, streaks, badges, gems
|
|
12
13
|
- ⏰ **Customizable Schedule** - Set your preferred push times via cron
|
|
@@ -18,8 +19,19 @@
|
|
|
18
19
|
|
|
19
20
|
- OpenClaw Gateway installed on your server
|
|
20
21
|
- Python 3.8+
|
|
22
|
+
- ffmpeg (for audio synthesis)
|
|
21
23
|
- Discord Bot (or other IM channel)
|
|
22
24
|
|
|
25
|
+
**System Dependencies:**
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# macOS
|
|
29
|
+
brew install ffmpeg python3
|
|
30
|
+
|
|
31
|
+
# Ubuntu/Debian
|
|
32
|
+
sudo apt-get install ffmpeg python3 python3-venv
|
|
33
|
+
```
|
|
34
|
+
|
|
23
35
|
### Installation
|
|
24
36
|
|
|
25
37
|
**Option 1: npm (Recommended)**
|
|
@@ -34,10 +46,25 @@ Installation runs automatically, skill will be installed to `~/.openclaw/skills/
|
|
|
34
46
|
|
|
35
47
|
```bash
|
|
36
48
|
cd ~/.openclaw/skills/
|
|
37
|
-
git clone https://github.com/rookiestar/
|
|
49
|
+
git clone --depth 1 --filter=blob:none --sparse https://github.com/rookiestar/Skills.git temp-skills
|
|
50
|
+
cd temp-skills
|
|
51
|
+
git sparse-checkout set eng-lang-tutor
|
|
52
|
+
mv eng-lang-tutor ../eng-lang-tutor
|
|
53
|
+
cd .. && rm -rf temp-skills
|
|
38
54
|
pip install -r eng-lang-tutor/requirements.txt
|
|
39
55
|
```
|
|
40
56
|
|
|
57
|
+
**Manual Dependency Installation (if needed):**
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Create Python virtual environment
|
|
61
|
+
python3 -m venv ~/.venvs/eng-lang-tutor
|
|
62
|
+
source ~/.venvs/eng-lang-tutor/bin/activate # Linux/macOS
|
|
63
|
+
|
|
64
|
+
# Install dependencies
|
|
65
|
+
pip install -r ~/.openclaw/skills/eng-lang-tutor/requirements.txt
|
|
66
|
+
```
|
|
67
|
+
|
|
41
68
|
**Verify Installation:**
|
|
42
69
|
|
|
43
70
|
```bash
|
|
@@ -69,14 +96,68 @@ openclaw pairing approve discord YOUR_PAIRING_CODE
|
|
|
69
96
|
|
|
70
97
|
### First Use
|
|
71
98
|
|
|
72
|
-
When you first interact with the bot, it will guide you through a
|
|
99
|
+
When you first interact with the bot, it will guide you through a 7-step onboarding:
|
|
73
100
|
|
|
74
101
|
1. Select your CEFR level (A1-C2)
|
|
75
102
|
2. Choose your topic interests
|
|
76
103
|
3. Select tutor style (humorous/rigorous/casual/professional)
|
|
77
104
|
4. Set oral vs written focus
|
|
78
105
|
5. Configure schedule (keypoint and quiz times)
|
|
79
|
-
6.
|
|
106
|
+
6. Choose whether to enable voice teaching, adjust speed if enabled
|
|
107
|
+
7. Confirm your settings and create cron jobs
|
|
108
|
+
|
|
109
|
+
## TTS Voice Configuration
|
|
110
|
+
|
|
111
|
+
This Skill uses **Edge-TTS** (Microsoft Edge TTS service) by default - completely free with no API key required.
|
|
112
|
+
|
|
113
|
+
### Supported TTS Providers
|
|
114
|
+
|
|
115
|
+
| Provider | Description | Configuration |
|
|
116
|
+
|----------|-------------|---------------|
|
|
117
|
+
| **edge-tts** (default) | Microsoft Edge TTS, free high-quality | No config needed |
|
|
118
|
+
| xunfei | XunFei TTS, stable in China | Requires env vars |
|
|
119
|
+
|
|
120
|
+
Switch Provider:
|
|
121
|
+
```bash
|
|
122
|
+
# Use Edge-TTS (default)
|
|
123
|
+
export TTS_PROVIDER=edge-tts
|
|
124
|
+
|
|
125
|
+
# Use XunFei (configure keys first)
|
|
126
|
+
export TTS_PROVIDER=xunfei
|
|
127
|
+
export XUNFEI_APPID=xxx
|
|
128
|
+
export XUNFEI_API_KEY=xxx
|
|
129
|
+
export XUNFEI_API_SECRET=xxx
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Available Voices
|
|
133
|
+
|
|
134
|
+
**Edge-TTS (en-US):**
|
|
135
|
+
|
|
136
|
+
| Role | Default Voice | Description |
|
|
137
|
+
|------|---------------|-------------|
|
|
138
|
+
| Narrator | JennyNeural | Female, friendly and conversational |
|
|
139
|
+
| Dialogue A | EricNeural | Male, professional and rational |
|
|
140
|
+
| Dialogue B | JennyNeural | Female, friendly and conversational |
|
|
141
|
+
|
|
142
|
+
**XunFei (American English):**
|
|
143
|
+
|
|
144
|
+
| Role | Default Voice | Description |
|
|
145
|
+
|------|---------------|-------------|
|
|
146
|
+
| Narrator | catherine | Female, natural and fluid |
|
|
147
|
+
| Dialogue A | henry | Male, calm and professional |
|
|
148
|
+
| Dialogue B | catherine | Female, natural and fluid |
|
|
149
|
+
|
|
150
|
+
### Speed Options
|
|
151
|
+
|
|
152
|
+
During onboarding, you can choose speech speed:
|
|
153
|
+
|
|
154
|
+
| Speed | Value | Use Case |
|
|
155
|
+
|-------|-------|----------|
|
|
156
|
+
| Very Slow | 0.5 | Beginner shadowing |
|
|
157
|
+
| Slow | 0.7 | Learning pronunciation |
|
|
158
|
+
| **Normal (Recommended)** | **0.9** | Daily learning |
|
|
159
|
+
| Fast | 1.3 | Listening challenge |
|
|
160
|
+
| Very Fast | 1.7 | Advanced training |
|
|
80
161
|
|
|
81
162
|
## Commands
|
|
82
163
|
|
package/package.json
CHANGED
package/requirements.txt
CHANGED
|
@@ -3,8 +3,8 @@ websocket-client>=1.6.0 # For XunFei TTS WebSocket API
|
|
|
3
3
|
certifi>=2024.0.0 # SSL certificate bundle for HTTPS/WebSocket connections
|
|
4
4
|
aiohttp>=3.8.0 # Async HTTP client for Feishu API
|
|
5
5
|
|
|
6
|
-
#
|
|
7
|
-
|
|
6
|
+
# Edge-TTS support (default TTS provider)
|
|
7
|
+
edge-tts>=6.1.0
|
|
8
8
|
|
|
9
9
|
# Development dependencies
|
|
10
10
|
pytest>=7.0.0
|