fxgl-skills
v1.0.0
Published
Canonical FXGL coding skills for AI-assisted game development
Maintainers
Readme
FXGL Skills
fxgl-skills is a repository of reusable AI coding skills for FXGL.
The canonical source of truth is:
skills/*/SKILL.md— one skill per directory, written in Markdown with YAML front matterskills/index.json— machine-readable manifest for discovery and routingagents.md/AGENTS.md— repository-level instructions for coding agents
Goal
Make FXGL implementation guidance easy to consume by humans, GitHub Copilot, Claude Code, Cursor, and generic agent runtimes without locking the content into any single tool format.
Repository layout
| Path | Purpose |
|---|---|
| skills/*/SKILL.md | Canonical skill documents |
| skills/index.json | Tool-friendly skill inventory |
| docs/ | Domain and game-type analysis docs |
| agents.md | Main repository guidance for coding agents |
| AGENTS.md | Compatibility entry point for agent tools |
| .github/copilot-instructions.md | GitHub Copilot-specific adapter |
| CLAUDE.md | Claude Code-specific adapter |
| .cursor/rules/fxgl-skills.mdc | Cursor-specific adapter |
Canonical skill format
Every skill lives in skills/<skill-name>/SKILL.md and uses YAML front matter with these fields:
namedescriptiontriggerscompatibilitycategorytagsmetadataallowed-tools
This keeps the repository readable as plain Markdown while still being easy to index.
How tools should consume this repo
- Read
skills/index.jsonto discover candidate skills. - Select one or more relevant
skills/*/SKILL.mdfiles bycategory,tags, ortriggers. - Use those skills as implementation guidance.
- When API details matter, verify them against the adjacent FXGL source repository at
../core-lib.
Game-type skill groups
Game-type skills are grouped in two ways:
- human-facing lists in this README
- machine-readable groups in
skills/index.jsonunderskillGroups
2D game-type skills
fxgl-brawler, fxgl-breakout, fxgl-bullet-hell, fxgl-card-game, fxgl-endless-runner,
fxgl-fighting, fxgl-idle-clicker, fxgl-match3, fxgl-metroidvania, fxgl-pinball,
fxgl-platformer, fxgl-racing, fxgl-rhythm, fxgl-roguelike, fxgl-rpg, fxgl-shmup,
fxgl-snake, fxgl-stealth, fxgl-strategy-rts, fxgl-tactical-rpg, fxgl-topdown,
fxgl-tower-defense, fxgl-visual-novel
3D game-type skills
fxgl-fps-3d, fxgl-third-person-3d, fxgl-voxel
For generic 3D primitives, models, and camera setup, use fxgl-scene3d alongside the 3D
game-type skill.
Workflow skills
fxgl-project-starter
Use workflow skills to orchestrate discovery, documentation, scaffolding, and coordination across multiple FXGL subsystem skills.
Coverage notes
docs/uc-overview.mdis a catalog / index document, not a single skill target.docs/gt-tactical.mdis covered byfxgl-tactical-rpg.
Compatibility notes
- Baseline target: Java 17+
- FXGL baseline: 21.x
- The skill files are canonical; adapter files should point back to them rather than duplicating their content.
