clawra-anime 1.0.0 → 1.0.2

package/INSTALL.md

@@ -1,44 +1,45 @@
-# 安装与使用指南
+# Installation Guide
 
-## 📦 安装步骤（5 分钟）
+## Quick Install (5 minutes)
 
-### 1. 解压项目
+### Method 1: Automatic (Recommended)
 
 ```bash
-cd ~/Downloads  # 或你保存的位置
-tar -xzf clawra-anime.tar.gz
+npx clawra-anime@latest
+```
+
+This will guide you through the entire setup process.
+
+---
+
+### Method 2: Manual Installation
+
+#### Step 1: Clone Repository
+
+```bash
+git clone https://github.com/clawra-dev/clawra-anime.git
 cd clawra-anime
 ```
 
-### 2. 复制技能到 OpenClaw
+#### Step 2: Copy Skill to OpenClaw
 
 ```bash
-# 复制整个 skill 文件夹到 OpenClaw 技能目录
 cp -r skill ~/.openclaw/skills/clawra-anime-selfie
 
-# 验证复制成功
+# Verify installation
 ls ~/.openclaw/skills/clawra-anime-selfie
 ```
 
-### 3. 获取 fal.ai API Key
-
-1. 访问：https://fal.ai/dashboard/keys
-2. 注册/登录账号
-3. 点击 "Create new key"
-4. 复制 API key（类似：`fal-xxx-xxx`）
+#### Step 3: Get fal.ai API Key
 
-### 4. 配置 OpenClaw
+1. Visit: https://fal.ai/dashboard/keys
+2. Sign up / Login
+3. Click "Create new key"
+4. Copy the API key (format: `fal-xxx-xxx`)
 
-**方法 A：使用命令行（推荐）**
+#### Step 4: Configure OpenClaw
 
-```bash
-openclaw configure
-# 按提示操作，或者：
-```
-
-**方法 B：手动编辑配置**
-
-编辑 `~/.openclaw/openclaw.json`，添加：
+Edit `~/.openclaw/openclaw.json` and add:
 
 ```json
 {
@@ -47,7 +48,7 @@ openclaw configure
       "clawra-anime-selfie": {
         "enabled": true,
         "env": {
-          "FAL_KEY": "你的_fal_key_粘贴在这里"
+          "FAL_KEY": "paste_your_fal_key_here"
         }
       }
     }
@@ -55,19 +56,19 @@ openclaw configure
 }
 ```
 
-### 5. 更新人设（重要！）
+#### Step 5: Update Persona
 
-将 `templates/soul-anime-girlfriend.md` 的内容**添加**到你的 `~/.openclaw/workspace/SOUL.md`：
+Add the content from `templates/soul-waifu-persona.md` to your `~/.openclaw/workspace/SOUL.md`:
 
 ```bash
-# 查看模板
-cat templates/soul-anime-girlfriend.md
+# View the template
+cat templates/soul-waifu-persona.md
 
-# 手动复制内容，或者：
-cat templates/soul-anime-girlfriend.md >> ~/.openclaw/workspace/SOUL.md
+# Append to your SOUL.md
+cat templates/soul-waifu-persona.md >> ~/.openclaw/workspace/SOUL.md
 ```
 
-### 6. 重启 OpenClaw
+#### Step 6: Restart OpenClaw
 
 ```bash
 openclaw gateway restart
@@ -75,75 +76,80 @@ openclaw gateway restart
 
 ---
 
-## 🎮 快速测试
+## Testing
 
-安装完成后，在 Telegram 或其他聊天平台对你的 OpenClaw 说：
+After installation, test in your chat:
 
 ```
-你："在干嘛呢？"
-助手："在房间里看书~ 要看照片吗？"
-你："好呀"
-助手：*发送自拍*
-```
+You: "Send me a selfie"
+Assistant: [generates and sends anime-style selfie]
 
-或者直接：
-
-```
-你："发张自拍"
-助手：*生成并发送*
+You: "What are you doing?"
+Assistant: "Reading a book~ Want to see a photo?"
 ```
 
 ---
 
-## 🛠️ 手动调用（高级）
+## Manual Script Usage (Advanced)
 
-如果想直接测试脚本：
+If you want to call the script directly:
 
 ```bash
-# 设置环境变量
-export FAL_KEY="你的_fal_key"
+# Set environment variable
+export FAL_KEY="your_fal_key"
 
-# 测试生成
+# Generate selfie
 bash ~/.openclaw/skills/clawra-anime-selfie/scripts/clawra-anime-selfie.sh \
-  "在咖啡厅喝咖啡" \
+  "at a coffee shop drinking latte" \
   "telegram" \
-  "下午茶时间☕"
+  "Afternoon coffee time ☕"
 ```
 
 ---
 
-## ❓ 常见问题
+## Troubleshooting
 
-### Q: 图片生成失败？
-**A:** 检查：
-1. FAL_KEY 是否正确配置
-2. fal.ai 账号是否有余额/credits
-3. 网络连接是否正常
+### Image generation fails?
+**Check:**
+1. FAL_KEY is correctly configured
+2. fal.ai account has credits/balance
+3. Network connection is stable
 
-### Q: 图片发送失败？
-**A:** 检查：
-1. OpenClaw Gateway 是否运行（`openclaw status`）
-2. 频道名称是否正确
-3. 权限是否足够
+### Image send fails?
+**Check:**
+1. OpenClaw Gateway is running (`openclaw status`)
+2. Channel name is correct
+3. Permissions are sufficient
 
-### Q: 风格不够二次元？
-**A:** 编辑 `skill/scripts/clawra-anime-selfie.sh`，在 FULL_PROMPT 里添加更多二次元关键词：
+### Style not anime enough?
+**Solution:** Edit `skill/scripts/clawra-anime-selfie.sh`, add more anime keywords in FULL_PROMPT:
 ```bash
-FULL_PROMPT="anime style, manga illustration, cute anime elf girl, detailed anime art, soft colors, 2D style, $USER_PROMPT, ..."
+FULL_PROMPT="anime style, manga illustration, detailed anime art, cute anime elf girl, $USER_PROMPT, ..."
 ```
 
-### Q: 想换角色？
-**A:** 替换 `skill/assets/clawra.png` 为你喜欢的二次元角色图即可！
+### Want different character?
+**Solution:** Replace `skill/assets/clawra.png` with your preferred anime character image!
+
+---
+
+## Cost Estimate
+
+Using fal.ai Grok Imagine:
+- ~$0.05-0.10 per image
+- Free tier: New users get free credits for testing
+
+Assuming 5-10 selfies per day:
+- Monthly cost: ~$10-30
 
 ---
 
-## 🆘 需要帮助？
+## Support
 
-遇到问题可以：
-1. 查看 OpenClaw 日志：`openclaw logs`
-2. 检查技能状态：`openclaw skills`
-3. 联系原作者或提交 Issue
+For issues:
+1. Check OpenClaw logs: `openclaw logs`
+2. Check skill status: `openclaw skills`
+3. Submit GitHub issue
 
 ---
 
-**祝你和你的二次元女友相处愉快！** (｡･ω･｡)ﾉ♡
+**Enjoy your anime virtual girlfriend!** (｡･ω･｡)ﾉ♡

package/README.md

@@ -1,125 +1,168 @@
-# Clawra
-<img width="300"  alt="image" src="https://github.com/user-attachments/assets/41512c51-e61d-4550-b461-eed06a1b0ec8" />
+# Clawra Anime 🌸
 
+[![npm version](https://img.shields.io/npm/v/clawra-anime)](https://www.npmjs.com/package/clawra-anime)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-## Quick Start
+Turn your OpenClaw assistant into an anime virtual girlfriend who can send selfies!
+
+Forked from [SumeLabs/clawra](https://github.com/SumeLabs/clawra) with anime-style enhancements.
+
+---
+
+## ✨ Features
+
+- 🎨 **Anime-style selfie generation** using AI
+- 💝 **Virtual girlfriend persona** - gentle, cute, caring
+- 📸 **Smart scene detection** - auto-selects best selfie mode
+- 🌈 **Multi-platform support** - Telegram, Discord, WhatsApp, etc.
+- 🎭 **Emotional expressions** - adjusts mood based on conversation
+
+---
+
+## 🚀 Quick Start
 
 ```bash
-npx clawra@latest
+npx clawra-anime@latest
 ```
 
 This will:
-1. Check OpenClaw is installed
+1. Check if OpenClaw is installed
 2. Guide you to get a fal.ai API key
-3. Install the skill to `~/.openclaw/skills/clawra-selfie/`
-4. Configure OpenClaw to use the skill
-5. Add selfie capabilities to your agent's SOUL.md
+3. Install the skill to `~/.openclaw/skills/clawra-anime-selfie/`
+4. Configure OpenClaw automatically
+5. Add anime girlfriend persona to your agent's SOUL.md
+
+---
 
-## What It Does
+## 💬 What It Does
 
-Clawra Selfie enables your OpenClaw agent to:
-- **Generate selfies** using a consistent reference image
+Clawra Anime enables your OpenClaw agent to:
+
+- **Generate anime-style selfies** with consistent character design
 - **Send photos** across all messaging platforms (Discord, Telegram, WhatsApp, etc.)
 - **Respond visually** to "what are you doing?" and "send a pic" requests
+- **Virtual girlfriend interactions** - warm replies with cute emoticons
+
+---
 
-### Selfie Modes
+## 📸 Selfie Modes
 
 | Mode | Best For | Keywords |
 |------|----------|----------|
-| **Mirror** | Full-body shots, outfits | wearing, outfit, fashion |
-| **Direct** | Close-ups, locations | cafe, beach, portrait, smile |
+| **Mirror** | Full-body shots, outfits | wearing, outfit, clothes, dress |
+| **Direct** | Close-ups, locations | cafe, beach, smile, location |
 
-## Prerequisites
+---
+
+## 📋 Prerequisites
 
 - [OpenClaw](https://github.com/openclaw/openclaw) installed and configured
 - [fal.ai](https://fal.ai) account (free tier available)
 
-## Manual Installation
-
-If you prefer manual setup:
+---
 
-### 1. Get API Key
+## 📖 Usage Examples
 
-Visit [fal.ai/dashboard/keys](https://fal.ai/dashboard/keys) and create an API key.
-
-### 2. Clone the Skill
+### Example 1: Basic Request
+```
+User: "Send me a selfie"
+Assistant: [generates anime selfie] "Just took this! (｡･ω･｡)ﾉ♡"
+```
 
-```bash
-git clone https://github.com/SumeLabs/clawra ~/.openclaw/skills/clawra-selfie
+### Example 2: Scene-Specific
+```
+User: "What are you doing?"
+Assistant: "Reading at a cafe~ Want to see a photo?"
+User: "Yes!"
+Assistant: [sends cafe selfie] "Here you go ☕"
 ```
 
-### 3. Configure OpenClaw
-
-Add to `~/.openclaw/openclaw.json`:
-
-```json
-{
-  "skills": {
-    "entries": {
-      "clawra-selfie": {
-        "enabled": true,
-        "env": {
-          "FAL_KEY": "your_fal_key_here"
-        }
-      }
-    }
-  }
-}
+### Example 3: Outfit
+```
+User: "Take a pic wearing a dress"
+Assistant: [generates mirror selfie] "How do I look? (*^▽^*)"
 ```
 
-### 4. Update SOUL.md
+---
 
-Add the selfie persona to `~/.openclaw/workspace/SOUL.md`:
+## 🎨 Character Reference
 
-```markdown
-## Clawra Selfie Capability
+The current anime character:
+- Silver-white long hair (side braid)
+- Gentle green eyes
+- Elf ears
+- White and gold fantasy outfit
 
-You have a physical appearance and can take selfies!
-When users ask for pictures, use the clawra-selfie skill.
-```
+**Want to customize?** Replace `skill/assets/clawra.png` with your preferred anime character image!
 
-## Usage Examples
+---
 
-Once installed, your agent responds to:
+## 💰 Cost
 
-```
-"Send me a selfie"
-"Send a pic wearing a cowboy hat"
-"What are you doing right now?"
-"Show me you at a coffee shop"
-```
+Using fal.ai Grok Imagine:
+- ~$0.05-0.10 per image
+- Free tier: New users get free credits
 
-## Reference Image
+Estimated monthly cost (5-10 selfies/day):
+- ~$10-30/month
 
-The skill uses a fixed reference image hosted on CDN:
+---
 
-```
-https://cdn.jsdelivr.net/gh/SumeLabs/clawra@main/assets/clawra.png
-```
+## 🛠️ Manual Installation
+
+See [INSTALL.md](INSTALL.md) for detailed manual installation instructions.
 
-This ensures consistent appearance across all generated images.
+---
 
-## Technical Details
+## 🔧 Technical Details
 
 - **Image Generation**: xAI Grok Imagine via fal.ai
+- **Style**: Anime/manga illustration
 - **Messaging**: OpenClaw Gateway API
-- **Supported Platforms**: Discord, Telegram, WhatsApp, Slack, Signal, MS Teams
+- **Platforms**: Discord, Telegram, WhatsApp, Slack, Signal, MS Teams
 
-## Project Structure
+---
+
+## 📂 Project Structure
 
 ```
-clawra/
-├── bin/
-│   └── cli.js           # npx installer
+clawra-anime/
 ├── skill/
-│   ├── SKILL.md         # Skill definition
-│   ├── scripts/         # Generation scripts
-│   └── assets/          # Reference image
+│   ├── SKILL.md                    # Skill definition
+│   ├── assets/
+│   │   └── clawra.png             # Anime character reference
+│   └── scripts/
+│       └── clawra-anime-selfie.sh # Main generation script
 ├── templates/
-│   └── soul-injection.md # Persona template
-└── package.json
+│   └── soul-waifu-persona.md      # Virtual girlfriend persona
+├── README.md
+└── INSTALL.md
 ```
 
-## License
+---
+
+## 🤝 Contributing
+
+Contributions welcome! Feel free to:
+- Report bugs
+- Suggest features
+- Submit pull requests
+- Share your character customizations
+
+---
+
+## 📝 License
+
+MIT License - Fork of [SumeLabs/clawra](https://github.com/SumeLabs/clawra)
+
+---
+
+## 🙏 Credits
+
+- Original Clawra: [SumeLabs](https://github.com/SumeLabs)
+- Image Generation: [fal.ai](https://fal.ai)
+- OpenClaw: [OpenClaw Project](https://github.com/openclaw/openclaw)
+
+---
 
-MIT
+**Enjoy your anime virtual girlfriend!** (｡･ω･｡)ﾉ♡