@rookiestar/eng-lang-tutor 1.0.1

package/bin/eng-lang-tutor.js

@@ -0,0 +1,177 @@
+#!/usr/bin/env node
+
+/**
+ * eng-lang-tutor CLI
+ *
+ * Commands:
+ *   install   - Install the skill to ~/.openclaw/skills/eng-lang-tutor/
+ *   uninstall - Remove the skill from ~/.openclaw/skills/eng-lang-tutor/
+ */
+
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+
+const SKILL_NAME = 'eng-lang-tutor';
+const SKILLS_DIR = path.join(os.homedir(), '.openclaw', 'skills');
+const SKILL_TARGET = path.join(SKILLS_DIR, SKILL_NAME);
+
+// Get the package root directory (where package.json is)
+const PACKAGE_ROOT = path.resolve(__dirname, '..');
+
+function getSkillSourceDir() {
+  return PACKAGE_ROOT;
+}
+
+function install() {
+  console.log(`Installing ${SKILL_NAME} skill...`);
+
+  const sourceDir = getSkillSourceDir();
+
+  // Check if source directory exists
+  if (!fs.existsSync(sourceDir)) {
+    console.error(`Error: Source directory not found: ${sourceDir}`);
+    process.exit(1);
+  }
+
+  // Create skills directory if it doesn't exist
+  if (!fs.existsSync(SKILLS_DIR)) {
+    fs.mkdirSync(SKILLS_DIR, { recursive: true });
+    console.log(`Created skills directory: ${SKILLS_DIR}`);
+  }
+
+  // Remove existing installation if present
+  if (fs.existsSync(SKILL_TARGET)) {
+    console.log(`Removing existing installation at ${SKILL_TARGET}...`);
+    fs.rmSync(SKILL_TARGET, { recursive: true, force: true });
+  }
+
+  // Create target directory
+  fs.mkdirSync(SKILL_TARGET, { recursive: true });
+
+  // Files and directories to copy
+  const itemsToCopy = [
+    'scripts',
+    'templates',
+    'references',
+    'examples',
+    'docs',
+    'SKILL.md',
+    'CLAUDE.md',
+    'README.md',
+    'README_EN.md',
+    'requirements.txt'
+  ];
+
+  // Copy each item
+  for (const item of itemsToCopy) {
+    const sourcePath = path.join(sourceDir, item);
+    const targetPath = path.join(SKILL_TARGET, item);
+
+    if (!fs.existsSync(sourcePath)) {
+      console.log(`  Skipping ${item} (not found)`);
+      continue;
+    }
+
+    try {
+      if (fs.statSync(sourcePath).isDirectory()) {
+        copyDir(sourcePath, targetPath);
+      } else {
+        fs.copyFileSync(sourcePath, targetPath);
+      }
+      console.log(`  Copied ${item}`);
+    } catch (err) {
+      console.error(`  Error copying ${item}: ${err.message}`);
+    }
+  }
+
+  console.log(`\n✓ ${SKILL_NAME} installed to ${SKILL_TARGET}`);
+  console.log('\nNext steps:');
+  console.log('  1. Install Python dependencies:');
+  console.log(`     pip install -r ${SKILL_TARGET}/requirements.txt`);
+  console.log('  2. Restart your OpenClaw agent');
+  console.log('  3. Configure the skill through the onboarding flow');
+}
+
+function uninstall() {
+  console.log(`Uninstalling ${SKILL_NAME} skill...`);
+
+  if (!fs.existsSync(SKILL_TARGET)) {
+    console.log(`${SKILL_NAME} is not installed.`);
+    return;
+  }
+
+  try {
+    fs.rmSync(SKILL_TARGET, { recursive: true, force: true });
+    console.log(`✓ ${SKILL_NAME} removed from ${SKILL_TARGET}`);
+    console.log('\nNote: Your learning data is preserved at:');
+    console.log('  ~/.openclaw/state/eng-lang-tutor/');
+    console.log('\nTo completely remove all data, run:');
+    console.log('  rm -rf ~/.openclaw/state/eng-lang-tutor');
+  } catch (err) {
+    console.error(`Error uninstalling: ${err.message}`);
+    process.exit(1);
+  }
+}
+
+function copyDir(src, dest) {
+  fs.mkdirSync(dest, { recursive: true });
+
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+function showHelp() {
+  console.log(`
+eng-lang-tutor - English Language Tutor Skill for OpenClaw
+
+Usage:
+  eng-lang-tutor <command>
+
+Commands:
+  install     Install the skill to ~/.openclaw/skills/eng-lang-tutor/
+  uninstall   Remove the skill (preserves learning data)
+  help        Show this help message
+
+Environment Variables:
+  OPENCLAW_STATE_DIR  Custom directory for learning data
+                      (default: ~/.openclaw/state/eng-lang-tutor)
+
+Examples:
+  eng-lang-tutor install
+  eng-lang-tutor uninstall
+`);
+}
+
+// Main
+const command = process.argv[2];
+
+switch (command) {
+  case 'install':
+    install();
+    break;
+  case 'uninstall':
+    uninstall();
+    break;
+  case 'help':
+  case '--help':
+  case '-h':
+    showHelp();
+    break;
+  default:
+    if (command) {
+      console.error(`Unknown command: ${command}`);
+    }
+    showHelp();
+    process.exit(command ? 1 : 0);
+}

package/docs/OPENCLAW_DEPLOYMENT.md

@@ -0,0 +1,241 @@
+# OpenClaw 部署指南
+
+本文档说明如何将 `eng-lang-tutor` skill 部署到 OpenClaw 服务器，并通过 Discord 等渠道使用。
+
+## 1. 前置条件
+
+- 一台已安装 OpenClaw 的服务器
+- OpenClaw Gateway 正在运行
+- 已配置好 Discord Bot（可选其他渠道）
+
+## 2. 部署步骤
+
+### 2.1 上传 Skill 到服务器
+
+**方式 A：使用 SCP 上传**
+
+```bash
+# 在本地机器上执行
+scp -r /path/to/eng-lang-tutor user@your-server:~/.openclaw/skills/
+```
+
+**方式 B：使用 Git Clone**
+
+```bash
+# 在服务器上执行
+cd ~/.openclaw/skills/
+git clone https://github.com/rookiestar/eng-lang-tutor.git
+```
+
+### 2.2 确认目录结构
+
+确保目录结构如下：
+
+```
+~/.openclaw/skills/eng-lang-tutor/
+├── SKILL.md              # 核心技能文件（必需）
+├── scripts/              # Python 脚本
+│   ├── core/             # 核心模块
+│   │   ├── state_manager.py
+│   │   ├── scorer.py
+│   │   ├── gamification.py
+│   │   ├── constants.py
+│   │   └── error_notebook.py
+│   ├── cli/              # 命令行模块
+│   ├── scheduling/       # 调度模块
+│   ├── utils/            # 工具模块
+│   └── audio/            # 音频模块
+├── templates/            # JSON Schema + Prompt 模板
+├── references/           # 参考资源
+├── examples/             # 示例文件（按 CEFR 级别）
+└── (数据存储在外部目录)
+    ~/.openclaw/state/eng-lang-tutor/  # 运行时数据（自动创建）
+```
+
+### 2.3 验证 Skill 加载
+
+```bash
+# 查看已加载的 skills
+openclaw skills list
+
+# 查看特定 skill 详情
+openclaw skills info eng-lang-tutor
+```
+
+## 3. 配置 Discord 渠道
+
+### 3.1 创建 Discord Bot
+
+1. 访问 [Discord Developer Portal](https://discord.com/developers/applications)
+2. 创建新应用，命名为你的 Bot
+3. 进入 Bot 页面，创建 Bot 并获取 Token
+4. 启用 Message Content Intent
+
+### 3.2 配置 OpenClaw
+
+```bash
+# 设置 Discord Token
+openclaw config set discord.token YOUR_BOT_TOKEN
+
+# 设置服务器 ID（可选）
+openclaw config set discord.guildId YOUR_SERVER_ID
+```
+
+### 3.3 邀请 Bot 到服务器
+
+1. 在 Discord Developer Portal 中，进入 OAuth2 > URL Generator
+2. 选择 `bot` 和 `applications.commands` scope
+3. 选择所需权限（Send Messages, Read Messages 等）
+4. 复制生成的邀请链接并在浏览器中打开
+5. 选择要添加 Bot 的服务器
+
+### 3.4 完成配对
+
+首次与 Bot 对话时，会收到配对码：
+
+```bash
+# 在服务器上执行配对
+openclaw pairing approve discord YOUR_PAIRING_CODE
+```
+
+## 4. 使用 Skill
+
+### 4.1 通过 Discord 使用
+
+在 Discord 中与 Bot 对话，触发英语学习功能：
+
+```
+# 触发今日知识点
+今天有什么英语知识点？
+
+# 触发 Quiz
+给我出个 Quiz
+
+# 查看学习进度
+我的学习进度怎么样？
+```
+
+### 4.2 设置定时推送（cron）
+
+```bash
+# 编辑 crontab
+crontab -e
+
+# 添加每日定时推送
+# 早上 6:45 推送知识点
+45 6 * * * openclaw system event --text "Use eng-lang-tutor skill. Push today's keypoint." --mode now
+
+# 晚上 22:45 推送 Quiz
+45 22 * * * openclaw system event --text "Use eng-lang-tutor skill. Push today's quiz invitation." --mode now
+```
+
+## 5. 进阶配置
+
+### 5.1 配置用户偏好
+
+在 Discord 中与 Bot 对话设置：
+
+```
+设置我的 CEFR 等级为 B2
+我的导师风格设为严谨
+调整主题配比，增加职场内容的比例
+```
+
+### 5.2 配置环境变量
+
+在服务器上设置 API 密钥（如果使用外部 LLM）：
+
+```bash
+# 编辑 OpenClaw 配置
+openclaw config set model.provider anthropic
+openclaw config set model.api_key YOUR_API_KEY
+```
+
+### 5.3 数据持久化
+
+数据存储在 `~/.openclaw/state/eng-lang-tutor/` 目录，确保有正确的写入权限：
+
+```bash
+chmod -R 755 ~/.openclaw/state/eng-lang-tutor/
+```
+
+可通过环境变量 `OPENCLAW_STATE_DIR` 自定义数据目录。
+
+## 6. 故障排查
+
+### 6.1 Skill 未加载
+
+```bash
+# 检查 skill 目录
+ls -la ~/.openclaw/skills/eng-lang-tutor/
+
+# 检查 SKILL.md 是否存在
+cat ~/.openclaw/skills/eng-lang-tutor/SKILL.md
+
+# 重启 Gateway
+openclaw gateway restart
+```
+
+### 6.2 Discord 无响应
+
+```bash
+# 检查 Gateway 日志
+openclaw logs
+
+# 验证 Discord Token
+openclaw config get discord.token
+
+# 检查 Bot 状态
+openclaw doctor
+```
+
+### 6.3 Python 脚本错误
+
+```bash
+# 检查 Python 环境
+python3 --version
+
+# 安装依赖（如有需要）
+pip3 install -r ~/.openclaw/skills/eng-lang-tutor/requirements.txt
+
+# 手动测试脚本
+cd ~/.openclaw/skills/eng-lang-tutor/
+python3 -m scripts.cli.cli stats
+```
+
+## 7. 架构图
+
+```
+┌─────────────────────────────────────────────────────────┐
+│                      Discord                            │
+│                    (用户交互)                            │
+└─────────────────────────┬───────────────────────────────┘
+                          │
+                          ▼
+┌─────────────────────────────────────────────────────────┐
+│                 OpenClaw Gateway                        │
+│              (消息路由 + 会话管理)                        │
+└─────────────────────────┬───────────────────────────────┘
+                          │
+                          ▼
+┌─────────────────────────────────────────────────────────┐
+│               eng-lang-tutor Skill                      │
+│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐    │
+│  │ SKILL.md    │  │ scripts/    │  │ ~/.openclaw │    │
+│  │ (技能描述)   │  │ (Python代码) │  │ (状态存储)   │    │
+│  └─────────────┘  └─────────────┘  └─────────────┘    │
+└─────────────────────────────────────────────────────────┘
+                          │
+                          ▼
+┌─────────────────────────────────────────────────────────┐
+│                    LLM Provider                         │
+│              (Claude/GPT/Qwen 等)                       │
+└─────────────────────────────────────────────────────────┘
+```
+
+## 8. 参考链接
+
+- [OpenClaw 官方文档](https://docs.openclaw.ai)
+- [OpenClaw GitHub](https://github.com/openclaw/openclaw)
+- [Discord 开发者门户](https://discord.com/developers/applications)
+- [OpenClaw Skills 开发指南](https://docs.openclaw.ai/skills)

package/examples/sample_keypoint_a1.json

@@ -0,0 +1,112 @@
+{
+  "_meta": {
+    "prompt_version": "keypoint_gen_v2.1"
+  },
+  "date": "2026-02-25",
+  "topic_fingerprint": "daily_life_thank_you",
+  "category": "oral",
+  "topic": "daily_life",
+  "scene": {
+    "context": "You are at a shop or restaurant. Someone helps you or gives you something. This is the most basic polite expression in English.",
+    "formality": "neutral"
+  },
+  "expressions": [
+    {
+      "phrase": "Thank you",
+      "pronunciation_tip": "Sounds like 'thank-you', say it as one word. Natural speed: 'than-kyou'",
+      "usage_note": "Use this when someone helps you or gives you something. It works in ALL situations."
+    },
+    {
+      "phrase": "Thanks",
+      "pronunciation_tip": "Short and casual: 'thanks'",
+      "usage_note": "More casual than 'Thank you'. Use with friends or in informal situations."
+    }
+  ],
+  "alternatives": [
+    "Thanks a lot",
+    "Thank you very much"
+  ],
+  "chinglish_trap": {
+    "wrong": "Thank you very many",
+    "correct": "Thank you very much",
+    "explanation": "'Many' is for things you can count (many apples). 'Much' is for amount or degree (very much). This is a common mistake from direct Chinese translation."
+  },
+  "examples": [
+    {
+      "situation": "At a coffee shop",
+      "dialogue": [
+        "A: Here's your coffee.",
+        "B: Thank you!"
+      ]
+    },
+    {
+      "situation": "Someone holds the door",
+      "dialogue": [
+        "A: (holds door open)",
+        "B: Thanks!"
+      ]
+    }
+  ],
+  "references": {
+    "dictionary": {
+      "source": "merriam-webster",
+      "url": "https://www.merriam-webster.com/dictionary/thank%20you",
+      "note": "Definition and usage examples"
+    },
+    "usage_context": {
+      "source": "youglish",
+      "url": "https://youglish.com/pronounce/thank%20you/english/us",
+      "note": "Hear it in real YouTube videos"
+    }
+  },
+  "display": {
+    "title": "🏢 今日知识点 | Today's Knowledge Point",
+    "topic_tag": "🏷️ 主题: 日常生活 | Daily Life",
+    "formality_tag": "📊 正式度: 中性 | Neutral",
+    "scene_intro": "🎬 场景 | Scene",
+    "scene_text": "At a shop or restaurant - basic polite expression",
+    "expressions_title": "💬 核心表达 | Key Expressions",
+    "expressions_formatted": [
+      {
+        "emoji": "✨",
+        "phrase": "**Thank you**",
+        "phrase_plain": "Thank you",
+        "pronunciation": "🔊 'than-kyou' - say as one word",
+        "usage": "💡 Use when someone helps you. Works in ALL situations."
+      },
+      {
+        "emoji": "✨",
+        "phrase": "**Thanks**",
+        "phrase_plain": "Thanks",
+        "pronunciation": "🔊 Short and casual",
+        "usage": "💡 More casual. Use with friends."
+      }
+    ],
+    "alternatives_title": "🔄 其他说法 | Alternatives",
+    "alternatives_formatted": "• **Thanks a lot**\n• **Thank you very much**",
+    "chinglish_title": "⚠️ Chinglish 陷阱 | Chinglish Trap",
+    "chinglish_formatted": "❌ Wrong: \"Thank you very **many**\"\n✅ Correct: **Thank you very much!**\n\n📝 'Many' = 可数 (many apples). 'Much' = 程度 (very much).",
+    "examples_title": "🗣️ 对话示例 | Example Dialogues",
+    "examples_formatted": [
+      {
+        "situation_emoji": "☕",
+        "situation": "At a coffee shop",
+        "dialogue": "💬 A: Here's your coffee.\n💬 B: **Thank you!**",
+        "key_phrase_highlight": "**Thank you**"
+      },
+      {
+        "situation_emoji": "🚪",
+        "situation": "Someone holds the door",
+        "dialogue": "💬 A: (holds door)\n💬 B: **Thanks!**",
+        "key_phrase_highlight": "**Thanks**"
+      }
+    ],
+    "references_title": "📖 权威参考 | References",
+    "references_formatted": "📚 [Merriam-Webster](https://www.merriam-webster.com/dictionary/thank%20you) - Definition\n🎬 [YouGlish](https://youglish.com/pronounce/thank%20you/english/us) - Real usage",
+    "footer": "───────────────────\n📅 2026-02-25 | 📝 Take the quiz to earn XP!"
+  },
+  "audio": {
+    "enabled": true
+  },
+  "generated": true
+}

package/examples/sample_keypoint_a2.json

@@ -0,0 +1,124 @@
+{
+  "_meta": {
+    "prompt_version": "keypoint_gen_v2.1"
+  },
+  "date": "2026-02-25",
+  "topic_fingerprint": "social_nice_to_meet_you",
+  "category": "oral",
+  "topic": "social",
+  "scene": {
+    "context": "You are meeting someone for the first time. This is the standard polite expression when introduced to a new person.",
+    "formality": "neutral"
+  },
+  "expressions": [
+    {
+      "phrase": "Nice to meet you",
+      "pronunciation_tip": "Natural: 'nice-tuh-meet-chu'. The 'to' becomes 'tuh' and 'you' becomes 'chu'.",
+      "usage_note": "Use ONLY when meeting someone for the FIRST time. This is the most common introduction phrase."
+    },
+    {
+      "phrase": "Pleasure to meet you",
+      "pronunciation_tip": "More formal: 'pleh-zher-tuh-meet-chu'",
+      "usage_note": "Slightly more formal than 'Nice to meet you'. Good for business settings."
+    }
+  ],
+  "alternatives": [
+    "Good to meet you",
+    "It's a pleasure",
+    "Glad to meet you"
+  ],
+  "chinglish_trap": {
+    "wrong": "Nice to see you (when first meeting)",
+    "correct": "Nice to meet you",
+    "explanation": "'See you' is for people you already know or have met before. 'Meet you' is ONLY for first introductions. Chinese speakers often mix these up."
+  },
+  "examples": [
+    {
+      "situation": "At a party introduction",
+      "dialogue": [
+        "A: Sarah, this is Tom. Tom, this is Sarah.",
+        "B: Nice to meet you, Sarah!",
+        "C: Nice to meet you too, Tom!"
+      ]
+    },
+    {
+      "situation": "First day at work",
+      "dialogue": [
+        "A: Welcome to the team! I'm the manager, Lisa.",
+        "B: Pleasure to meet you, Lisa. I'm excited to be here."
+      ]
+    }
+  ],
+  "extended_learning": {
+    "related_phrases": [
+      "See you later - for someone you'll see again soon",
+      "See you soon - promise to meet again",
+      "It was nice meeting you - when saying goodbye after first meeting"
+    ],
+    "cultural_note": "In American culture, it's polite to smile and make eye contact when saying 'Nice to meet you'. A firm handshake is common in business settings."
+  },
+  "references": {
+    "dictionary": {
+      "source": "merriam-webster",
+      "url": "https://www.merriam-webster.com/dictionary/meet",
+      "note": "Definition of 'meet' vs 'see'"
+    },
+    "usage_context": {
+      "source": "youglish",
+      "url": "https://youglish.com/pronounce/nice%20to%20meet%20you/english/us",
+      "note": "Hear it in real introductions"
+    }
+  },
+  "display": {
+    "title": "🏢 今日知识点 | Today's Knowledge Point",
+    "topic_tag": "🏷️ 主题: 社交 | Social",
+    "formality_tag": "📊 正式度: 中性 | Neutral",
+    "scene_intro": "🎬 场景 | Scene",
+    "scene_text": "Meeting someone for the first time - standard introduction",
+    "expressions_title": "💬 核心表达 | Key Expressions",
+    "expressions_formatted": [
+      {
+        "emoji": "✨",
+        "phrase": "**Nice to meet you**",
+        "phrase_plain": "Nice to meet you",
+        "pronunciation": "🔊 'nice-tuh-meet-chu' - natural flow",
+        "usage": "💡 ONLY for first-time introductions!"
+      },
+      {
+        "emoji": "✨",
+        "phrase": "**Pleasure to meet you**",
+        "phrase_plain": "Pleasure to meet you",
+        "pronunciation": "🔊 'pleh-zher-tuh-meet-chu' - more formal",
+        "usage": "💡 Slightly more formal, good for business."
+      }
+    ],
+    "alternatives_title": "🔄 其他说法 | Alternatives",
+    "alternatives_formatted": "• **Good to meet you**\n• **It's a pleasure**\n• **Glad to meet you**",
+    "chinglish_title": "⚠️ Chinglish 陷阱 | Chinglish Trap",
+    "chinglish_formatted": "❌ Wrong: \"Nice to **see** you\" (first meeting)\n✅ Correct: **Nice to meet you!**\n\n📝 'See' = already know. 'Meet' = first time only!",
+    "examples_title": "🗣️ 对话示例 | Example Dialogues",
+    "examples_formatted": [
+      {
+        "situation_emoji": "🎉",
+        "situation": "At a party introduction",
+        "dialogue": "💬 A: Sarah, this is Tom.\n💬 B: **Nice to meet you**, Sarah!\n💬 C: **Nice to meet you too**, Tom!",
+        "key_phrase_highlight": "**Nice to meet you**"
+      },
+      {
+        "situation_emoji": "💼",
+        "situation": "First day at work",
+        "dialogue": "💬 A: Welcome! I'm Lisa, the manager.\n💬 B: **Pleasure to meet you**, Lisa.",
+        "key_phrase_highlight": "**Pleasure to meet you**"
+      }
+    ],
+    "extended_title": "📚 延伸学习 | Extended Learning",
+    "extended_formatted": "🔗 Related: **See you later** | **See you soon** | **It was nice meeting you**\n\n🌎 Tip: Smile + eye contact when saying 'Nice to meet you'!",
+    "references_title": "📖 权威参考 | References",
+    "references_formatted": "📚 [Merriam-Webster](https://www.merriam-webster.com/dictionary/meet) - Meet vs See\n🎬 [YouGlish](https://youglish.com/pronounce/nice%20to%20meet%20you/english/us) - Real usage",
+    "footer": "───────────────────\n📅 2026-02-25 | 📝 Take the quiz to earn XP!"
+  },
+  "audio": {
+    "enabled": true
+  },
+  "generated": true
+}