@rookiestar/eng-lang-tutor 1.0.0 → 1.0.2

package/README.md

@@ -22,21 +22,30 @@
 
 ### 安装步骤
 
-1. **克隆到您的 OpenClaw skills 目录：**
+**方式一：npm 安装（推荐）**
+
+```bash
+npm install -g @rookiestar/eng-lang-tutor
+```
+
+安装会自动执行，skill 将被安装到 `~/.openclaw/skills/eng-lang-tutor/`。
+
+**方式二：从源码安装**
 
 ```bash
 cd ~/.openclaw/skills/
 git clone https://github.com/rookiestar/eng-lang-tutor.git
+pip install -r eng-lang-tutor/requirements.txt
 ```
 
-2. **验证安装：**
+**验证安装：**
 
 ```bash
 openclaw skills list
 openclaw skills info eng-lang-tutor
 ```
 
-3. **配置渠道：**
+**配置渠道：**
 
 **Discord 配置：**
 ```bash
@@ -78,36 +87,46 @@ openclaw pairing approve discord YOUR_PAIRING_CODE
 
 ## 推送时间配置
 
-### 默认推送时间（UTC+8）
-
-| 任务 | 时间 |
-|------|------|
-| 知识点 | 早上 6:45 |
-| 每日测验 | 晚上 10:45 |
-
-### 自定义推送时间
+### Crontab 设置
 
-```
-set schedule keypoint 7:00
-set schedule quiz 21:00
-```
+Skill 的定时推送依赖 crontab。在 onboarding 流程的 Step 6 会自动创建 cron 任务。
 
-### Crontab 设置
+如需手动配置或修改：
 
 ```bash
 # 编辑 crontab
 crontab -e
 
-# 添加定时任务
+# 添加定时任务（示例：北京时间 06:45 推送知识点，22:45 推送测验）
 CRON_TZ=Asia/Shanghai
 
-# 06:45 每日知识点
+# 知识点推送
 45 6 * * * openclaw system event --text "Use eng-lang-tutor skill. Push today's keypoint." --mode now
 
-# 22:45 每日测验
+# 测验推送
 45 22 * * * openclaw system event --text "Use eng-lang-tutor skill. Push today's quiz invitation." --mode now
 ```
 
+### 修改推送时间
+
+如需修改推送时间：
+
+1. **在 IM 中向 Bot 发送命令**更新偏好设置：
+
+```
+set schedule keypoint 7:00    # 设置知识点推送时间为早上 7:00
+set schedule quiz 21:00       # 设置测验推送时间为晚上 21:00
+```
+
+2. **同步更新 crontab**（修改对应的时间）：
+
+```bash
+crontab -e
+# 将 45 6 改为 0 7，将 45 22 改为 0 21
+```
+
+**注意：** 测验时间必须晚于知识点时间。时间格式为 24 小时制（HH:MM）。
+
 ## 游戏化系统
 
 ### XP 与等级
@@ -145,7 +164,8 @@ eng-lang-tutor/
 │   ├── gamification.py         # 连胜/等级/徽章逻辑
 │   ├── dedup.py                # 14天去重逻辑
 │   ├── command_parser.py       # 用户命令解析
-│   └── cron_push.py            # 定时内容推送
+│   ├── cron_push.py            # 定时内容推送
+│   └── tts/                    # TTS 语音合成模块
 ├── templates/
 │   ├── state_schema.json       # 状态 JSON Schema
 │   ├── keypoint_schema.json    # 知识点 JSON Schema
@@ -154,22 +174,16 @@ eng-lang-tutor/
 ├── references/
 │   └── resources.md            # 主题化学习资源
 ├── examples/
-│   ├── sample_keypoint.json
-│   └── sample_quiz.json
-├── tests/
-│   ├── conftest.py
-│   ├── test_state_manager.py
-│   ├── test_scorer.py
-│   ├── test_gamification.py
-│   ├── test_dedup.py
-│   ├── test_command_parser.py
-│   └── test_cron_push.py
-└── data/
-    ├── state.json              # 运行时状态
-    ├── logs/                   # 事件日志
-    └── daily/                  # 每日内容
+│   ├── sample_keypoint.json    # 知识点示例
+│   └── sample_quiz.json        # 测验示例
+└── docs/
+    └── OPENCLAW_DEPLOYMENT.md  # 部署文档
 ```
 
+**数据存储位置：** `~/.openclaw/state/eng-lang-tutor/`
+
+可通过环境变量 `OPENCLAW_STATE_DIR` 自定义数据目录。
+
 ## 文档
 
 - [SKILL.md](SKILL.md) - 完整 Skill 文档
@@ -177,14 +191,7 @@ eng-lang-tutor/
 
 ## 开发
 
-### 运行测试
-
-```bash
-cd eng-lang-tutor
-pytest tests/ -v
-```
-
-### 运行演示
+### 本地调试
 
 ```bash
 python3 scripts/command_parser.py --demo
@@ -193,19 +200,24 @@ python3 scripts/cron_push.py --task status
 
 ## 服务器迁移
 
-迁移到新服务器：
+**迁移学习数据：**
 
 ```bash
-# 在源服务器上
-cd ~/.openclaw/skills/
-tar -czvf eng-lang-tutor-backup.tar.gz eng-lang-tutor/
+# 在源服务器上打包数据
+tar -czvf eng-lang-tutor-data.tar.gz -C ~/.openclaw/state eng-lang-tutor
 
 # 传输到新服务器
-scp eng-lang-tutor-backup.tar.gz user@new-server:~/
+scp eng-lang-tutor-data.tar.gz user@new-server:~/
 
-# 在目标服务器上
-cd ~/.openclaw/skills/
-tar -xzvf ~/eng-lang-tutor-backup.tar.gz
+# 在目标服务器上解压
+mkdir -p ~/.openclaw/state
+tar -xzvf ~/eng-lang-tutor-data.tar.gz -C ~/.openclaw/state
+```
+
+**重新安装 skill：**
+
+```bash
+npm install -g @rookiestar/eng-lang-tutor
 ```
 
 详细迁移指南请参见 [docs/OPENCLAW_DEPLOYMENT.md](docs/OPENCLAW_DEPLOYMENT.md)。

package/README_EN.md

@@ -1,6 +1,6 @@
 # eng-lang-tutor
 
-**地道美式英语导师** - An OpenClaw Skill for learning authentic American English expressions.
+**Authentic American English Tutor** - An OpenClaw Skill for learning authentic American English expressions.
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
@@ -22,21 +22,30 @@
 
 ### Installation
 
-1. **Clone to your OpenClaw skills directory:**
+**Option 1: npm (Recommended)**
+
+```bash
+npm install -g @rookiestar/eng-lang-tutor
+```
+
+Installation runs automatically, skill will be installed to `~/.openclaw/skills/eng-lang-tutor/`.
+
+**Option 2: From Source**
 
 ```bash
 cd ~/.openclaw/skills/
 git clone https://github.com/rookiestar/eng-lang-tutor.git
+pip install -r eng-lang-tutor/requirements.txt
 ```
 
-2. **Verify installation:**
+**Verify Installation:**
 
 ```bash
 openclaw skills list
 openclaw skills info eng-lang-tutor
 ```
 
-3. **Configure Channel:**
+### Configure Channel
 
 **Discord Configuration:**
 ```bash
@@ -44,7 +53,7 @@ openclaw config set discord.token YOUR_BOT_TOKEN
 openclaw config set discord.guildId YOUR_SERVER_ID
 ```
 
-4. **Complete pairing:**
+### Complete Pairing
 
 When you first message the bot, you'll receive a pairing code. Approve it:
 
@@ -78,36 +87,46 @@ When you first interact with the bot, it will guide you through a 6-step onboard
 
 ## Schedule Configuration
 
-### Default Schedule (UTC+8)
-
-| Task | Time |
-|------|------|
-| Knowledge Point | 6:45 AM |
-| Daily Quiz | 10:45 PM |
+### Crontab Setup
 
-### Customize Schedule
+The skill's scheduled push relies on crontab. Cron jobs are automatically created during onboarding Step 6.
 
-```
-set schedule keypoint 7:00
-set schedule quiz 21:00
-```
-
-### Crontab Setup
+For manual configuration or modification:
 
 ```bash
 # Edit crontab
 crontab -e
 
-# Add scheduled tasks
+# Add scheduled tasks (example: 06:45 keypoint, 22:45 quiz in Beijing time)
 CRON_TZ=Asia/Shanghai
 
-# 06:45 Daily keypoint
+# Keypoint push
 45 6 * * * openclaw system event --text "Use eng-lang-tutor skill. Push today's keypoint." --mode now
 
-# 22:45 Daily quiz
+# Quiz push
 45 22 * * * openclaw system event --text "Use eng-lang-tutor skill. Push today's quiz invitation." --mode now
 ```
 
+### Modify Schedule
+
+To change push times:
+
+1. **Send command to Bot via IM** to update preferences:
+
+```
+set schedule keypoint 7:00    # Set keypoint push time to 7:00 AM
+set schedule quiz 21:00       # Set quiz push time to 9:00 PM
+```
+
+2. **Update crontab accordingly** (modify the corresponding times):
+
+```bash
+crontab -e
+# Change 45 6 to 0 7, and 45 22 to 0 21
+```
+
+**Note:** Quiz time must be later than keypoint time. Time format is 24-hour (HH:MM).
+
 ## Gamification
 
 ### XP & Levels
@@ -118,10 +137,10 @@ This system has two independent level systems:
 
 | Level Range | XP Required | Stage |
 |-------------|-------------|-------|
-| 1-5 | 0-350 | Starter (启程者) |
-| 6-10 | 550-2000 | Traveler (行路人) |
-| 11-15 | 2600-6000 | Explorer (探索者) |
-| 16-20 | 7200-15000 | Pioneer (开拓者) |
+| 1-5 | 0-350 | Starter |
+| 6-10 | 550-2000 | Traveler |
+| 11-15 | 2600-6000 | Explorer |
+| 16-20 | 7200-15000 | Pioneer |
 
 ### Badges
 
@@ -145,7 +164,8 @@ eng-lang-tutor/
 │   ├── gamification.py         # Streak/level/badge logic
 │   ├── dedup.py                # 14-day deduplication
 │   ├── command_parser.py       # User command parsing
-│   └── cron_push.py            # Scheduled content push
+│   ├── cron_push.py            # Scheduled content push
+│   └── tts/                    # TTS module
 ├── templates/
 │   ├── state_schema.json       # State JSON Schema
 │   ├── keypoint_schema.json    # Keypoint JSON Schema
@@ -154,22 +174,16 @@ eng-lang-tutor/
 ├── references/
 │   └── resources.md            # Themed learning resources
 ├── examples/
-│   ├── sample_keypoint.json
-│   └── sample_quiz.json
-├── tests/
-│   ├── conftest.py
-│   ├── test_state_manager.py
-│   ├── test_scorer.py
-│   ├── test_gamification.py
-│   ├── test_dedup.py
-│   ├── test_command_parser.py
-│   └── test_cron_push.py
-└── data/
-    ├── state.json              # Runtime state
-    ├── logs/                   # Event logs
-    └── daily/                  # Daily content
+│   ├── sample_keypoint.json    # Sample keypoint
+│   └── sample_quiz.json        # Sample quiz
+└── docs/
+    └── OPENCLAW_DEPLOYMENT.md  # Deployment docs
 ```
 
+**Data Location:** `~/.openclaw/state/eng-lang-tutor/`
+
+Customize via `OPENCLAW_STATE_DIR` environment variable.
+
 ## Documentation
 
 - [SKILL.md](SKILL.md) - Full skill documentation
@@ -177,14 +191,7 @@ eng-lang-tutor/
 
 ## Development
 
-### Run Tests
-
-```bash
-cd eng-lang-tutor
-pytest tests/ -v
-```
-
-### Run Demo
+### Local Debugging
 
 ```bash
 python3 scripts/command_parser.py --demo
@@ -193,22 +200,25 @@ python3 scripts/cron_push.py --task status
 
 ## Migration
 
-To migrate to a new server:
+**Migrate Learning Data:**
 
 ```bash
-# On source server
-cd ~/.openclaw/skills/
-tar -czvf eng-lang-tutor-backup.tar.gz eng-lang-tutor/
+# On source server, backup data
+tar -czvf eng-lang-tutor-data.tar.gz -C ~/.openclaw/state eng-lang-tutor
 
 # Transfer to new server
-scp eng-lang-tutor-backup.tar.gz user@new-server:~/
+scp eng-lang-tutor-data.tar.gz user@new-server:~/
 
-# On target server
-cd ~/.openclaw/skills/
-tar -xzvf ~/eng-lang-tutor-backup.tar.gz
+# On target server, extract
+mkdir -p ~/.openclaw/state
+tar -xzvf ~/eng-lang-tutor-data.tar.gz -C ~/.openclaw/state
 ```
 
-See [docs/OPENCLAW_DEPLOYMENT.md](docs/OPENCLAW_DEPLOYMENT.md) for detailed migration guide.
+**Reinstall Skill:**
+
+```bash
+npm install -g @rookiestar/eng-lang-tutor
+```
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rookiestar/eng-lang-tutor",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "English language tutor skill for OpenClaw - Learn authentic American English expressions with gamification",
   "keywords": [
     "english",