npm.io
0.1.0-alpha.3 • Published 15h ago

@three-flatland/skills

Licence
MIT
Version
0.1.0-alpha.3
Deps
0
Size
89 kB
Vulns
0
Weekly
0
Stars
28

three-flatland

@three-flatland/skills

Claude Code skills for the three-flatland ecosystem. TSL shaders, WebGPU, and related domain knowledge packaged for agent use.

Alpha Release — this package is in active development. Skills will evolve alongside the libraries they document. Pin your version and check the changelog before upgrading.

npm license

Install

npx skills add thejustinwalsh/three-flatland

Install a single skill:

npx skills add thejustinwalsh/three-flatland/skills/tsl
Via npm
npm install --save-dev @three-flatland/skills
cp -r node_modules/@three-flatland/skills/* .claude/skills/

Included skills

  • tsl — Use when writing TSL shaders, creating NodeMaterials, migrating GLSL to TSL, using compute shaders, working with three/tsl imports, or debugging shader node graphs.
  • codemod — Use when authoring or applying three-flatland breaking-change codemods.
  • flatland-r3f — Use when integrating three-flatland with React Three Fiber: extend() registration, declarative JSX sprites, Flatland routing, post-processing, anti-patterns.
  • flatland-bake — Use when baking derived assets (alpha hitmasks, normal maps, Slug fonts) or deciding whether to bake at all: flatland-bake subcommands, direct bins, and the baked → runtime fallback contract.
Requirements

Authoring a new skill

  1. Add a top-level directory under skills/ named after the skill (kebab-case).
  2. Create skills/<name>/SKILL.md with YAML frontmatter:
    ---
    name: <name>
    description: Use when <trigger conditions>
    ---
  3. Add supplemental reference files alongside SKILL.md as needed.
  4. Per-skill helper scripts go in skills/<name>/scripts/ and are invoked by the agent from the user's project root so node_modules resolution works.
  5. Validate locally:
    pnpm --filter @three-flatland/skills validate
  6. Open a PR with a changeset (pnpm changeset).

Validation combines skills-ref (base frontmatter) with a local check enforcing the "Use when…" description convention.

Documentation

Full docs at tjw.dev/three-flatland

License

MIT

Keywords