agentleFS
pixijspixijs/pixijs-skills/AGENTS.md

pixijs-skills

AGENTS.md372 starsChanged 7 months agoMITView on GitHub

This repository ships two skills for AI coding agents: pixijs for PixiJS v8 (pixi.js) and pixijs-3d for PixiJS 3D (@pixi/3d). Each is a single skill that routes to reference files. Each skill folder is synced from its library's repo on each release: A sync replaces only its own repo's skill folders. Make content changes upstream; a local edit is overwritten by the next sync. Edit this repo's README, plugin configs, examples and Copilot instructions directly. The skills CLI and plugin…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

6 rules. About 0 are common, 2 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    skills/pixijs/references/index.md: every topic file and sub-page with long-tail keywords (rare options, v7 names, error strings).

    line 19
  2. Very specific:

    Body: keep under ~500 lines; long material goes in references/.

    line 31
  3. Very specific:

    Add or edit references/<topic>.md (and sub-pages under references/<topic>/).

    line 37
  4. Very specific:

    Add a row to the matching router table in SKILL.md and an entry in references/index.md.

    line 38
  5. Very specific:

    If the topic owns a silent failure, add a one-line pitfall in SKILL.md linking to the section.

    line 39
  6. Distinctive:

    Write descriptions in third person ("Use when…", not "You can use when…").

    line 47

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Guidance for AI Agents Working in This Repo

This repository ships two skills for AI coding agents: pixijs for PixiJS v8 (pixi.js) and pixijs-3d for PixiJS 3D (@pixi/3d). Each is a single skill that routes to reference files.

Where the content comes from

Each skill folder is synced from its library's repo on each release:

  • skills/pixijs/ from pixijs/pixijs (commits titled chore: sync skills from pixijs/pixijs@<version>).
  • skills/pixijs-3d/ from pixijs/3d (commits titled chore: sync skills from pixijs/3d@<ref>).

A sync replaces only its own repo's skill folders. Make content changes upstream; a local edit is overwritten by the next sync. Edit this repo's README, plugin configs, examples and Copilot instructions directly.

Repo structure

  • skills/pixijs/SKILL.md: the entry point. Frontmatter, the "read before you write" workflow, silent-failure pitfalls, and the reference router table.
  • skills/pixijs/references/<topic>.md: one file per topic (application, assets, scene-sprite, filters, ...). Each row in the SKILL.md router links to one.
  • skills/pixijs/references/<topic>/<page>.md: sub-pages for rarer branches of a topic, linked from the topic file.
  • skills/pixijs/references/index.md: every topic file and sub-page with long-tail keywords (rare options, v7 names, error strings). Agents fall back to it when no router row matches.
  • skills/pixijs-3d/SKILL.md: the entry point. Frontmatter, the mental model, a complete starting app, conventions, silent-failure pitfalls, the table that points each job to a reference, and a Three.js name map.
  • skills/pixijs-3d/references/<job>.md: one runnable recipe per job (cameras, materials, post-processing, ...). references/from-threejs/ holds the name tables for porting a Three.js app.

The skills CLI and plugin manifests discover skills by scanning skills/ for directories that contain SKILL.md.

SKILL.md requirements

  • Frontmatter (YAML):
    • name (required): lowercase, hyphens only, max 64 chars, must match the parent directory name (skills/pixijs/ ↔ name: pixijs).
    • description (required): what the skill covers and when to use it, with trigger terms. Max 1024 chars.
    • license (optional): MIT.
  • Body: keep under ~500 lines; long material goes in references/.

Adding or changing a topic (upstream)

In pixijs, in pixijs/pixijs:

  1. Add or edit references/<topic>.md (and sub-pages under references/<topic>/).
  2. Add a row to the matching router table in SKILL.md and an entry in references/index.md.
  3. If the topic owns a silent failure, add a one-line pitfall in SKILL.md linking to the section.

In pixijs-3d, follow docs/skills.md in pixijs/3d.

New pixi.js topics go in pixijs and new @pixi/3d topics in pixijs-3d. Don't add skill directories here.

Conventions

  • Write descriptions in third person ("Use when…", not "You can use when…").
  • Be concise; don't restate the PixiJS docs. Focus on correct v8 API usage and pitfalls.
  • Link to anchors (references/events.md#drag) so the pitfall points at the rule that owns it.

References

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.