gecs-component-designer

Design serialization-safe GECS components aligned with ECS framework standards.

581|39|Updated Oct 30, 2024
One-click install
npx skills add https://github.com/csprance/gecs --skill gecs-component-designer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gecs-component-designer
Source: https://github.com/csprance/gecs/tree/main/.claude/skills/gecs-component-designer
Command: npx skills add https://github.com/csprance/gecs --skill gecs-component-designer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation and design of GECS components, ensuring they are lean, well-typed, and compliant with framework contracts to facilitate reliable ECS development.

Core Features & Use Cases

  • Component Design Guidance: Provides structured best practices for building data-only resources in GECS, including property export, duplication, and serialization.
  • Framework Compliance: Ensures components adhere to GECS's rules around property_changed emissions, network sync tiers, and query filtering.
  • Use Case: Runtime developers can rapidly prototype new components that are safe for game state serialization and network synchronization without introducing logic or gameplay behavior.

Quick Start

Follow the guidance to create a new component resource, define properly typed exported fields, and incorporate best practices for observable and networked data consistent with GECS standards.

Frequently Asked Questions about gecs-component-designer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design GECS components that are safe for game state serialization?

Network sync tiers in GECS components determine how observable data replicates across clients during multiplayer sessions. Designing components with proper network sync tiers ensures query filtering and property_changed emissions align with framework contracts for consistent state synchronization.

What is the best way to structure data resources in GECS for ECS querying?

The best way to structure data resources in GECS for querying is building lean, well-typed component resources without embedded logic. This data-only structure allows the ECS framework to efficiently filter and query components during runtime.

How do I emit property_changed signals correctly when building GECS components?

You emit property_changed signals correctly by adhering to GECS framework compliance rules during component design. Structuring exported fields to trigger these emissions ensures observable data updates propagate properly for network synchronization and game state tracking.

Can I include gameplay logic inside GECS components intended for network synchronization?

You cannot include gameplay logic inside GECS components intended for network synchronization. Components must remain lean, data-only resources to ensure reliable serialization and framework compliance without introducing behavioral side effects during state replication.

Why does my GECS component fail serialization during runtime?

GECS component serialization fails during runtime when components contain unexported fields, embedded logic, or non-compliant data structures. Ensuring components are lean, well-typed resources with properly exported properties resolves these framework contract violations.