--- name: fumadocs-registry-integration description: Register 8-bit components in registry.json for shadcn/ui add command. Apply when adding new components to the component library distribution. --- ## Registry Integration Register 8-bit components in `registry.json` for discovery via `shadcn add @8bitcn/[component-name]`. ### Component Entry Pattern ```json { "name": "button", "type": "registry:component", "title": "8-bit Button", "description": "A simple 8-bit button component", "registryDependencies": ["button"], "files": [ { "path": "components/ui/8bit/button.tsx", "type": "registry:component", "target": "components/ui/8bit/button.tsx" }, { "path": "components/ui/8bit/styles/retro.css", "type": "registry:component", "target": "components/ui/8bit/styles/retro.css" } ] } ``` ### Block Entry Pattern For pre-built layouts like game UIs: ```json { "name": "quest-log", "type": "registry:block", "title": "8-bit Quest Log", "description": "An 8-bit quest and mission tracking system.", "registryDependencies": ["card", "accordion"], "categories": ["gaming"], "files": [ { "path": "components/ui/8bit/quest-log.tsx", "type": "registry:block", "target": "components/ui/8bit/quest-log.tsx" }, { "path": "components/ui/8bit/styles/retro.css", "type": "registry:component", "target": "components/ui/8bit/styles/retro.css" } ] } ``` ### Required retro.css Always include `retro.css` in files array: ```json "files": [ { "path": "components/ui/8bit/new-component.tsx", "type": "registry:component", "target": "components/ui/8bit/new-component.tsx" }, { "path": "components/ui/8bit/styles/retro.css", "type": "registry:component", "target": "components/ui/8bit/styles/retro.css" } ] ``` ### Categories Use gaming-specific categories for game components: ```json "categories": ["gaming"] ``` Available categories: `gaming`, `layout`, `form`, `data-display`, `feedback`, `navigation`, `overlay`. ### Registry Dependencies List base shadcn dependencies (not 8-bit versions): ```json "registryDependencies": ["button", "dialog", "progress"] ``` For blocks with multiple components: ```json "registryDependencies": ["card", "button", "progress", "tabs"] ``` ### Type Selection **registry:component** - Single reusable component: ```json { "type": "registry:component", "files": [...] } ``` **registry:block** - Pre-built layout or feature: ```json { "type": "registry:block", "categories": ["gaming"], "files": [...] } ``` ### Complete Example ```json { "name": "health-bar", "type": "registry:component", "title": "8-bit Health Bar", "description": "An 8-bit health bar component for game UI.", "registryDependencies": ["progress"], "files": [ { "path": "components/ui/8bit/health-bar.tsx", "type": "registry:component", "target": "components/ui/8bit/health-bar.tsx" }, { "path": "components/ui/8bit/progress.tsx", "type": "registry:component", "target": "components/ui/8bit/progress.tsx" }, { "path": "components/ui/8bit/styles/retro.css", "type": "registry:component", "target": "components/ui/8bit/styles/retro.css" } ] } ``` ### Key Principles 1. **Type** - Use `registry:component` for single, `registry:block` for layouts 2. **retro.css required** - Always include in files array 3. **Target path** - Same path for source and target 4. **Categories** - Use `gaming` for retro-themed blocks 5. **Dependencies** - List base shadcn/ui components (not 8-bit) 6. **Description** - Clear, concise for CLI output 7. **Files order** - Component first, retro.css last ### Adding a New Component 1. Create component in `components/ui/8bit/component.tsx` 2. Create documentation in `content/docs/components/component.mdx` 3. Add entry to `registry.json`: - Copy existing component as template - Update name, title, description - Set correct registryDependencies - Include retro.css in files 4. Test: `pnpm dlx shadcn@latest add @8bitcn/component` ### Reference - `registry.json` - Full component registry - `content/docs/components/*.mdx` - Component documentation --- Source attribution: TheOrcDev Original project: https://github.com/TheOrcDev/8bitcn-ui/blob/56066c038165223b8505a344309279ae27757a81/.claude/skills/fumadocs-registry-integration/SKILL.md License: MIT License information: https://opensource.org/license/mit Original upstream instructions; downloaded from Dave AI. ## Upstream license notice MIT License Copyright (c) 2025 8bitcn Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Dave AI resource metadata Creator / publisher: TheOrcDev Original project: https://github.com/TheOrcDev/8bitcn-ui/blob/56066c038165223b8505a344309279ae27757a81/.claude/skills/fumadocs-registry-integration/SKILL.md Attribution basis: Recovered original package and original project license at a pinned revision Fields of work: Design, Development & Engineering Roles: Frontend Developer, Game Developer, Product Designer Specialties: Backend, Frontend Tools: GitHub Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 8de028caac17930685e34e42f2edd831b5a733fb0c4c4b92c0c4a9f0dcbed6a6 Metadata reviewed: 2026-10-27 This metadata supersedes earlier Dave AI catalog attribution. Original instruction and supporting files are preserved.