diff --git a/claude-plugin/CLAUDE.md b/.claude-plugin/CLAUDE.md similarity index 100% rename from claude-plugin/CLAUDE.md rename to .claude-plugin/CLAUDE.md diff --git a/claude-plugin/README.md b/.claude-plugin/README.md similarity index 66% rename from claude-plugin/README.md rename to .claude-plugin/README.md index c24851cd..7184b91b 100644 --- a/claude-plugin/README.md +++ b/.claude-plugin/README.md @@ -2,27 +2,17 @@ AI-powered development guide for JEngine Unity framework. -## Installation (Recommended: Marketplace) - -Add the JEngine marketplace for **automatic updates**: +## Installation ```bash -# Add marketplace (one-time) -claude plugin marketplace add https://github.com/JasonXuDeveloper/JEngine/tree/master/claude-plugin/marketplace.json +# Add JEngine marketplace (one-time, enables auto-updates) +claude plugin marketplace add JasonXuDeveloper/JEngine # Install plugin claude plugin install jengine@jengine-marketplace ``` -After this, plugin updates automatically when Claude Code starts. - -## Alternative: Direct Install - -```bash -claude plugin install https://github.com/JasonXuDeveloper/JEngine/tree/master/claude-plugin -``` - -(Note: Direct installs require manual updates) +Plugin updates automatically when Claude Code starts. ## Features diff --git a/claude-plugin/marketplace.json b/.claude-plugin/marketplace.json similarity index 75% rename from claude-plugin/marketplace.json rename to .claude-plugin/marketplace.json index 2782dfda..7152454e 100644 --- a/claude-plugin/marketplace.json +++ b/.claude-plugin/marketplace.json @@ -8,11 +8,11 @@ "plugins": [ { "name": "jengine", - "description": "AI development guide for JEngine Unity hot-update framework", + "description": "AI guide for game development with JEngine Unity hot-update framework", "source": { "source": "github", "repo": "JasonXuDeveloper/JEngine", - "path": "claude-plugin", + "path": ".claude-plugin", "ref": "master" } } diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 00000000..0ba460ac --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,17 @@ +{ + "name": "jengine", + "description": "AI guide for game development with JEngine Unity hot-update framework", + "version": "1.0.1", + "author": { + "name": "JasonXuDeveloper" + }, + "license": "MIT", + "repository": "https://github.com/JasonXuDeveloper/JEngine", + "keywords": ["unity", "hot-update", "hybridclr", "async", "unitask", "object-pool", "chainable-tasks", "editor-ui", "modal-dialog", "gc-optimization"], + "skills": [ + "./skills/jaction", + "./skills/jobjectpool", + "./skills/messagebox", + "./skills/editor-ui" + ] +} diff --git a/claude-plugin/skills/editor-ui/SKILL.md b/.claude-plugin/skills/editor-ui/SKILL.md similarity index 100% rename from claude-plugin/skills/editor-ui/SKILL.md rename to .claude-plugin/skills/editor-ui/SKILL.md diff --git a/claude-plugin/skills/jaction/SKILL.md b/.claude-plugin/skills/jaction/SKILL.md similarity index 100% rename from claude-plugin/skills/jaction/SKILL.md rename to .claude-plugin/skills/jaction/SKILL.md diff --git a/claude-plugin/skills/jobjectpool/SKILL.md b/.claude-plugin/skills/jobjectpool/SKILL.md similarity index 100% rename from claude-plugin/skills/jobjectpool/SKILL.md rename to .claude-plugin/skills/jobjectpool/SKILL.md diff --git a/claude-plugin/skills/messagebox/SKILL.md b/.claude-plugin/skills/messagebox/SKILL.md similarity index 100% rename from claude-plugin/skills/messagebox/SKILL.md rename to .claude-plugin/skills/messagebox/SKILL.md diff --git a/.claude/rules/plugin-maintenance.md b/.claude/rules/plugin-maintenance.md index 86c40dd9..f1154f8f 100644 --- a/.claude/rules/plugin-maintenance.md +++ b/.claude/rules/plugin-maintenance.md @@ -1,6 +1,6 @@ # Plugin Maintenance -The `claude-plugin/` folder contains AI agent documentation for end users who install JEngine packages. +The `.claude-plugin/` folder contains AI agent documentation for end users who install JEngine packages. ## When to Update @@ -14,25 +14,25 @@ Update the plugin documentation when: | Package Change | Plugin File to Update | |---------------|----------------------| -| JAction API | `claude-plugin/skills/jaction/SKILL.md` | -| JObjectPool API | `claude-plugin/skills/jobjectpool/SKILL.md` | -| MessageBox API | `claude-plugin/skills/messagebox/SKILL.md` | -| Editor UI components | `claude-plugin/skills/editor-ui/SKILL.md` | -| Design Tokens | `claude-plugin/skills/editor-ui/SKILL.md` | -| New utility class | Create new skill in `claude-plugin/skills/` | -| General patterns | `claude-plugin/CLAUDE.md` | +| JAction API | `.claude-plugin/skills/jaction/SKILL.md` | +| JObjectPool API | `.claude-plugin/skills/jobjectpool/SKILL.md` | +| MessageBox API | `.claude-plugin/skills/messagebox/SKILL.md` | +| Editor UI components | `.claude-plugin/skills/editor-ui/SKILL.md` | +| Design Tokens | `.claude-plugin/skills/editor-ui/SKILL.md` | +| New utility class | Create new skill in `.claude-plugin/skills/` | +| General patterns | `.claude-plugin/CLAUDE.md` | ## Checklist for API Changes - [ ] Update relevant SKILL.md with new/changed API - [ ] Add code examples for new features - [ ] Document common mistakes if any -- [ ] Bump version in `claude-plugin/claude.json` (CI does this automatically on release) +- [ ] Bump version in `.claude-plugin/plugin.json` (CI does this automatically on release) ## Version Sync Plugin version is automatically bumped by CI when packages are released. -For manual updates, bump the version in `claude-plugin/claude.json`: +For manual updates, bump the version in `.claude-plugin/plugin.json`: - Patch (x.x.1) for doc fixes - Minor (x.1.0) for new API coverage - Major (1.0.0) for breaking skill changes diff --git a/.github/workflows/release-plugin.yml b/.github/workflows/release-plugin.yml index 53fc9708..0885dbd8 100644 --- a/.github/workflows/release-plugin.yml +++ b/.github/workflows/release-plugin.yml @@ -3,7 +3,7 @@ name: Release Plugin on: push: paths: - - 'claude-plugin/**' + - '.claude-plugin/**' branches: - master workflow_dispatch: @@ -44,7 +44,7 @@ jobs: id: bump run: | BUMP_TYPE="${{ github.event.inputs.bump_type || 'patch' }}" - CURRENT=$(jq -r '.version' claude-plugin/claude.json) + CURRENT=$(jq -r '.version' .claude-plugin/plugin.json) IFS='.' read -r major minor patch <<< "$CURRENT" case $BUMP_TYPE in @@ -53,8 +53,8 @@ jobs: patch) NEW_VERSION="$major.$minor.$((patch+1))" ;; esac - jq --arg v "$NEW_VERSION" '.version = $v' claude-plugin/claude.json > tmp.json - mv tmp.json claude-plugin/claude.json + jq --arg v "$NEW_VERSION" '.version = $v' .claude-plugin/plugin.json > tmp.json + mv tmp.json .claude-plugin/plugin.json echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT echo "Bumped plugin version from $CURRENT to $NEW_VERSION" @@ -68,7 +68,7 @@ jobs: git config user.name "jengine-release-bot[bot]" git config user.email "257041894+jengine-release-bot[bot]@users.noreply.github.com" - git add claude-plugin/claude.json + git add .claude-plugin/plugin.json git commit -m "chore(plugin): bump version to ${{ steps.bump.outputs.version }}" diff --git a/README.md b/README.md index 9a14fa84..61080aa8 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ - **Zero/Minimal GC** - UniTask (GC-free async) + Nino (high-performance serialization) - **All Platforms** - iOS, Android, Windows, macOS, WebGL, WeChat, Douyin, Alipay, TapTap - **Secure Updates** - Obfuscate hot update DLL + encrypt resources (assets & DLL/PDB) with XOR/AES/ChaCha20 -- **AI-Accelerated** - Intelligent AI [seamlessly integrated](claude-plugin/), deeply understands JEngine to boost productivity +- **AI-Accelerated** - Intelligent AI [seamlessly integrated](.claude-plugin/), deeply understands JEngine to boost productivity - **Commercial Ready** - Production-proven by individuals and enterprise teams ## Overview diff --git a/README_zh_cn.md b/README_zh_cn.md index a7746dc1..56e43c33 100644 --- a/README_zh_cn.md +++ b/README_zh_cn.md @@ -18,7 +18,7 @@ - **零/极低GC** - UniTask（无GC异步）+ Nino（高性能序列化） - **全平台支持** - iOS、Android、Windows、macOS、WebGL、微信、抖音、支付宝、TapTap - **安全更新** - 热更DLL混淆 + 资源（资产和DLL/PDB）支持XOR/AES/ChaCha20加密 -- **AI赋能** - AI[深度理解JEngine](claude-plugin/)，无缝融入开发流程，效率倍增 +- **AI赋能** - AI[深度理解JEngine](.claude-plugin/)，无缝融入开发流程，效率倍增 - **商用验证** - 经个人和企业团队生产环境验证 ## 概述 diff --git a/claude-plugin/claude.json b/claude-plugin/claude.json deleted file mode 100644 index 0fa3e3e8..00000000 --- a/claude-plugin/claude.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "name": "jengine", - "displayName": "JEngine Framework", - "version": "1.0.1", - "description": "AI development guide for JEngine Unity hot-update framework", - "author": "JasonXuDeveloper", - "repository": "https://github.com/JasonXuDeveloper/JEngine", - "skills": [ - "skills/*/SKILL.md" - ], - "claudeMd": "CLAUDE.md" -}