claude-code-achievements 1.2.2 → 1.2.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.
Files changed (9) hide show
  1. package/.claude-plugin/plugin.json +1 -1
  2. package/README.es.md +177 -227
  3. package/README.ja.md +177 -227
  4. package/README.ko.md +177 -227
  5. package/README.md +177 -227
  6. package/README.zh.md +177 -227
  7. package/bin/install.js +79 -61
  8. package/hooks/track-achievement.sh +2 -1
  9. package/package.json +1 -1
package/README.md CHANGED
@@ -1,18 +1,24 @@
1
1
  <div align="center">
2
2
 
3
- <img src="assets/icon.png" alt="Claude Code Achievements" width="120" height="120">
3
+ <img src="assets/icon.png" alt="Claude Code Achievements" width="128" height="128">
4
4
 
5
5
  # Claude Code Achievements
6
6
 
7
- **Steam-style achievement system for Claude Code**
7
+ ### Level up your AI coding skills
8
8
 
9
- [![npm version](https://img.shields.io/npm/v/claude-code-achievements.svg?style=flat-square&color=CB3837)](https://www.npmjs.com/package/claude-code-achievements)
10
- [![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
11
- [![node](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen.svg?style=flat-square)](package.json)
9
+ [![npm version](https://img.shields.io/npm/v/claude-code-achievements.svg?style=for-the-badge&color=FFD700)](https://www.npmjs.com/package/claude-code-achievements)
10
+ [![downloads](https://img.shields.io/npm/dt/claude-code-achievements.svg?style=for-the-badge&color=4CAF50)](https://www.npmjs.com/package/claude-code-achievements)
11
+ [![license](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](LICENSE)
12
12
 
13
- Gamify your coding journey and unlock achievements as you master Claude Code features!
13
+ ```
14
+ ╔══════════════════════════════════════════════════════════════╗
15
+ ║ 🎮 UNLOCK ACHIEVEMENTS • TRACK PROGRESS • HAVE FUN 🎮 ║
16
+ ╚══════════════════════════════════════════════════════════════╝
17
+ ```
14
18
 
15
- [Installation](#installation) · [Usage](#usage) · [Achievements](#achievements) · [How It Works](#architecture)
19
+ **Transform your Claude Code experience into an RPG adventure!**
20
+
21
+ [Quick Start](#-quick-start) · [Achievements](#-achievements) · [Commands](#-commands)
16
22
 
17
23
  **[中文](README.zh.md)** · **[Español](README.es.md)** · **[한국어](README.ko.md)** · **[日本語](README.ja.md)**
18
24
 
@@ -20,296 +26,240 @@ Gamify your coding journey and unlock achievements as you master Claude Code fea
20
26
 
21
27
  ---
22
28
 
23
- ## Features
29
+ ## ✨ Why This Exists
24
30
 
25
- - **26 Achievements** across 4 categories
26
- - **Real-time notifications** via system alerts or terminal
27
- - **Multi-language support** (EN / 中文 / ES / 한국어 / 日本語)
28
- - **Cross-platform** (macOS / Linux / Windows)
29
- - **Global installation** - works across all your projects
31
+ Learning Claude Code is a journey. This plugin turns that journey into a **game**.
30
32
 
31
- ## Installation
33
+ - 🏆 **26 Achievements** to unlock across 4 skill trees
34
+ - 🔔 **Real-time notifications** when you level up
35
+ - 📊 **Track your mastery** from beginner to expert
36
+ - 🌍 **5 Languages** supported
37
+
38
+ ---
39
+
40
+ ## 🚀 Quick Start
32
41
 
33
42
  ```bash
34
43
  npx claude-code-achievements
35
44
  ```
36
45
 
37
- The interactive installer will:
38
- 1. Auto-detect your OS and notification capability
39
- 2. Ask for language preference (English/한국어)
40
- 3. Configure notification style (system/terminal/both)
41
- 4. Install globally to `~/.claude/plugins/local/`
46
+ That's it. Start coding and watch the achievements roll in!
47
+
48
+ ---
42
49
 
43
- > **Note:** This plugin installs **globally** and works across all your projects automatically.
50
+ ## 🏆 Achievements
44
51
 
45
- ### Manual Installation
52
+ <table>
53
+ <tr>
54
+ <td width="25%" align="center">
46
55
 
47
- ```bash
48
- git clone https://github.com/subinium/claude-code-achievements.git
49
- cd claude-code-achievements
50
- node bin/install.js
51
- ```
56
+ ### 🌱 Getting Started
57
+ **4 Achievements**
52
58
 
53
- ## Usage
59
+ *Your first steps*
54
60
 
55
- | Command | Description |
56
- |---------|-------------|
57
- | `/achievements` | View unlocked achievements (default) |
58
- | `/achievements locked` | View locked achievements with hints |
59
- | `/achievements all` | View all achievements by category |
60
- | `/achievements-settings` | Change language or notification settings |
61
+ </td>
62
+ <td width="25%" align="center">
61
63
 
62
- ### Category Filters
64
+ ### ⚡ Workflow
65
+ **8 Achievements**
63
66
 
64
- ```bash
65
- /achievements basics # Getting Started
66
- /achievements workflow # Workflow
67
- /achievements tools # Power Tools
68
- /achievements mastery # Mastery
69
- ```
67
+ *Work smarter*
68
+
69
+ </td>
70
+ <td width="25%" align="center">
70
71
 
71
- ## Achievements
72
-
73
- <details>
74
- <summary><b>Getting Started</b> (4 achievements)</summary>
75
-
76
- | Achievement | How to Unlock |
77
- |-------------|---------------|
78
- | ✏️ **First Touch** | Edit any file |
79
- | 📝 **Creator** | Create a new file |
80
- | 🔍 **Code Detective** | Use Glob or Grep to search codebase |
81
- | 📋 **Project Curator** | Create `CLAUDE.md` for project context |
82
-
83
- </details>
84
-
85
- <details>
86
- <summary><b>Workflow</b> (8 achievements)</summary>
87
-
88
- | Achievement | How to Unlock |
89
- |-------------|---------------|
90
- | 📋 **Task Planner** | Use TodoWrite for task tracking |
91
- | 🎯 **Strategic Thinker** | Use Plan mode (`Shift+Tab` twice) |
92
- | 🗣️ **Communicator** | Claude uses `AskUserQuestion` to clarify requirements or present options |
93
- | 🌍 **Global Curator** | Set up `~/.claude/CLAUDE.md` |
94
- | 📦 **Version Controller** | Commit with Claude |
95
- | 🚀 **Ship It!** | Push to remote repository |
96
- | 🧪 **Quality Guardian** | Run tests with Claude |
97
- | 🚦 **CI/CD Pioneer** | Create GitHub Actions workflow |
98
-
99
- </details>
100
-
101
- <details>
102
- <summary><b>Power Tools</b> (9 achievements)</summary>
103
-
104
- | Achievement | How to Unlock |
105
- |-------------|---------------|
106
- | 🎨 **Visual Inspector** | Analyze image or screenshot |
107
- | 📡 **Doc Hunter** | Fetch and analyze a web page |
108
- | 🤖 **Delegation Master** | Use `Task` tool for sub-agents |
109
- | 🔌 **MCP Pioneer** | Use any MCP tool |
110
- | 🌐 **Web Explorer** | Use `WebSearch` tool |
111
- | ⚙️ **Customizer** | Modify Claude Code settings |
112
- | 📜 **Skill Creator** | Create custom skill in `.claude/skills/` |
113
- | ⌨️ **Command Crafter** | Create custom slash command |
114
- | 🧩 **Plugin Explorer** | Install a plugin from marketplace |
115
-
116
- </details>
117
-
118
- <details>
119
- <summary><b>Mastery</b> (5 achievements)</summary>
120
-
121
- | Achievement | How to Unlock |
122
- |-------------|---------------|
123
- | 🪝 **Automation Architect** | Set up Claude Code hooks |
124
- | 🔗 **MCP Connector** | Configure `.mcp.json` for integrations |
125
- | 🤖 **Agent Architect** | Create custom agent in `.claude/agents/` |
126
- | 🛡️ **Security Guard** | Configure security permissions |
127
- | 🔄 **Loop Master** | Start autonomous coding loop |
128
-
129
- </details>
72
+ ### 🔧 Power Tools
73
+ **9 Achievements**
74
+
75
+ *Unlock abilities*
76
+
77
+ </td>
78
+ <td width="25%" align="center">
79
+
80
+ ### 👑 Mastery
81
+ **5 Achievements**
82
+
83
+ *Become a legend*
84
+
85
+ </td>
86
+ </tr>
87
+ </table>
130
88
 
131
89
  ---
132
90
 
133
- ## Architecture
91
+ ### 🌱 Getting Started
134
92
 
135
- This plugin uses **Claude Code's hook system** to track your actions in real-time.
93
+ > *Every master was once a beginner*
136
94
 
137
- ```
138
- ┌─────────────────────────────────────────────────────────────┐
139
- │ CLAUDE CODE SESSION │
140
- ├─────────────────────────────────────────────────────────────┤
141
- │ │
142
- │ You: "Edit the config file" │
143
- │ │ │
144
- │ ▼ │
145
- │ ┌─────────────────────────────────────┐ │
146
- │ │ Claude uses Edit tool │ │
147
- │ └─────────────────────────────────────┘ │
148
- │ │ │
149
- │ ▼ │
150
- │ ┌─────────────────────────────────────┐ │
151
- │ │ PostToolUse Hook Triggered │◄── hooks.json │
152
- │ │ → track-achievement.sh │ │
153
- │ └─────────────────────────────────────┘ │
154
- │ │ │
155
- │ ┌──────────┴──────────┐ │
156
- │ ▼ ▼ │
157
- │ ┌───────────┐ ┌───────────┐ │
158
- │ │ Match! │ │ No Match │ │
159
- │ │ │ │ │ │
160
- │ │ Unlock │ │ Continue │ │
161
- │ │ Notify │ └───────────┘ │
162
- │ │ Save │ │
163
- │ └───────────┘ │
164
- │ │
165
- └─────────────────────────────────────────────────────────────┘
166
- ```
95
+ | | Achievement | Quest |
96
+ |:--:|-------------|-------|
97
+ | ✏️ | **First Touch** | Edit any file with Claude |
98
+ | 📝 | **Creator** | Create a new file |
99
+ | 🔍 | **Code Detective** | Search codebase with Glob or Grep |
100
+ | 📋 | **Project Curator** | Create your first `CLAUDE.md` |
167
101
 
168
- ### Plugin Structure
102
+ ---
169
103
 
170
- ```
171
- ~/.claude/plugins/local/claude-code-achievements/
172
- ├── .claude-plugin/
173
- │ └── plugin.json # Plugin metadata
174
- ├── hooks/
175
- │ ├── hooks.json # Hook definitions (PostToolUse, Stop)
176
- │ ├── track-achievement.sh # Main tracking logic
177
- │ └── track-stop.sh # Session end handler
178
- ├── commands/
179
- │ ├── achievements.md # /achievements command
180
- │ └── achievements-settings.md
181
- ├── scripts/
182
- │ ├── show-achievements.sh # Display UI
183
- │ └── show-notification.sh # Notification handler
184
- └── data/
185
- ├── achievements.json # Achievement definitions
186
- └── i18n/
187
- ├── en.json # English
188
- ├── zh.json # 中文
189
- ├── es.json # Español
190
- ├── ko.json # 한국어
191
- └── ja.json # 日本語
192
- ```
104
+ ### ⚡ Workflow
193
105
 
194
- ### How Hooks Work
106
+ > *Efficiency is intelligent laziness*
195
107
 
196
- The plugin registers two hooks in Claude Code:
108
+ | | Achievement | Quest |
109
+ |:--:|-------------|-------|
110
+ | 📋 | **Task Planner** | Use TodoWrite for task tracking |
111
+ | 🎯 | **Strategic Thinker** | Enter Plan mode (`Shift+Tab` × 2) |
112
+ | 🗣️ | **Communicator** | Have Claude ask you a clarifying question |
113
+ | 🌍 | **Global Curator** | Set up global `~/.claude/CLAUDE.md` |
114
+ | 📦 | **Version Controller** | Make a commit with Claude |
115
+ | 🚀 | **Ship It!** | Push code to remote |
116
+ | 🧪 | **Quality Guardian** | Run tests |
117
+ | 🚦 | **CI/CD Pioneer** | Create GitHub Actions workflow |
197
118
 
198
- | Hook | Trigger | Purpose |
199
- |------|---------|---------|
200
- | `PostToolUse` | After any tool execution | Check if action unlocks achievement |
201
- | `Stop` | Session ends | Save session stats |
119
+ ---
120
+
121
+ ### 🔧 Power Tools
202
122
 
203
- ### How Commands Work
123
+ > *With great power comes great productivity*
204
124
 
205
- Slash commands (`/achievements`) are implemented as **markdown files** in `~/.claude/commands/`. Claude Code reads these and executes the embedded instructions.
125
+ | | Achievement | Quest |
126
+ |:--:|-------------|-------|
127
+ | 🎨 | **Visual Inspector** | Analyze an image or screenshot |
128
+ | 📡 | **Doc Hunter** | Fetch and analyze a web page |
129
+ | 🤖 | **Delegation Master** | Spawn a sub-agent with Task tool |
130
+ | 🔌 | **MCP Pioneer** | Use any MCP tool |
131
+ | 🌐 | **Web Explorer** | Search the web |
132
+ | ⚙️ | **Customizer** | Modify Claude Code settings |
133
+ | 📜 | **Skill Creator** | Create custom skill |
134
+ | ⌨️ | **Command Crafter** | Create custom slash command |
135
+ | 🧩 | **Plugin Explorer** | Install a marketplace plugin |
206
136
 
207
137
  ---
208
138
 
209
- ## Notifications
139
+ ### 👑 Mastery
210
140
 
211
- System notifications are auto-detected during installation:
141
+ > *The elite few who push the boundaries*
212
142
 
213
- | OS | Method | Sound |
214
- |----|--------|-------|
215
- | macOS | `osascript` | Glass |
216
- | Linux | `notify-send` | System default |
217
- | Windows | PowerShell | System default |
218
- | Fallback | Terminal | None |
143
+ | | Achievement | Quest |
144
+ |:--:|-------------|-------|
145
+ | 🪝 | **Automation Architect** | Set up Claude Code hooks |
146
+ | 🔗 | **MCP Connector** | Configure `.mcp.json` integration |
147
+ | 🤖 | **Agent Architect** | Create a custom agent |
148
+ | 🛡️ | **Security Guard** | Configure security permissions |
149
+ | 🔄 | **Loop Master** | Start autonomous coding loop |
219
150
 
220
- ### Install notify-send on Linux
151
+ ---
152
+
153
+ ## 🎮 Commands
221
154
 
222
155
  ```bash
223
- # Ubuntu/Debian
224
- sudo apt install libnotify-bin
156
+ /achievements # View your unlocked achievements
157
+ /achievements locked # See what's left to unlock (with hints!)
158
+ /achievements all # Full achievement list by category
159
+ /achievements-settings # Configure language & notifications
160
+ ```
225
161
 
226
- # Fedora
227
- sudo dnf install libnotify
162
+ ### Category Filters
228
163
 
229
- # Arch
230
- sudo pacman -S libnotify
164
+ ```bash
165
+ /achievements basics # 🌱 Getting Started
166
+ /achievements workflow # ⚡ Workflow
167
+ /achievements tools # 🔧 Power Tools
168
+ /achievements mastery # 👑 Mastery
231
169
  ```
232
170
 
233
171
  ---
234
172
 
235
- ## Configuration
173
+ ## 🔔 Notifications
236
174
 
237
- Settings are stored in `~/.claude/achievements/state.json`:
175
+ Achievement unlocked? You'll know instantly!
176
+
177
+ | Platform | Style |
178
+ |----------|-------|
179
+ | 🍎 macOS | Native notification with sound |
180
+ | 🐧 Linux | System notification |
181
+ | 🪟 Windows | Toast notification |
182
+ | 💻 Fallback | Terminal alert |
183
+
184
+ ---
238
185
 
239
- ```json
240
- {
241
- "settings": {
242
- "language": "en",
243
- "notifications": true,
244
- "notification_style": "system"
245
- },
246
- "achievements": {},
247
- "counters": {}
248
- }
186
+ ## 🛠️ How It Works
187
+
188
+ ```
189
+ You: "Edit the config file"
190
+ │
191
+ ▼
192
+ ┌─────────────────────┐
193
+ │ Claude uses Edit │
194
+ └─────────────────────┘
195
+ │
196
+ ▼
197
+ ┌─────────────────────┐
198
+ │ 🎯 Hook triggered │──▶ Achievement check
199
+ └─────────────────────┘
200
+ │
201
+ ┌──────┴──────┐
202
+ ▼ ▼
203
+ ┌───────┐ ┌────────┐
204
+ │ 🏆 +1 │ │ None │
205
+ │Unlock!│ │Continue│
206
+ └───────┘ └────────┘
249
207
  ```
250
208
 
251
- | Setting | Values | Description |
252
- |---------|--------|-------------|
253
- | `language` | `"en"`, `"zh"`, `"es"`, `"ko"`, `"ja"` | UI language |
254
- | `notifications` | `true`, `false` | Enable/disable alerts |
255
- | `notification_style` | `"system"`, `"terminal"`, `"both"` | Alert method |
209
+ The plugin hooks into Claude Code's event system. Every tool use is tracked. When you hit a milestone, you get rewarded!
256
210
 
257
211
  ---
258
212
 
259
- ## Troubleshooting
213
+ ## 🌍 Languages
260
214
 
261
- <details>
262
- <summary><b>Achievements not unlocking?</b></summary>
215
+ - 🇺🇸 English
216
+ - 🇨🇳 中文
217
+ - 🇪🇸 Español
218
+ - 🇰🇷 한국어
219
+ - 🇯🇵 日本語
263
220
 
264
- ```bash
265
- # Check plugin is installed
266
- ls ~/.claude/plugins/local/claude-code-achievements/
221
+ Change anytime with `/achievements-settings`
267
222
 
268
- # Check state file exists
269
- cat ~/.claude/achievements/state.json
223
+ ---
270
224
 
271
- # Verify hooks are loaded (restart Claude Code after install)
272
- ```
225
+ ## 📂 Your Progress
273
226
 
274
- </details>
227
+ All progress is saved locally:
275
228
 
276
- <details>
277
- <summary><b>Reset all progress</b></summary>
229
+ ```
230
+ ~/.claude/achievements/state.json
231
+ ```
278
232
 
233
+ Reset your journey anytime:
279
234
  ```bash
280
235
  rm ~/.claude/achievements/state.json
281
236
  ```
282
237
 
283
- </details>
238
+ ---
284
239
 
285
- <details>
286
- <summary><b>Reinstall plugin</b></summary>
240
+ ## 🤝 Contributing
287
241
 
288
- ```bash
289
- npx claude-code-achievements@latest
290
- ```
242
+ Got an idea for a new achievement? Found a bug? Contributions welcome!
291
243
 
292
- </details>
244
+ - 🏆 Suggest new achievements
245
+ - 🌍 Add translations
246
+ - 🐛 Report issues
247
+ - ⭐ Star this repo!
293
248
 
294
249
  ---
295
250
 
296
- ## Contributing
297
-
298
- Contributions welcome! Ideas:
251
+ <div align="center">
299
252
 
300
- - New achievements
301
- - New language translations
302
- - UI improvements
303
- - Bug fixes
253
+ ### Ready to start your journey?
304
254
 
305
- ## License
255
+ ```bash
256
+ npx claude-code-achievements
257
+ ```
306
258
 
307
- MIT © [subinium](https://github.com/subinium)
259
+ **Level up. Unlock achievements. Have fun coding!**
308
260
 
309
261
  ---
310
262
 
311
- <div align="center">
312
-
313
- **Happy coding!**
263
+ MIT © [subinium](https://github.com/subinium)
314
264
 
315
265
  </div>