Skip to content

Commit 096ce29

Browse files
fix(plugin): restructure to .claude-plugin for Claude Code compatibility (#600)
- Rename claude-plugin/ to .claude-plugin/ (required by Claude Code) - Rename claude.json to plugin.json (expected filename) - Fix plugin.json schema (author as object, skills as directory paths) - Update all references in READMEs and CI workflow Claude Code expects .claude-plugin/plugin.json at repo root for marketplace-based plugins. Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
1 parent 732d16c commit 096ce29

File tree

13 files changed

+40
-45
lines changed

13 files changed

+40
-45
lines changed
File renamed without changes.
Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,17 @@
22

33
AI-powered development guide for JEngine Unity framework.
44

5-
## Installation (Recommended: Marketplace)
6-
7-
Add the JEngine marketplace for **automatic updates**:
5+
## Installation
86

97
```bash
10-
# Add marketplace (one-time)
11-
claude plugin marketplace add https://github.com/JasonXuDeveloper/JEngine/tree/master/claude-plugin/marketplace.json
8+
# Add JEngine marketplace (one-time, enables auto-updates)
9+
claude plugin marketplace add JasonXuDeveloper/JEngine
1210

1311
# Install plugin
1412
claude plugin install jengine@jengine-marketplace
1513
```
1614

17-
After this, plugin updates automatically when Claude Code starts.
18-
19-
## Alternative: Direct Install
20-
21-
```bash
22-
claude plugin install https://github.com/JasonXuDeveloper/JEngine/tree/master/claude-plugin
23-
```
24-
25-
(Note: Direct installs require manual updates)
15+
Plugin updates automatically when Claude Code starts.
2616

2717
## Features
2818

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
"plugins": [
99
{
1010
"name": "jengine",
11-
"description": "AI development guide for JEngine Unity hot-update framework",
11+
"description": "AI guide for game development with JEngine Unity hot-update framework",
1212
"source": {
1313
"source": "github",
1414
"repo": "JasonXuDeveloper/JEngine",
15-
"path": "claude-plugin",
15+
"path": ".claude-plugin",
1616
"ref": "master"
1717
}
1818
}

.claude-plugin/plugin.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "jengine",
3+
"description": "AI guide for game development with JEngine Unity hot-update framework",
4+
"version": "1.0.1",
5+
"author": {
6+
"name": "JasonXuDeveloper"
7+
},
8+
"license": "MIT",
9+
"repository": "https://github.com/JasonXuDeveloper/JEngine",
10+
"keywords": ["unity", "hot-update", "hybridclr", "async", "unitask", "object-pool", "chainable-tasks", "editor-ui", "modal-dialog", "gc-optimization"],
11+
"skills": [
12+
"./skills/jaction",
13+
"./skills/jobjectpool",
14+
"./skills/messagebox",
15+
"./skills/editor-ui"
16+
]
17+
}
File renamed without changes.
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Plugin Maintenance
22

3-
The `claude-plugin/` folder contains AI agent documentation for end users who install JEngine packages.
3+
The `.claude-plugin/` folder contains AI agent documentation for end users who install JEngine packages.
44

55
## When to Update
66

@@ -14,25 +14,25 @@ Update the plugin documentation when:
1414

1515
| Package Change | Plugin File to Update |
1616
|---------------|----------------------|
17-
| JAction API | `claude-plugin/skills/jaction/SKILL.md` |
18-
| JObjectPool API | `claude-plugin/skills/jobjectpool/SKILL.md` |
19-
| MessageBox API | `claude-plugin/skills/messagebox/SKILL.md` |
20-
| Editor UI components | `claude-plugin/skills/editor-ui/SKILL.md` |
21-
| Design Tokens | `claude-plugin/skills/editor-ui/SKILL.md` |
22-
| New utility class | Create new skill in `claude-plugin/skills/` |
23-
| General patterns | `claude-plugin/CLAUDE.md` |
17+
| JAction API | `.claude-plugin/skills/jaction/SKILL.md` |
18+
| JObjectPool API | `.claude-plugin/skills/jobjectpool/SKILL.md` |
19+
| MessageBox API | `.claude-plugin/skills/messagebox/SKILL.md` |
20+
| Editor UI components | `.claude-plugin/skills/editor-ui/SKILL.md` |
21+
| Design Tokens | `.claude-plugin/skills/editor-ui/SKILL.md` |
22+
| New utility class | Create new skill in `.claude-plugin/skills/` |
23+
| General patterns | `.claude-plugin/CLAUDE.md` |
2424

2525
## Checklist for API Changes
2626

2727
- [ ] Update relevant SKILL.md with new/changed API
2828
- [ ] Add code examples for new features
2929
- [ ] Document common mistakes if any
30-
- [ ] Bump version in `claude-plugin/claude.json` (CI does this automatically on release)
30+
- [ ] Bump version in `.claude-plugin/plugin.json` (CI does this automatically on release)
3131

3232
## Version Sync
3333

3434
Plugin version is automatically bumped by CI when packages are released.
35-
For manual updates, bump the version in `claude-plugin/claude.json`:
35+
For manual updates, bump the version in `.claude-plugin/plugin.json`:
3636
- Patch (x.x.1) for doc fixes
3737
- Minor (x.1.0) for new API coverage
3838
- Major (1.0.0) for breaking skill changes

.github/workflows/release-plugin.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Release Plugin
33
on:
44
push:
55
paths:
6-
- 'claude-plugin/**'
6+
- '.claude-plugin/**'
77
branches:
88
- master
99
workflow_dispatch:
@@ -44,7 +44,7 @@ jobs:
4444
id: bump
4545
run: |
4646
BUMP_TYPE="${{ github.event.inputs.bump_type || 'patch' }}"
47-
CURRENT=$(jq -r '.version' claude-plugin/claude.json)
47+
CURRENT=$(jq -r '.version' .claude-plugin/plugin.json)
4848
4949
IFS='.' read -r major minor patch <<< "$CURRENT"
5050
case $BUMP_TYPE in
@@ -53,8 +53,8 @@ jobs:
5353
patch) NEW_VERSION="$major.$minor.$((patch+1))" ;;
5454
esac
5555
56-
jq --arg v "$NEW_VERSION" '.version = $v' claude-plugin/claude.json > tmp.json
57-
mv tmp.json claude-plugin/claude.json
56+
jq --arg v "$NEW_VERSION" '.version = $v' .claude-plugin/plugin.json > tmp.json
57+
mv tmp.json .claude-plugin/plugin.json
5858
5959
echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
6060
echo "Bumped plugin version from $CURRENT to $NEW_VERSION"
@@ -68,7 +68,7 @@ jobs:
6868
git config user.name "jengine-release-bot[bot]"
6969
git config user.email "257041894+jengine-release-bot[bot]@users.noreply.github.com"
7070
71-
git add claude-plugin/claude.json
71+
git add .claude-plugin/plugin.json
7272
7373
git commit -m "chore(plugin): bump version to ${{ steps.bump.outputs.version }}"
7474

0 commit comments

Comments
 (0)