HeroScript API v1
Esta área documenta a API headless para clientes Unity, Godot, web, automação e
ferramentas de QA. O contrato de máquina está em /openapi/v1.json e em
openapi/heroscript-v1.json.
| Documento | Quando usar |
|---|---|
| Governança | Entender o que é estável, experimental ou administrativo. |
| Quickstart | Executar uma run determinística. |
| Contratos | Implementar comandos idempotentes e tratar erros. |
| Runs e combate | Recuperação, legalidade e replay. |
| Sessão interativa | Sincronização compacta, revisão consistente, ETag e recibo mínimo. |
| Diálogos | Conversas ramificadas em JSON, condições, custos e integração Godot. |
| Combat sandbox para Godot | Cenários, snapshots, timeline, branches e simulações. |
| Eventos | Paginação e SSE. |
| Conteúdo e plataforma | Revisões, administração e recursos futuros. |
| Packages e settings | Criar jogos/mods data-only e publicar revisões. |
| Progresso por setting | Configurar condições, origens e provas de desbloqueios. |
| Elegibilidade por run | Disponibilidade congelada, ofertas e retries de criação. |
| Fundamentos do mundo 1 | Owners de recursos, disponibilidade do perfil e certeza dos previews. |
| Atributos e regras globais | Armor, tiers críticos, overrides e projeções read-only do personagem. |
| Cartas e itens modificadores | Base/origem/impacto, explicações e aquisição/aplicação atômica. |
| Loadouts de inscrições | Inventário por personagem/run, preview versionado e equipamento atômico (experimental). |
| Composição do deck | Deck ativo, reserva, módulos e substituições atômicas por personagem. |
| Pagamentos com cartas | Escolha de instâncias, preview versionado e confirmação de custos. |
| Suporte | Equipamento, rotina e cadência publicados pela engine. |
| Recompensas exclusivas | Guardar na reserva ou decompilar sem duplicar concessões. |
| Compartimentos | Componentes herdados pelo container da carta, separados das zonas de combate. |
| Autenticação | Usar administração sem expor a chave. |
| Changelog | Mudanças publicadas no contrato. |
Os arquivos em examples/http/ são requests para extensões compatíveis com o
formato .http. Substitua IDs e a chave administrativa quando necessário.
Um cliente Godot reutilizável está em examples/godot-combat-client.