curiosity-ai-bv/babylonjs-skill

Babylon.js AI Coding Skill

A curated AI skill for Babylon.js 8 — giving your AI coding assistant deep expertise in 3D web development.

---

What is this?

This is a skill (also called a knowledge pack) designed for AI coding assistants. It gives your AI agent structured, production-grade knowledge about Babylon.js 8 — the powerful open-source 3D engine for the web.

Instead of relying on an AI’s general training data (which can be outdated or hallucinated), this skill provides curated, accurate API patterns and code examples that the AI reads on-demand whenever you’re working on a Babylon.js project.

Why use a skill?

---

📦 What’s Included

The skill is organized into a main reference file (SKILL.md) and six deep-dive reference documents:

Coverage Highlights

• Scene setup — WebGL2 and WebGPU engine initialization
• Mesh creation — All built-in builders, parametric shapes, and custom vertex data
• PBR Materials — Metallic-roughness & specular-glossiness workflows, sub-features (clear coat, sub-surface, sheen, anisotropy)
• Cameras — ArcRotateCamera, UniversalCamera, FollowCamera with limits and behaviors
• Lighting & Shadows — Hemispheric, point, directional, spot lights with shadow generators
• 2D/3D GUI — Full AdvancedDynamicTexture control reference with layout system
• Animation — Keyframe animation, animation groups, easing functions, skeletal animation from glTF
• Asset Loading — Modern async API for glTF, OBJ, STL, Gaussian Splatting
• Performance — Instancing strategy decision matrix, scene performance priority modes, memory management
• On-demand docs — URL map for topics not in the reference files (physics, WebXR, post-processing, etc.)

---

🚀 Installation

Antigravity / Gemini CLI

Place the BabylonJS folder in your skills directory:

~/.gemini/antigravity/skills/babylonjs/
├── SKILL.md
└── references/
    ├── core-concepts.md
    ├── meshes.md
    ├── materials.md
    ├── gui.md
    ├── animation-loading.md
    ├── performance.md
    └── doc-urls.md

The AI will automatically pick up the skill when you work on Babylon.js-related code.

Other AI Coding Assistants

The .skill bundle file (babylonjs.skill) is also included for tools that support the packaged skill format. Refer to your AI tool’s documentation for installation instructions.

Manual / Generic Setup

If your AI tool supports custom instructions or knowledge files, you can point it to the SKILL.md file and the references/ directory. The SKILL.md file is self-contained with instructions on how to use the reference files.

---

💡 Usage Examples

Once installed, simply ask your AI assistant to help with Babylon.js tasks. The skill kicks in automatically:

"Create a 3D scene with a PBR gold sphere on a ground plane"
"Add shadow casting from a directional light"
"Render 10,000 instances of a box using thin instances"
"Set up a glTF model loader with progress tracking"
"Build a GUI overlay with sliders to control material properties"
"Optimize my scene for better frame rates"

The AI will pull from the skill’s curated reference files to generate correct, production-ready code.

---

🧠 How It Works

You ask a Babylon.js question
        │
        ▼
AI detects Babylon.js context
        │
        ▼
SKILL.md is loaded (quick reference + gotchas)
        │
        ▼
Relevant reference file(s) are consulted
        │
        ▼
If topic isn't in references → doc-urls.md provides
the URL to fetch live documentation on-demand
        │
        ▼
AI generates correct, tree-shakeable,
production-ready Babylon.js 8 code

---

📚 Topics Not in Reference Files

The following topics are available via on-demand documentation fetching (URLs in doc-urls.md):

• Physics V2 (Havok)
• WebXR / VR / AR
• Post-processing pipelines
• Solid Particle System
• Crowd Navigation
• Node Geometry (procedural)
• Frame Graph
• Flow Graph
• Smart Filters
• Gaussian Splatting

---

🤝 Contributing

Contributions are welcome! If you find outdated patterns, missing APIs, or have suggestions for additional reference material:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/add-physics-reference)
3. Add or update reference files in BabylonJS/references/
4. Submit a pull request

Guidelines

• Keep code examples concise and production-ready
• Always include proper tree-shaking imports
• Document gotchas and common pitfalls
• Target Babylon.js 8.x APIs

---

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Made by adspiceprospice — Curiosity Ai B.V.