registry-component-patterns

Original：🇺🇸 English

Translated

Register components in registry.json for shadcn/ui add command. Apply when adding new 8-bit components to the component library.

1installs

Sourcetheorcdev/8bitcn-ui

Added on2026-02-14

NPX Install

npx skill4agent add theorcdev/8bitcn-ui registry-component-patterns

SKILL.md Content

View Translation Comparison →

Registry Component Patterns

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": "chapter-intro",
  "type": "registry:block",
  "title": "8-bit Chapter Intro",
  "description": "A cinematic chapter/level intro with pixel art background.",
  "registryDependencies": ["card"],
  "categories": ["gaming"],
  "files": [
    {
      "path": "components/ui/8bit/blocks/chapter-intro.tsx",
      "type": "registry:block",
      "target": "components/ui/8bit/blocks/chapter-intro.tsx"
    },
    {
      "path": "components/ui/8bit/styles/retro.css",
      "type": "registry:component",
      "target": "components/ui/8bit/styles/retro.css"
    },
    {
      "path": "components/ui/8bit/card.tsx",
      "type": "registry:component",
      "target": "components/ui/8bit/card.tsx"
    }
  ]
}

Required retro.css

Always include

retro.css

in registry entries:

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"
  }
]

Registry Dependencies

List base shadcn dependencies:

json

"registryDependencies": ["button", "dialog"]

For blocks with multiple components:

json

"registryDependencies": ["card", "button", "progress"]

Key Principles

Type - Use
```
registry:component
```
for single components,
```
registry:block
```
for layouts
retro.css required - Always include in files array
Target path - Use same path for source and target
Categories - Use
```
gaming
```
for retro-themed components
Dependencies - List base shadcn/ui components (not 8-bit versions)
Description - Clear, concise description for CLI output

Adding a New Component

Create component in
```
components/ui/8bit/component.tsx
```
Update
```
registry.json
```
with entry (copy existing component as template)
Include
```
retro.css
```
dependency

Test with:

pnpm dlx shadcn@latest add @8bitcn/component

registry-component-patterns

NPX Install

Tags

SKILL.md Content

Registry Component Patterns

Component Entry Pattern

Block Entry Pattern

Required retro.css

Categories

Registry Dependencies

Key Principles

Adding a New Component