@opengamehq/skills 1.4.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (383) hide show
  1. package/CHANGELOG.md +36 -0
  2. package/README.md +12 -4
  3. package/dist/.claude-plugin/marketplace.json +26 -0
  4. package/dist/skills/manifest.json +1407 -143
  5. package/dist/skills/opengame-accessibility/CHANGELOG.md +4 -0
  6. package/dist/skills/opengame-accessibility/SKILL.md +48 -32
  7. package/dist/skills/opengame-all-in-one/CHANGELOG.md +25 -0
  8. package/dist/skills/opengame-all-in-one/SKILL.md +195 -0
  9. package/dist/skills/opengame-all-in-one/references/opengame-accessibility/README.md +102 -0
  10. package/dist/skills/opengame-all-in-one/references/opengame-api/README.md +108 -0
  11. package/dist/skills/opengame-all-in-one/references/opengame-assets/README.md +168 -0
  12. package/dist/skills/opengame-all-in-one/references/opengame-assets/references/pipeline.md +164 -0
  13. package/dist/skills/opengame-all-in-one/references/opengame-audio/README.md +238 -0
  14. package/dist/skills/opengame-all-in-one/references/opengame-audio/helpers/audio-chain.js +325 -0
  15. package/dist/skills/opengame-all-in-one/references/opengame-audio/references/mix-notes.md +125 -0
  16. package/dist/skills/opengame-all-in-one/references/opengame-audio/references/qa-without-ears.md +177 -0
  17. package/dist/skills/opengame-all-in-one/references/opengame-capture/README.md +128 -0
  18. package/dist/skills/opengame-all-in-one/references/opengame-capture/references/pipeline.md +114 -0
  19. package/dist/skills/opengame-all-in-one/references/opengame-capture/references/threejs.md +161 -0
  20. package/dist/skills/opengame-all-in-one/references/opengame-characters/README.md +180 -0
  21. package/dist/skills/opengame-all-in-one/references/opengame-characters/references/first-person-body.md +108 -0
  22. package/dist/skills/opengame-all-in-one/references/opengame-characters/references/integration.md +144 -0
  23. package/dist/skills/opengame-all-in-one/references/opengame-characters/references/player-og.md +160 -0
  24. package/dist/skills/opengame-all-in-one/references/opengame-cli/README.md +190 -0
  25. package/dist/skills/opengame-all-in-one/references/opengame-deploy/README.md +229 -0
  26. package/dist/skills/opengame-all-in-one/references/opengame-deploy/references/json-events.md +63 -0
  27. package/dist/skills/opengame-all-in-one/references/opengame-deploy/references/manifest.md +90 -0
  28. package/dist/skills/opengame-all-in-one/references/opengame-deploy/references/packaging.md +120 -0
  29. package/dist/skills/opengame-all-in-one/references/opengame-depth/README.md +154 -0
  30. package/dist/skills/opengame-all-in-one/references/opengame-enemies/README.md +155 -0
  31. package/dist/skills/opengame-all-in-one/references/opengame-enemies/references/pacing-and-bots.md +108 -0
  32. package/dist/skills/opengame-all-in-one/references/opengame-enemies/references/threejs.md +193 -0
  33. package/dist/skills/opengame-all-in-one/references/opengame-front-end/README.md +185 -0
  34. package/dist/skills/opengame-all-in-one/references/opengame-front-end/references/launch.md +50 -0
  35. package/dist/skills/opengame-all-in-one/references/opengame-front-end/references/menus.md +81 -0
  36. package/dist/skills/opengame-all-in-one/references/opengame-game-feel/README.md +181 -0
  37. package/dist/skills/opengame-all-in-one/references/opengame-game-feel/helpers/spring.js +146 -0
  38. package/dist/skills/opengame-all-in-one/references/opengame-game-feel/references/feel-numbers.md +142 -0
  39. package/dist/skills/opengame-all-in-one/references/opengame-game-feel/references/killcam.md +88 -0
  40. package/dist/skills/opengame-all-in-one/references/opengame-jam/README.md +121 -0
  41. package/dist/skills/opengame-all-in-one/references/opengame-lighting/README.md +141 -0
  42. package/dist/skills/opengame-all-in-one/references/opengame-lighting/helpers/light-pool.js +185 -0
  43. package/dist/skills/opengame-all-in-one/references/opengame-loading/README.md +135 -0
  44. package/dist/skills/opengame-all-in-one/references/opengame-loading/helpers/loading-count.mjs +115 -0
  45. package/dist/skills/opengame-all-in-one/references/opengame-loading/references/threejs.md +141 -0
  46. package/dist/skills/opengame-all-in-one/references/opengame-look/README.md +181 -0
  47. package/dist/skills/opengame-all-in-one/references/opengame-look/references/matching-a-reference.md +73 -0
  48. package/dist/skills/opengame-all-in-one/references/opengame-look/references/painterly.md +69 -0
  49. package/dist/skills/opengame-all-in-one/references/opengame-look/references/post-and-lens.md +73 -0
  50. package/dist/skills/opengame-all-in-one/references/opengame-maps/README.md +74 -0
  51. package/dist/skills/opengame-all-in-one/references/opengame-maps/references/map-spec.md +77 -0
  52. package/dist/skills/opengame-all-in-one/references/opengame-mobile/README.md +86 -0
  53. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/README.md +183 -0
  54. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/briefs.md +293 -0
  55. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/day-one-questions.md +46 -0
  56. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/edge-cases.md +27 -0
  57. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/filmable.md +244 -0
  58. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/finishing.md +126 -0
  59. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/measure.md +282 -0
  60. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/montage-capture.md +151 -0
  61. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/montage-gates.md +84 -0
  62. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/montage-genres.md +198 -0
  63. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/montage-grammar.md +320 -0
  64. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/montage-ops.md +127 -0
  65. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/og-snipers-record.md +110 -0
  66. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/owner-eye.md +214 -0
  67. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/reference-study.md +293 -0
  68. package/dist/skills/opengame-all-in-one/references/opengame-montage-make/references/song.md +64 -0
  69. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/README.md +193 -0
  70. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/briefs.md +293 -0
  71. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/day-one-questions.md +46 -0
  72. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/filmable.md +244 -0
  73. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/measure.md +282 -0
  74. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/montage-capture.md +151 -0
  75. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/montage-gates.md +84 -0
  76. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/montage-genres.md +198 -0
  77. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/montage-grammar.md +320 -0
  78. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/montage-ops.md +127 -0
  79. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/og-snipers-record.md +110 -0
  80. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/owner-eye.md +214 -0
  81. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/reference-study.md +293 -0
  82. package/dist/skills/opengame-all-in-one/references/opengame-montage-plan/references/song.md +64 -0
  83. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/README.md +174 -0
  84. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/briefs.md +293 -0
  85. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/day-one-questions.md +46 -0
  86. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/filmable.md +244 -0
  87. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/finishing.md +126 -0
  88. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/measure.md +282 -0
  89. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/montage-capture.md +151 -0
  90. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/montage-gates.md +84 -0
  91. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/montage-genres.md +198 -0
  92. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/montage-grammar.md +320 -0
  93. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/montage-ops.md +127 -0
  94. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/og-snipers-record.md +110 -0
  95. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/owner-eye.md +214 -0
  96. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/reference-study.md +293 -0
  97. package/dist/skills/opengame-all-in-one/references/opengame-montage-review-and-improve/references/song.md +64 -0
  98. package/dist/skills/opengame-all-in-one/references/opengame-multiplayer/README.md +139 -0
  99. package/dist/skills/opengame-all-in-one/references/opengame-multiplayer/references/bot-lobbies.md +71 -0
  100. package/dist/skills/opengame-all-in-one/references/opengame-multiplayer/references/netcode.md +165 -0
  101. package/dist/skills/opengame-all-in-one/references/opengame-performance/README.md +177 -0
  102. package/dist/skills/opengame-all-in-one/references/opengame-performance/helpers/landing-pacer.mjs +86 -0
  103. package/dist/skills/opengame-all-in-one/references/opengame-performance/references/measuring.md +123 -0
  104. package/dist/skills/opengame-all-in-one/references/opengame-performance/references/webgpu.md +86 -0
  105. package/dist/skills/opengame-all-in-one/references/opengame-production/README.md +192 -0
  106. package/dist/skills/opengame-all-in-one/references/opengame-production/references/team.md +107 -0
  107. package/dist/skills/opengame-all-in-one/references/opengame-production/references/templates.md +153 -0
  108. package/dist/skills/opengame-all-in-one/references/opengame-quality-bar/README.md +170 -0
  109. package/dist/skills/opengame-all-in-one/references/opengame-quality-bar/references/cheap-tells.md +43 -0
  110. package/dist/skills/opengame-all-in-one/references/opengame-quality-bar/references/judges.md +95 -0
  111. package/dist/skills/opengame-all-in-one/references/opengame-quality-bar/references/review-prompt.md +32 -0
  112. package/dist/skills/opengame-all-in-one/references/opengame-rhythm/README.md +134 -0
  113. package/dist/skills/opengame-all-in-one/references/opengame-rhythm/references/charting.md +109 -0
  114. package/dist/skills/opengame-all-in-one/references/opengame-rhythm/references/timing.md +92 -0
  115. package/dist/skills/opengame-all-in-one/references/opengame-router/README.md +54 -0
  116. package/dist/skills/opengame-all-in-one/references/opengame-router/references/process.md +38 -0
  117. package/dist/skills/opengame-all-in-one/references/opengame-scene-audit/README.md +136 -0
  118. package/dist/skills/opengame-all-in-one/references/opengame-scene-audit/helpers/scene-audit.js +677 -0
  119. package/dist/skills/opengame-all-in-one/references/opengame-sdk/README.md +283 -0
  120. package/dist/skills/opengame-all-in-one/references/opengame-sdk/references/engines.md +93 -0
  121. package/dist/skills/opengame-all-in-one/references/opengame-sdk/references/frame.md +107 -0
  122. package/dist/skills/opengame-all-in-one/references/opengame-sdk/references/identity.md +111 -0
  123. package/dist/skills/opengame-all-in-one/references/opengame-sdk/references/leaderboards.md +115 -0
  124. package/dist/skills/opengame-all-in-one/references/opengame-sdk/references/radio.md +71 -0
  125. package/dist/skills/opengame-all-in-one/references/opengame-stability/README.md +112 -0
  126. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/README.md +160 -0
  127. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/archetypes.md +113 -0
  128. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/briefs.md +273 -0
  129. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/core.md +129 -0
  130. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/craft.md +299 -0
  131. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/edge-cases.md +27 -0
  132. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/filmable.md +244 -0
  133. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/finishing.md +126 -0
  134. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/gates.md +184 -0
  135. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/measure.md +282 -0
  136. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/music.md +148 -0
  137. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/og-clash-record.md +133 -0
  138. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/ops.md +154 -0
  139. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/owner-eye.md +214 -0
  140. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/review.md +141 -0
  141. package/dist/skills/opengame-all-in-one/references/opengame-trailer-make/references/title.md +92 -0
  142. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/README.md +172 -0
  143. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/archetypes.md +113 -0
  144. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/briefs.md +273 -0
  145. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/core.md +129 -0
  146. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/craft.md +299 -0
  147. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/edge-cases.md +27 -0
  148. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/filmable.md +244 -0
  149. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/finishing.md +126 -0
  150. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/gates.md +184 -0
  151. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/measure.md +282 -0
  152. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/music.md +148 -0
  153. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/og-clash-record.md +133 -0
  154. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/ops.md +154 -0
  155. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/owner-eye.md +214 -0
  156. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/reference-set.md +92 -0
  157. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/review.md +141 -0
  158. package/dist/skills/opengame-all-in-one/references/opengame-trailer-plan/references/title.md +92 -0
  159. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/README.md +141 -0
  160. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/archetypes.md +113 -0
  161. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/briefs.md +273 -0
  162. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/core.md +129 -0
  163. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/craft.md +299 -0
  164. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/edge-cases.md +27 -0
  165. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/filmable.md +244 -0
  166. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/finishing.md +126 -0
  167. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/gates.md +184 -0
  168. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/measure.md +282 -0
  169. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/music.md +148 -0
  170. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/og-clash-record.md +133 -0
  171. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/ops.md +154 -0
  172. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/owner-eye.md +214 -0
  173. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/review.md +141 -0
  174. package/dist/skills/opengame-all-in-one/references/opengame-trailer-review-and-improve/references/title.md +92 -0
  175. package/dist/skills/opengame-all-in-one/references/opengame-verification/README.md +197 -0
  176. package/dist/skills/opengame-all-in-one/references/opengame-verification/helpers/browser-evidence.mjs +74 -0
  177. package/dist/skills/opengame-all-in-one/references/opengame-weapons/README.md +179 -0
  178. package/dist/skills/opengame-all-in-one/references/opengame-weapons/references/handling-numbers.md +114 -0
  179. package/dist/skills/opengame-all-in-one/references/opengame-weapons/references/reloads-and-hands.md +96 -0
  180. package/dist/skills/opengame-all-in-one/references/opengame-weapons/references/sights-and-scopes.md +98 -0
  181. package/dist/skills/opengame-all-in-one/references/opengame-weapons/references/threejs.md +240 -0
  182. package/dist/skills/opengame-all-in-one/references/opengame-world-physics/README.md +141 -0
  183. package/dist/skills/opengame-all-in-one/references/opengame-world-physics/references/measured-failures.md +79 -0
  184. package/dist/skills/opengame-api/CHANGELOG.md +12 -0
  185. package/dist/skills/opengame-api/SKILL.md +40 -13
  186. package/dist/skills/opengame-assets/CHANGELOG.md +11 -0
  187. package/dist/skills/opengame-assets/SKILL.md +79 -31
  188. package/dist/skills/opengame-assets/references/pipeline.md +67 -0
  189. package/dist/skills/opengame-audio/CHANGELOG.md +11 -0
  190. package/dist/skills/opengame-audio/SKILL.md +129 -41
  191. package/dist/skills/opengame-audio/references/mix-notes.md +44 -1
  192. package/dist/skills/opengame-audio/references/qa-without-ears.md +177 -0
  193. package/dist/skills/opengame-capture/CHANGELOG.md +10 -0
  194. package/dist/skills/opengame-capture/SKILL.md +44 -20
  195. package/dist/skills/opengame-capture/references/pipeline.md +33 -1
  196. package/dist/skills/opengame-capture/references/threejs.md +17 -1
  197. package/dist/skills/opengame-characters/CHANGELOG.md +15 -0
  198. package/dist/skills/opengame-characters/SKILL.md +94 -39
  199. package/dist/skills/opengame-characters/references/first-person-body.md +108 -0
  200. package/dist/skills/opengame-characters/references/player-og.md +1 -1
  201. package/dist/skills/opengame-cli/CHANGELOG.md +16 -0
  202. package/dist/skills/opengame-cli/SKILL.md +13 -11
  203. package/dist/skills/opengame-deploy/CHANGELOG.md +24 -0
  204. package/dist/skills/opengame-deploy/SKILL.md +47 -21
  205. package/dist/skills/opengame-deploy/references/json-events.md +6 -5
  206. package/dist/skills/opengame-deploy/references/manifest.md +3 -2
  207. package/dist/skills/opengame-deploy/references/packaging.md +29 -26
  208. package/dist/skills/opengame-depth/CHANGELOG.md +8 -0
  209. package/dist/skills/opengame-depth/SKILL.md +61 -33
  210. package/dist/skills/opengame-enemies/CHANGELOG.md +10 -0
  211. package/dist/skills/opengame-enemies/SKILL.md +96 -40
  212. package/dist/skills/opengame-enemies/references/pacing-and-bots.md +108 -0
  213. package/dist/skills/opengame-enemies/references/threejs.md +59 -0
  214. package/dist/skills/opengame-front-end/CHANGELOG.md +4 -0
  215. package/dist/skills/opengame-front-end/SKILL.md +85 -39
  216. package/dist/skills/opengame-front-end/references/menus.md +42 -8
  217. package/dist/skills/opengame-game-feel/CHANGELOG.md +11 -0
  218. package/dist/skills/opengame-game-feel/SKILL.md +95 -47
  219. package/dist/skills/opengame-game-feel/references/feel-numbers.md +59 -0
  220. package/dist/skills/opengame-game-feel/references/killcam.md +88 -0
  221. package/dist/skills/opengame-jam/CHANGELOG.md +12 -0
  222. package/dist/skills/opengame-jam/SKILL.md +59 -37
  223. package/dist/skills/opengame-lighting/CHANGELOG.md +9 -0
  224. package/dist/skills/opengame-lighting/SKILL.md +85 -34
  225. package/dist/skills/opengame-loading/CHANGELOG.md +4 -0
  226. package/dist/skills/opengame-loading/SKILL.md +78 -38
  227. package/dist/skills/opengame-loading/helpers/loading-count.mjs +115 -0
  228. package/dist/skills/opengame-loading/references/threejs.md +32 -7
  229. package/dist/skills/opengame-look/CHANGELOG.md +9 -0
  230. package/dist/skills/opengame-look/SKILL.md +122 -51
  231. package/dist/skills/opengame-look/references/matching-a-reference.md +73 -0
  232. package/dist/skills/opengame-look/references/painterly.md +69 -0
  233. package/dist/skills/opengame-look/references/post-and-lens.md +10 -3
  234. package/dist/skills/opengame-maps/CHANGELOG.md +9 -0
  235. package/dist/skills/opengame-maps/SKILL.md +78 -0
  236. package/dist/skills/opengame-maps/references/map-spec.md +77 -0
  237. package/dist/skills/opengame-mobile/CHANGELOG.md +4 -0
  238. package/dist/skills/opengame-mobile/SKILL.md +18 -18
  239. package/dist/skills/opengame-montage-make/CHANGELOG.md +5 -0
  240. package/dist/skills/opengame-montage-make/SKILL.md +187 -0
  241. package/dist/skills/opengame-montage-make/references/briefs.md +293 -0
  242. package/dist/skills/opengame-montage-make/references/day-one-questions.md +46 -0
  243. package/dist/skills/opengame-montage-make/references/edge-cases.md +27 -0
  244. package/dist/skills/opengame-montage-make/references/filmable.md +244 -0
  245. package/dist/skills/opengame-montage-make/references/finishing.md +126 -0
  246. package/dist/skills/opengame-montage-make/references/measure.md +282 -0
  247. package/dist/skills/opengame-montage-make/references/montage-capture.md +151 -0
  248. package/dist/skills/opengame-montage-make/references/montage-gates.md +84 -0
  249. package/dist/skills/opengame-montage-make/references/montage-genres.md +198 -0
  250. package/dist/skills/opengame-montage-make/references/montage-grammar.md +320 -0
  251. package/dist/skills/opengame-montage-make/references/montage-ops.md +127 -0
  252. package/dist/skills/opengame-montage-make/references/og-snipers-record.md +110 -0
  253. package/dist/skills/opengame-montage-make/references/owner-eye.md +214 -0
  254. package/dist/skills/opengame-montage-make/references/reference-study.md +293 -0
  255. package/dist/skills/opengame-montage-make/references/song.md +64 -0
  256. package/dist/skills/opengame-montage-plan/CHANGELOG.md +5 -0
  257. package/dist/skills/opengame-montage-plan/SKILL.md +197 -0
  258. package/dist/skills/opengame-montage-plan/references/briefs.md +293 -0
  259. package/dist/skills/opengame-montage-plan/references/day-one-questions.md +46 -0
  260. package/dist/skills/opengame-montage-plan/references/filmable.md +244 -0
  261. package/dist/skills/opengame-montage-plan/references/measure.md +282 -0
  262. package/dist/skills/opengame-montage-plan/references/montage-capture.md +151 -0
  263. package/dist/skills/opengame-montage-plan/references/montage-gates.md +84 -0
  264. package/dist/skills/opengame-montage-plan/references/montage-genres.md +198 -0
  265. package/dist/skills/opengame-montage-plan/references/montage-grammar.md +320 -0
  266. package/dist/skills/opengame-montage-plan/references/montage-ops.md +127 -0
  267. package/dist/skills/opengame-montage-plan/references/og-snipers-record.md +110 -0
  268. package/dist/skills/opengame-montage-plan/references/owner-eye.md +214 -0
  269. package/dist/skills/opengame-montage-plan/references/reference-study.md +293 -0
  270. package/dist/skills/opengame-montage-plan/references/song.md +64 -0
  271. package/dist/skills/opengame-montage-review-and-improve/CHANGELOG.md +5 -0
  272. package/dist/skills/opengame-montage-review-and-improve/SKILL.md +178 -0
  273. package/dist/skills/opengame-montage-review-and-improve/references/briefs.md +293 -0
  274. package/dist/skills/opengame-montage-review-and-improve/references/day-one-questions.md +46 -0
  275. package/dist/skills/opengame-montage-review-and-improve/references/filmable.md +244 -0
  276. package/dist/skills/opengame-montage-review-and-improve/references/finishing.md +126 -0
  277. package/dist/skills/opengame-montage-review-and-improve/references/measure.md +282 -0
  278. package/dist/skills/opengame-montage-review-and-improve/references/montage-capture.md +151 -0
  279. package/dist/skills/opengame-montage-review-and-improve/references/montage-gates.md +84 -0
  280. package/dist/skills/opengame-montage-review-and-improve/references/montage-genres.md +198 -0
  281. package/dist/skills/opengame-montage-review-and-improve/references/montage-grammar.md +320 -0
  282. package/dist/skills/opengame-montage-review-and-improve/references/montage-ops.md +127 -0
  283. package/dist/skills/opengame-montage-review-and-improve/references/og-snipers-record.md +110 -0
  284. package/dist/skills/opengame-montage-review-and-improve/references/owner-eye.md +214 -0
  285. package/dist/skills/opengame-montage-review-and-improve/references/reference-study.md +293 -0
  286. package/dist/skills/opengame-montage-review-and-improve/references/song.md +64 -0
  287. package/dist/skills/opengame-multiplayer/CHANGELOG.md +15 -0
  288. package/dist/skills/opengame-multiplayer/SKILL.md +143 -0
  289. package/dist/skills/opengame-multiplayer/references/bot-lobbies.md +71 -0
  290. package/dist/skills/opengame-multiplayer/references/netcode.md +165 -0
  291. package/dist/skills/opengame-performance/CHANGELOG.md +8 -0
  292. package/dist/skills/opengame-performance/SKILL.md +106 -65
  293. package/dist/skills/opengame-performance/helpers/landing-pacer.mjs +86 -0
  294. package/dist/skills/opengame-performance/references/measuring.md +51 -0
  295. package/dist/skills/opengame-performance/references/webgpu.md +86 -0
  296. package/dist/skills/opengame-production/CHANGELOG.md +13 -0
  297. package/dist/skills/opengame-production/SKILL.md +119 -54
  298. package/dist/skills/opengame-production/references/team.md +107 -0
  299. package/dist/skills/opengame-production/references/templates.md +106 -16
  300. package/dist/skills/opengame-quality-bar/CHANGELOG.md +10 -0
  301. package/dist/skills/opengame-quality-bar/SKILL.md +94 -42
  302. package/dist/skills/opengame-quality-bar/references/cheap-tells.md +14 -7
  303. package/dist/skills/opengame-quality-bar/references/judges.md +95 -0
  304. package/dist/skills/opengame-quality-bar/references/review-prompt.md +10 -5
  305. package/dist/skills/opengame-rhythm/CHANGELOG.md +5 -0
  306. package/dist/skills/opengame-rhythm/SKILL.md +138 -0
  307. package/dist/skills/opengame-rhythm/references/charting.md +109 -0
  308. package/dist/skills/opengame-rhythm/references/timing.md +92 -0
  309. package/dist/skills/opengame-router/CHANGELOG.md +8 -0
  310. package/dist/skills/opengame-router/SKILL.md +14 -7
  311. package/dist/skills/opengame-scene-audit/CHANGELOG.md +15 -0
  312. package/dist/skills/opengame-scene-audit/SKILL.md +64 -47
  313. package/dist/skills/opengame-scene-audit/helpers/scene-audit.js +97 -19
  314. package/dist/skills/opengame-sdk/CHANGELOG.md +12 -0
  315. package/dist/skills/opengame-sdk/SKILL.md +26 -9
  316. package/dist/skills/opengame-sdk/references/engines.md +2 -2
  317. package/dist/skills/opengame-sdk/references/identity.md +10 -11
  318. package/dist/skills/opengame-stability/CHANGELOG.md +4 -0
  319. package/dist/skills/opengame-stability/SKILL.md +59 -27
  320. package/dist/skills/opengame-trailer-make/CHANGELOG.md +5 -0
  321. package/dist/skills/opengame-trailer-make/SKILL.md +164 -0
  322. package/dist/skills/opengame-trailer-make/references/archetypes.md +113 -0
  323. package/dist/skills/opengame-trailer-make/references/briefs.md +273 -0
  324. package/dist/skills/opengame-trailer-make/references/core.md +129 -0
  325. package/dist/skills/opengame-trailer-make/references/craft.md +299 -0
  326. package/dist/skills/opengame-trailer-make/references/edge-cases.md +27 -0
  327. package/dist/skills/opengame-trailer-make/references/filmable.md +244 -0
  328. package/dist/skills/opengame-trailer-make/references/finishing.md +126 -0
  329. package/dist/skills/opengame-trailer-make/references/gates.md +184 -0
  330. package/dist/skills/opengame-trailer-make/references/measure.md +282 -0
  331. package/dist/skills/opengame-trailer-make/references/music.md +148 -0
  332. package/dist/skills/opengame-trailer-make/references/og-clash-record.md +133 -0
  333. package/dist/skills/opengame-trailer-make/references/ops.md +154 -0
  334. package/dist/skills/opengame-trailer-make/references/owner-eye.md +214 -0
  335. package/dist/skills/opengame-trailer-make/references/review.md +141 -0
  336. package/dist/skills/opengame-trailer-make/references/title.md +92 -0
  337. package/dist/skills/opengame-trailer-plan/CHANGELOG.md +5 -0
  338. package/dist/skills/opengame-trailer-plan/SKILL.md +176 -0
  339. package/dist/skills/opengame-trailer-plan/references/archetypes.md +113 -0
  340. package/dist/skills/opengame-trailer-plan/references/briefs.md +273 -0
  341. package/dist/skills/opengame-trailer-plan/references/core.md +129 -0
  342. package/dist/skills/opengame-trailer-plan/references/craft.md +299 -0
  343. package/dist/skills/opengame-trailer-plan/references/edge-cases.md +27 -0
  344. package/dist/skills/opengame-trailer-plan/references/filmable.md +244 -0
  345. package/dist/skills/opengame-trailer-plan/references/finishing.md +126 -0
  346. package/dist/skills/opengame-trailer-plan/references/gates.md +184 -0
  347. package/dist/skills/opengame-trailer-plan/references/measure.md +282 -0
  348. package/dist/skills/opengame-trailer-plan/references/music.md +148 -0
  349. package/dist/skills/opengame-trailer-plan/references/og-clash-record.md +133 -0
  350. package/dist/skills/opengame-trailer-plan/references/ops.md +154 -0
  351. package/dist/skills/opengame-trailer-plan/references/owner-eye.md +214 -0
  352. package/dist/skills/opengame-trailer-plan/references/reference-set.md +92 -0
  353. package/dist/skills/opengame-trailer-plan/references/review.md +141 -0
  354. package/dist/skills/opengame-trailer-plan/references/title.md +92 -0
  355. package/dist/skills/opengame-trailer-review-and-improve/CHANGELOG.md +5 -0
  356. package/dist/skills/opengame-trailer-review-and-improve/SKILL.md +145 -0
  357. package/dist/skills/opengame-trailer-review-and-improve/references/archetypes.md +113 -0
  358. package/dist/skills/opengame-trailer-review-and-improve/references/briefs.md +273 -0
  359. package/dist/skills/opengame-trailer-review-and-improve/references/core.md +129 -0
  360. package/dist/skills/opengame-trailer-review-and-improve/references/craft.md +299 -0
  361. package/dist/skills/opengame-trailer-review-and-improve/references/edge-cases.md +27 -0
  362. package/dist/skills/opengame-trailer-review-and-improve/references/filmable.md +244 -0
  363. package/dist/skills/opengame-trailer-review-and-improve/references/finishing.md +126 -0
  364. package/dist/skills/opengame-trailer-review-and-improve/references/gates.md +184 -0
  365. package/dist/skills/opengame-trailer-review-and-improve/references/measure.md +282 -0
  366. package/dist/skills/opengame-trailer-review-and-improve/references/music.md +148 -0
  367. package/dist/skills/opengame-trailer-review-and-improve/references/og-clash-record.md +133 -0
  368. package/dist/skills/opengame-trailer-review-and-improve/references/ops.md +154 -0
  369. package/dist/skills/opengame-trailer-review-and-improve/references/owner-eye.md +214 -0
  370. package/dist/skills/opengame-trailer-review-and-improve/references/review.md +141 -0
  371. package/dist/skills/opengame-trailer-review-and-improve/references/title.md +92 -0
  372. package/dist/skills/opengame-verification/CHANGELOG.md +11 -0
  373. package/dist/skills/opengame-verification/SKILL.md +113 -48
  374. package/dist/skills/opengame-weapons/CHANGELOG.md +11 -0
  375. package/dist/skills/opengame-weapons/SKILL.md +129 -55
  376. package/dist/skills/opengame-weapons/references/handling-numbers.md +42 -0
  377. package/dist/skills/opengame-weapons/references/reloads-and-hands.md +96 -0
  378. package/dist/skills/opengame-weapons/references/sights-and-scopes.md +98 -0
  379. package/dist/skills/opengame-weapons/references/threejs.md +71 -0
  380. package/dist/skills/opengame-world-physics/CHANGELOG.md +9 -0
  381. package/dist/skills/opengame-world-physics/SKILL.md +55 -24
  382. package/dist/skills/opengame-world-physics/references/measured-failures.md +28 -1
  383. package/package.json +1 -1
@@ -0,0 +1,160 @@
1
+ # The player's OG
2
+
3
+ How a game shows the player's OpenGame character. The docs page "Draw the player's
4
+ OG" (`/guides/characters`) is the long version, and `AVATAR-SPEC.md` in the
5
+ `@opengamehq/sdk` package is the style spec: every part's shape, size and color, well
6
+ enough to draw an OG in any engine and art style. This is what an agent needs while
7
+ writing the code. Numbers marked OG Clash worked in that game, a single-player Kaigen
8
+ first- and third-person shooter; measure your own.
9
+
10
+ ## Read it
11
+
12
+ ```js
13
+ import { og } from '@opengamehq/sdk'
14
+ import { watchAvatar } from '@opengamehq/sdk/avatar'
15
+
16
+ await og.init()
17
+ watchAvatar(og, avatar => {
18
+ if (!avatar) return useDefaultCharacter() // guest, no OG made, preview, signed out
19
+ prepareYourOg(avatar) // avatar.head, avatar.outfit (null: default body)
20
+ })
21
+ ```
22
+
23
+ - `og.player.avatar` is `{ seed, palette, look?, character? }`. `look` is the head
24
+ (`shape.eyes.color[.accessory[.identity]]`). `character` is the body and clothes
25
+ (`c3.body.legs.shirt.bottoms.accessory.shoes.shirtColor.bottomsColor.shoesColor.accessoryColor`;
26
+ `c4` joins several accessories with `-`; `c1` and `c2` are older saves).
27
+ - `@opengamehq/sdk/avatar` names each part and gives a hex per color in the SDK's table. It
28
+ takes the layout from `packages/shared`, so do not split the strings yourself: a
29
+ positional split turns `cape-watch` into one accessory.
30
+ - `avatar` and `match` colors follow the head (`followsHead`); their `hex` is the
31
+ head's unshaded swatch, and OpenGame renders `avatar` darker by garment. `head.finish`
32
+ marks patterned, metallic, neon and glass colors whose `hex` is an approximation. `mono` is black on
33
+ light pages and white on dark ones. `identity` picks a face set: do not use it for
34
+ gender, pronouns or voice.
35
+ - Ids are not checked against a catalogue. Map each part through a table in your game and
36
+ fall back to your default for any id the table lacks; an outfit in an unknown
37
+ version comes back as `outfit: null`, so put their head on your default body.
38
+ - `portraitUrl(avatar, { size, theme })` gives the address of the player's head as a
39
+ transparent PNG, drawn by OpenGame, or null when there is no OG. The address is keyed
40
+ by the look alone and names nobody, and the image never changes, so cache it. `size`
41
+ rounds up to one OpenGame draws (`64`, `128`, `256`, `512` pixels; the default
42
+ is 256). `theme: 'dark'` draws the inks for a dark
43
+ page. Any origin may load it, so set `crossOrigin = 'anonymous'` and use it as a WebGL
44
+ texture too.
45
+ - No bundler: copy the SDK's `dist/avatar.js` (no imports) and load it from a module
46
+ script with `OpenGame.og`. Native engines get raw recipes from the bridge's
47
+ `player()`; call `readAvatar` in the page and pass the JSON in.
48
+ - Local: `?og-dev-player=signed-in` or `og.init({ dev: { player: 'signed-in' } })`
49
+ gives look `circle.classic.white` and a `c4` hoodie, jeans, cape and watch.
50
+
51
+ ## Do not
52
+
53
+ - Store the recipe or any part of it (local storage, saves, your server, analytics,
54
+ error reports), or anything built from it: a cached model, a baked GLB (OG Clash
55
+ writes both recipes into the GLB metadata), a replay. Log unknown ids to the console only.
56
+ Remembering that the player chose "Your OG" is fine.
57
+ - Share an image of their OG except when the player chooses to share it.
58
+ - Ask the player to type or pick their OG.
59
+ - Send one player's recipe to another. A recipe relayed by a client is unverified and
60
+ beyond what the player agreed to.
61
+ - Change the head, colors or accessories and still call it "Your OG". Scale, lighting,
62
+ a team outline or badge, and a prop to hold are fine.
63
+ - Draw a stand-in OG when there is no recipe. Use your default character.
64
+
65
+ ## Build it
66
+
67
+ | Game | Model |
68
+ | --- | --- |
69
+ | Three.js | `examples/avatar-threejs` in the SDK package. Copy `og-model.js` and `og-spec.js`, call `buildOg(avatar)` with `readAvatar`'s result, and call the old group's `userData.dispose()` before you replace it |
70
+ | Other JS engine | Your art drawn to `AVATAR-SPEC.md`, or the Three.js example on a separate canvas for menus and the title |
71
+ | Native (Unity, Godot, Kaigen, C/C++) | A GLB baked in the page with a painted face (OG Clash wrote one), or your art drawn to `AVATAR-SPEC.md` |
72
+ | 2D, lists, scoreboards | `portraitUrl(avatar)`: the head as OpenGame draws it |
73
+ | Custom art | `readAvatar` parts mapped to your meshes or sprites |
74
+
75
+ The Three.js example builds the figure from primitives only (spheres, capsules, lathes
76
+ and discs) at 1 unit per H, standing on y = 0 and facing +z. `og-spec.js` holds the
77
+ spec's lengths and catalogue colors as data and is generated from the same catalogue as
78
+ `AVATAR-SPEC.md`. Change the style freely: the spec's "What makes it an OG" list is what
79
+ has to survive. A part the example does not know is drawn with the spec's default.
80
+
81
+ OG Clash's bake paints the face into a texture: built in a Web Worker, merged to 1
82
+ skinned mesh, 1 PBR material, 1024 px atlas, 12-expression eye sheet; 2.01 m,
83
+ about 100,000 triangles, 4.4 MB; about 2 s in Node on a desktop Mac, 3.7 s first bake in
84
+ the browser; the worker bundle is 748 KB before compression. Built under the loading
85
+ screen as soon as OpenGame names the player (phones and tablets wait for the title, since
86
+ the engine's load is their memory peak), held until the menus, dropped on the canvas as
87
+ `og_custom_<hash>.glb`; it checks 21 joint names,
88
+ a metadata block with sizes in range, and the file name. Kaigen's side:
89
+ `/engines/kaigen#play-as-your-own-og`.
90
+
91
+ OG Clash's joint contract, 21 joints. `_r` is the OG's right (-X), on your left when
92
+ the OG faces you: `root`, `trunk`, `thigh_r`, `shin_r`, `foot_r` and the mirror, `arm_r`,
93
+ `forearm_r`, `wrist_r`, `finger_r0..2` and the mirror, `head`. Meters, +Y up, facing +Z,
94
+ feet at 0. Arms and the head hang off `trunk`, legs off the root. The bake carries no
95
+ joint scale; if your rig scales a parent, copy local quaternions, not world matrices or
96
+ Euler angles. One torso joint, so a twist happens at the hips; OG Clash capped chest
97
+ twist at about 45 degrees.
98
+
99
+ ## Points of view (OG Clash's numbers)
100
+
101
+ - **First person, exploring (OpenGame's 3D world):** body shown, head and collar hidden;
102
+ for hand actions the arms swap to a 0.78-size set through a 58 degree lens; world lens
103
+ 74 degrees, near 0.04 m, eye moved forward when looking down.
104
+ - **First person, shooting:** separate sleeves in the shirt color and hands on the
105
+ gun's posed transform; third-person body hidden, not
106
+ shrunk (a shrunk head and shrunk limbs spread white shards under the camera). Same hand
107
+ color as third person: OpenGame's hands are the head color, and OG Clash's white
108
+ first-person mittens on "Your OG" do not match the third-person hands. Viewmodel lens
109
+ 68 degrees over a 66 degree world; fill light, no viewmodel shadows. Fade OGs inside
110
+ 0.65 m, to 30% at 0.3 m. Capture looking down while downed too.
111
+ - **Third person, shoulder:** OG on one side (OG Clash: left, at the owner's request).
112
+ 2.6 m back, 1.15 m right, pivot 1.5 m, 58 degree lens; aiming 2.5 m and 1.0 m. Center
113
+ at most 0.30 of frame width from the left; head 0.12 to 0.17 of frame width. Distances
114
+ scale with OG height / 2, clamped 0.8 to 1.2. Aim along the camera ray, then check the
115
+ gun-to-target line for walls. Carry long guns low and right, muzzle
116
+ dropped; raise to the collar to aim, top tipped about 0.16 rad outward. Include hats in clearance. Hide the body when a
117
+ wall pushes the camera inside it. Offer few views.
118
+ - **Fair play:** OGs differ in height and head size. In a competitive game give all
119
+ players the same hitbox, capsule, eye height and speed. OG Clash, single-player, sets
120
+ first-person eye height per OG.
121
+ - **Top-down:** the head is the identity; keep the head color and accessory readable, add a
122
+ label or ring.
123
+ - **2D and side view:** `portraitUrl` gives the head in OpenGame's pixel style. Draw it
124
+ at a whole multiple of its size with `image-rendering: pixelated`, or draw the head
125
+ yourself from `AVATAR-SPEC.md`.
126
+ - **Menus:** turntable, menu-specific light (warm key, cyan rim), the old figure until
127
+ the new one loads then a 0.24 s scale-in, still images in lists (live portraits stalled
128
+ OG Clash at the 39th quick switch), eyes forced open in stills, the pose checked
129
+ against the head.
130
+ - **Title and results:** the player's OG in the shot, about 0.27 to 0.30 of frame height
131
+ on the title and 0.37 to 0.39 in victory; check each staged camera is not inside
132
+ geometry and aims at the OG's real height.
133
+ - **HUD:** `@handle (You)` from `og.player.handle`; with no handle, the character's name
134
+ and `(You)`, or `You` on "Your OG".
135
+
136
+ ## "Your OG" in the roster
137
+
138
+ First in the list, with a label; equipped once loaded unless the player picked another
139
+ this session; outfit options that would replace it locked with a reason; changes wait
140
+ for menus (a sign-in during a run waits); sign-out removes it at the next menu; a guest
141
+ gets only the roster; one OG chosen once and used in all scenes.
142
+
143
+ ## Fallbacks
144
+
145
+ No look: default character. Look, no outfit or unknown outfit version: their head on the
146
+ default body. Unknown part: default part. Failed or slow build: default character, log
147
+ the reason to the console, retry at the next menu (OG Clash: 90 s). Still building: the
148
+ previous figure, not an empty stage or gray stand-in.
149
+
150
+ ## Memory
151
+
152
+ Boot does not wait for the OG beyond a short hold at the title for a build already under
153
+ way (OG Clash: 4 s at most), and the builder's download counts too. Few workers,
154
+ stopped when the character screen closes: OG Clash's desktop build runs a warm worker and a
155
+ spare and found 3 the limit (5 slowed imports), and phones get 1. Opening "Your OG" once added 861 MB to OG Clash's page (4 to 8 workers, builds
156
+ in advance, caches) and crashed an iPhone; the light mode for phones, tablets and
157
+ devices reporting 4 GB or less uses 1 worker, no builds in advance, a 24 MB model cache
158
+ instead of 96 MB, textures up to 1024 px. Import cost 144 to 188 ms over 5 frames, so
159
+ import only in menus. Change color and eyes as material parameters, not rebuilds. Test
160
+ in Safari on a real phone.
@@ -0,0 +1,190 @@
1
+ > Carried from `opengame-cli` 1.9.0. Read it when: Drive the OpenGame command line tool from an agent. Covers installing it, signing in with the person, every command, JSON and JSONL output, exit codes, findings and how to retry. Use when the person mentions the opengame command, the OpenGame CLI, installing @opengamehq/cli, opengame login, check, dev, deploy, status, submit, releases, rollback, unpublish, restore, delete, details, achievements, handle, jam or token, or a command exited with an error you need to read.
2
+
3
+
4
+ # Use the OpenGame CLI
5
+
6
+ OpenGame opens on 18 November 2026, and any signed-in account can use the CLI
7
+ now. Until 18 November, a command run before `opengame login` prints
8
+ "OpenGame opens for creators on 18 November." and exits with the `not_launched` code (7) that
9
+ `opengame help --json` lists. That is not a broken install: run `opengame login`, then the
10
+ command again, and do not reinstall or look for a way round it.
11
+
12
+ For the whole deploy procedure, read `opengame-deploy`. This skill is the reference
13
+ for the tool itself.
14
+
15
+ ## Install
16
+
17
+ ```bash
18
+ npm i -g @opengamehq/cli
19
+ ```
20
+
21
+ Once `opengame` is installed, confirm it and read the command reference:
22
+
23
+ ```bash
24
+ opengame version --json
25
+ opengame help --json
26
+ ```
27
+
28
+ `help --json` is the authority on commands, flags and exit codes for the version that
29
+ is installed. Read it before using a flag this page does not show.
30
+
31
+ ## Sign in with the person
32
+
33
+ ```bash
34
+ opengame whoami --json
35
+ ```
36
+
37
+ If that exits 3, start a login. In JSON or agent mode it prints a URL and a code and
38
+ exits 3 with `login_pending` straight away:
39
+
40
+ ```bash
41
+ opengame login --json
42
+ ```
43
+
44
+ Give the person the URL and the code. They open it, type the code and press Allow
45
+ access; you cannot approve it for them. Once they say they have, finish:
46
+
47
+ ```bash
48
+ opengame login --continue --json
49
+ ```
50
+
51
+ `login_expired` or `no_pending_login` means start again with `login --json`.
52
+
53
+ For CI, use a token the person makes in their browser with `opengame token create`,
54
+ supplied as `OPENGAME_TOKEN` or on standard input with `--token-stdin`. Never put a
55
+ token in a command argument, a file in the project, a log or a reply.
56
+
57
+ ## Commands
58
+
59
+ | Command | What it does |
60
+ | --- | --- |
61
+ | `opengame init [dir]` | Create opengame.json for an existing game. Asks a person only the game's name; the rest is filled in on the deploy's page. |
62
+ | `opengame check [dir]` | Find local build and asset problems before uploading. |
63
+ | `opengame dev [dir]` | Serve a local export with the game runtime's headers. |
64
+ | `opengame login` | Sign in through the browser. |
65
+ | `opengame deploy [dir]` | Build, check and upload a release to a private preview. `--publish` also waits for review and publishes it when it passes. |
66
+ | `opengame status [dir]` | Show the latest deploy for this folder, with its findings. |
67
+ | `opengame deployments [dir]` | List the linked game's deploys, newest first. |
68
+ | `opengame open [dir]` | Open the linked game's private page. |
69
+ | `opengame submit [dir]` | Send a release to review that is not there yet. A ready deploy goes to review by itself; for a release already in review, jam flags are not used (`jam_answers_unused`), so pass them to `opengame publish`. |
70
+ | `opengame publish [dir]` | Publish the release that passed review, as Confirm and publish does on the deploy's page: the details review wrote, or the ones given as flags, and the jam's track and models (`--track`, `--models`). Follows it until it is live and prints the address. `--wait` waits for review first. An update of a live game publishes by itself. |
71
+ | `opengame jams [slug]` | List open jams, or show one jam's tracks and flags. |
72
+ | `opengame jam <withdraw\|reenter>` | Withdraw the linked game's jam entry, or put a withdrawn one back. |
73
+ | `opengame releases [dir]` | List the linked game's releases: which is live, which were live before, and which can be made live again. |
74
+ | `opengame rollback <release>` | Make a release that was live before live again, for every player. |
75
+ | `opengame unpublish [dir]` | Take the linked game off the gallery and stop serving it. Reversible. |
76
+ | `opengame restore [dir]` | Put a game the person unpublished back on the gallery. |
77
+ | `opengame delete [dir]` | Delete the linked game for good, with its title typed to confirm. |
78
+ | `opengame achievements [retire <id>]` | List the game's achievements, or retire one. |
79
+ | `opengame details [dir]` | Print the game's title, tagline and description as the website shows them, or change them. |
80
+ | `opengame handle <name>` | Rename the person's handle. |
81
+ | `opengame games` | List your games and their latest deploy. |
82
+ | `opengame link [dir]` | Connect this folder to an existing game. |
83
+ | `opengame pull [dir]` | Bring website metadata into this folder. |
84
+ | `opengame stats [game or dir]` | Read a week of analytics for a game you own. |
85
+ | `opengame whoami` | Show the account and permissions for this token. |
86
+ | `opengame token create, list or revoke` | Manage tokens, in the browser. |
87
+ | `opengame logout` | Revoke this device's token and remove it. |
88
+ | `opengame limits` | Show bundle limits and the account's remaining allowance. |
89
+ | `opengame vendor [dir]` | Make a separate export with dependencies downloaded and pinned. |
90
+ | `opengame skills add or list` | Install the OpenGame skills for a coding agent. |
91
+ | `opengame upgrade` | Install the current CLI, or print the line that does. |
92
+ | `opengame version` | Print the CLI version. |
93
+
94
+ ## Roll back
95
+
96
+ When a new version of a live game is broken, `opengame releases --json` lists every
97
+ release with `rollback: true` on the ones that can be made live again. Confirm with the
98
+ person which one they want, then run `opengame rollback <release> --yes --json` with the
99
+ eight characters the list prints or the whole id. It changes what every player gets from
100
+ their next load, so never run it without the person's go-ahead, and never to undo a
101
+ refusal: a release that was never live goes through review, which its deploy starts by itself. It needs a token
102
+ with `read` or `deploy`, and `submit`, which `opengame login` gives. A refusal's `message`
103
+ says why, for example the game is not live, or a release is being published right now. If
104
+ it answers `host_failed`, run the same command again: the second run writes only the
105
+ game's address.
106
+
107
+ ## Take a game down, or put it back
108
+
109
+ `opengame unpublish --yes --json` takes the linked game (or `--game <id>`) off the gallery
110
+ and stops serving it; its build, uploads and review record are kept. `opengame restore
111
+ --yes --json` puts a game the person unpublished back, serving the version it was on. Both
112
+ change what every player gets, so run either only when the person asks for it. Both need a
113
+ token with `read` or `deploy`, and `submit`, which `opengame login` gives. A refusal's `message` is the website's
114
+ own reason, for example the game is not on the gallery, OpenGame took it down, a report is
115
+ open, or it is under a hold. Do not try to get round one: write to team@opengame.io is the
116
+ way on when the message says so. `unpublish_incomplete` and `restore_incomplete` mean the
117
+ first half happened; run the same command again.
118
+
119
+ `opengame delete --title "<title>" --yes --json` deletes a game for good. It cannot be
120
+ undone, so run it only when the person has asked for that game to be deleted, and pass the
121
+ title they confirmed rather than reading it off the game yourself. Unpublishing is the
122
+ reversible way to take a game down; offer it first. Delete works only with the `opengame
123
+ login` token. `delete_refused` says why, for example a legal hold.
124
+
125
+ ## Change a game's words, or the person's handle
126
+
127
+ `opengame details --json` prints the title, tagline and description the website shows.
128
+ `opengame details --title "<text>" --tagline "<text>" --description "<text>" --json` saves
129
+ any of them, as the Details tab does; a field left out stays, and `--clear-tagline` removes
130
+ the tagline. On a published game players
131
+ see it at once, so change only what the person asked for. To keep `opengame.json` in step,
132
+ run `opengame pull` afterwards. `opengame handle <name> --yes --json` renames the person's
133
+ handle. Ask first: their old handle becomes free for anyone to claim, their games keep
134
+ their /g links, their profile address changes, and renames are limited per day. It works only with the `opengame login` token, not a token made in
135
+ settings. A refusal's `message` says why, for example the name is taken.
136
+
137
+ ## Retire an achievement
138
+
139
+ Removing an achievement from `opengame.json` does not switch it off. `opengame achievements
140
+ --json` lists them; `opengame achievements retire <id> --yes --json` retires one when the
141
+ person asks. Players keep what they unlocked, and declaring it again and deploying turns it
142
+ back on. Retiring needs `deploy` and `submit`, which `opengame login` gives.
143
+
144
+ ## Withdraw a jam entry, or put it back
145
+
146
+ `opengame jam withdraw --yes --json` takes the linked game's entry out of the jam and frees
147
+ its place; the entry, its build and its certifications are kept. Run it only when the person
148
+ asks. `opengame jam reenter --json` puts the newest withdrawn entry back while the jam is
149
+ open, with the same reference and build. Both need `read` or `deploy`, and `submit`.
150
+ `at_entry_limit` means every place is taken: ask the person which entry to withdraw first.
151
+ `reenter_closed` means the jam is not taking entries; wait for it to open, and do not
152
+ re-enter after it closes. `jam_entry_taken` means a newer entry of the game is already in.
153
+
154
+ ## Stats as a file
155
+
156
+ `opengame stats --csv week.csv` writes the week's figures as the CSV the Stats tab
157
+ downloads; it takes the same `--game` and `--period` and never writes over a file.
158
+
159
+ ## Read the output
160
+
161
+ Add `--json` for one final object, or `--jsonl` for progress events with the result
162
+ or error as the last line. Every result has `type`, `ok`, `findings` and `notices`. A
163
+ success carries its values in `data`. An error carries `code`, `message` and, where it
164
+ helps, `retry`, `retryAfterSeconds` and `next`, the command to run next.
165
+
166
+ | Exit | Name | What to do |
167
+ | --- | --- | --- |
168
+ | 0 | `ok` | Done. A deploy with `data.done: false` is still being checked; follow it with `opengame status --watch --json`. |
169
+ | 1 | `check` | The game needs a change. Read the findings, fix, and run each finding's `verify` command. |
170
+ | 2 | `input` | A flag, a choice or a different command is needed. The message names it. |
171
+ | 3 | `auth` | Sign in, or use a token with the right scope. Run the error's `next` when it has one. |
172
+ | 4 | `rateLimited` | An allowance is used. Wait `retryAfterSeconds`, then run the same command. |
173
+ | 5 | `server` | Our side or the network; the game is fine. Follow `retry`. |
174
+ | 6 | `upgrade` | This CLI is too old. Run `opengame upgrade --json`. |
175
+
176
+ `not_launched` has an exit code of its own, listed by `help --json`. Branch on the
177
+ error's `code` rather than the number wherever you can.
178
+
179
+ ## Act on findings
180
+
181
+ Each finding has `fault`, `certainty` and `retry`:
182
+
183
+ - `fault: game`: make the change its `fix` describes, then run its `verify` command.
184
+ - `certainty: heuristic`: check the evidence before changing code that works.
185
+ - `fault: platform`: leave the game alone and follow `retry`. `now` means run the same
186
+ command again, `later` means wait, and `after-fix` or `never` means waiting will not
187
+ help, so read `fix`.
188
+
189
+ Keep retries bounded. If the same platform failure repeats, give the person the
190
+ command, the error code and the evidence instead of trying again.
@@ -0,0 +1,229 @@
1
+ > Carried from `opengame-deploy` 1.1.7. Read it when: Put a browser game online with OpenGame, the marketplace and game jam for browser games. Packages the game, checks it locally, uploads it to a private preview only the owner can play, reads and fixes findings, then hands the creator the page where they confirm the details after review. Use when the person says deploy my game, put it online, host it, share it, upload it, publish it, get me a link, make it playable for friends, or asks where to put a browser game or a Three.js game.
2
+
3
+
4
+ # Deploy a browser game to OpenGame
5
+
6
+ OpenGame opens on 18 November 2026. Any signed-in account can use the CLI,
7
+ uploads and jam entries now. Until 18 November, a CLI command run before `opengame login`
8
+ prints "OpenGame opens for creators on 18 November." and exits 7 (`not_launched`).
9
+ Nothing is wrong with the game or the install: ask the person to run `opengame login`, then
10
+ run the command again. Do not reinstall or work around it.
11
+
12
+ <!-- generated:procedure -->
13
+ Deploy the creator's game to a private preview and give them its link. Review starts automatically. When it passes, publish the game with `opengame publish` if the creator asked you to, or give them the deploy's page to publish it themselves. Read each command's result before you run the next one.
14
+
15
+ ## Install
16
+
17
+ ```bash
18
+ npm i -g @opengamehq/cli
19
+ ```
20
+
21
+ Once `opengame` is installed, confirm it and read the command reference:
22
+
23
+ ```bash
24
+ opengame version --json
25
+ opengame help --json
26
+ ```
27
+
28
+ `help --json` lists every command, flag, exit code, environment variable and event, with the finding schema. Read it rather than guessing a flag.
29
+
30
+ Install the OpenGame skills for the agent you run in, from the game folder:
31
+
32
+ ```bash
33
+ opengame skills add .
34
+ ```
35
+
36
+ That installs a starting set. `opengame skills list` names the rest; add one with `--skill <name>`, or `--skill opengame-all-in-one` for every skill as one.
37
+
38
+ The CLI talks to `https://opengame.io`. Never put a token in a command argument, a file in the repository, a log or a reply. For CI, set `OPENGAME_TOKEN` or pipe the token with `--token-stdin`.
39
+
40
+ ## Output
41
+
42
+ Every command takes `--json`. When stdout is not a terminal, or `CI`, `CLAUDECODE` or another agent's variable is set, `--json` is the default. A command then prints one object:
43
+
44
+ ```json
45
+ {
46
+ "type": "result",
47
+ "command": "deploy",
48
+ "data": { "state": "queued", "done": false },
49
+ "ok": true,
50
+ "url": "https://opengame.io/settings/deployments/<id>",
51
+ "next": "opengame status --watch",
52
+ "findings": [],
53
+ "notices": []
54
+ }
55
+ ```
56
+
57
+ An error has `"type": "error"`, `"ok": false`, a `code`, a `message`, an `exitCode` and, when there is one, a `next` command to run. `--jsonl` streams one event per line instead: `progress`, `notice`, `finding`, then a `result` or `error` last. In either mode there are no prompts and no browser opens.
58
+
59
+ | Exit | Meaning | What to do |
60
+ | --- | --- | --- |
61
+ | 0 | Done | Read `data`. `data.done: false` means the server is still working. |
62
+ | 1 | The game needs a change | Fix each finding, then run its `verify` command. |
63
+ | 2 | The command needs input | Read the message. It names the missing flag or choice. |
64
+ | 3 | Sign in, or a token with the right scope | Run `next` when the error has one. |
65
+ | 4 | An allowance is used up | Wait `retryAfterSeconds`, then run the same command. |
66
+ | 5 | Our side or the network | Leave the game as it is. Run `next` when the error has one; otherwise wait and retry, at most a few times. |
67
+ | 6 | The CLI is too old | Run `opengame upgrade --json`, then the npm command in `data.command`. |
68
+ | 7 | OpenGame is not open to creators yet | The CLI has no login. Ask the creator to run `opengame login`, then run the command again. Until 18 November this is what a signed-out CLI hears. |
69
+
70
+ ## Sign in with the creator
71
+
72
+ ```bash
73
+ opengame whoami --json
74
+ ```
75
+
76
+ Exit 0 means a saved login works. Exit 3 means start one:
77
+
78
+ ```bash
79
+ opengame login --json
80
+ ```
81
+
82
+ `login --json` prints the approval link and code as a `device_approval` notice, then exits 3 with `login_pending`. Give the creator both. They open the link, sign in, type the code and press Allow access. You cannot approve it for them. When they say they have, finish:
83
+
84
+ ```bash
85
+ opengame login --continue --json
86
+ ```
87
+
88
+ `--continue` waits up to 10 seconds for the approval.
89
+
90
+ | Result | What to do |
91
+ | --- | --- |
92
+ | Exit 0 | Signed in. `data.handle` is the creator's handle. |
93
+ | Exit 3, `login_pending` | Not approved yet. Run `login --continue --json` again once the creator has pressed Allow access. |
94
+ | Exit 3, `access_denied` | The creator pressed Deny, or the account cannot be used. Read the message to them. |
95
+ | `login_expired` or `no_pending_login` | The code ran out. Run `login --json` for a new one. |
96
+
97
+ ## Deploy a private preview
98
+
99
+ Run these from the game folder.
100
+
101
+ If the folder has no `opengame.json`, create one. The title is all it needs. A decomp or a mod says so with `--kind` and names the game it is based on:
102
+
103
+ ```bash
104
+ opengame init . --title "My game" --json
105
+ opengame init . --title "Doom but blue" --kind mod --based-on "Doom" --json
106
+ ```
107
+
108
+ Do not ask the creator for a description or a genre before deploying. When you know them, pass `--description` (40 characters or more) and `--genre`; when you do not, leave them out. Every field defaults to Auto: review writes the description and the genre from the game, and the creator accepts or changes them on the deploy's page, where they also enter the jam. After the deploy you can set the description yourself with `opengame details --description "..." --json`. If the file already exists, leave `init` alone and edit the file.
109
+
110
+ For a game that already exists on OpenGame, in a new checkout, link the folder first so the deploy does not create a second game:
111
+
112
+ ```bash
113
+ opengame games --json
114
+ opengame link --game <id> --json
115
+ ```
116
+
117
+ Check, then deploy:
118
+
119
+ ```bash
120
+ opengame check . --build --json
121
+ opengame deploy . --json
122
+ ```
123
+
124
+ `deploy` runs the manifest's build command, checks the output and uploads it, up to 4 GiB zipped. It returns once the upload is in, with exit 0 and `data.done: false`, while the checks run on the server. Keep `.opengame/`: later commands resume and follow the same deploy from it. Use `--no-build` only when the creator says the export is already built and its build cannot run here, never to get past a failing build.
125
+
126
+ | Field | What it holds |
127
+ | --- | --- |
128
+ | `data.deploymentUrl` | The deploy's page. Give it to the creator straight away: it shows each check and plays the preview once they pass. |
129
+ | `data.state` | `uploading`, `queued`, `checking`, `ready`, `failed` or `expired`. |
130
+ | `data.done` | `true` once the server has finished. |
131
+ | `data.releaseId` | The release. Keep it for `submit`. |
132
+ | `data.previewUrl` | The private preview link, once `state` is `ready`. It can be `null` on a ready release the server will not play; the deploy's page says why. |
133
+ | `data.gameOrigin` | The origin the published game runs at, such as `https://k3v9q2m7x4ab.opengame.gg`. Give it to the creator when the game talks to their own servers. `null` when the server sent none, or sent one this CLI cannot read. |
134
+
135
+ To follow the checks, run `status --watch`, which follows the deploy for up to 300 seconds. Set `--timeout <seconds>` for a short tool call; when it runs out the command exits 5 with `checks_pending` and the checks carry on.
136
+
137
+ ```bash
138
+ opengame status --watch --timeout 60 --json
139
+ ```
140
+
141
+ To block on the outcome in one command, deploy with `--wait`:
142
+
143
+ ```bash
144
+ opengame deploy . --wait --json
145
+ ```
146
+
147
+ Tell the creator the preview is ready only when a result says `data.state: "ready"` and `data.done: true`. Give them `data.previewUrl` and `data.releaseId`. Play it, or ask them to, before you say the game works.
148
+
149
+ ## Fix findings
150
+
151
+ Each finding has a `fault`, a `certainty` and a `retry`:
152
+
153
+ | Finding | What to do |
154
+ | --- | --- |
155
+ | `fault: game` | Read `evidence`, make the change in `fix`, then run the command in `verify`. |
156
+ | `certainty: heuristic` | Check the evidence before you change working code. |
157
+ | `fault: platform` | Leave the game as it is. Follow `retry`: `now` runs again, `later` waits `retryAfterSeconds`, `after-fix` and `never` mean waiting will not help, so read `fix`. |
158
+ | `fault: unknown` | Nothing to change. The playtest and the automatic review settle it. Report it to the creator. |
159
+
160
+ A plain `deploy` resumes a saved upload, or starts a fresh one with an `upload_restarted` notice when the saved one can no longer finish. A deploy started with `--idempotency-key` exits 2 instead. Start a fresh one with a new key, or without the flag:
161
+
162
+ ```bash
163
+ opengame deploy . \
164
+ --idempotency-key <a new key> --json
165
+ ```
166
+
167
+ An account can begin 5 deploys in a rolling day, so fix what `opengame check` finds before you deploy again. Run `opengame limits --json` for the upload limits and the allowance left on the account. If the same platform failure repeats, stop and give the creator the command, the error code and the evidence.
168
+
169
+ ## Review and publishing
170
+
171
+ Review starts automatically once a deploy is ready, so you submit no release. Review is automatic: it plays the game, then passes it or returns it with findings.
172
+
173
+ When review passes, a game's first release waits to be published. `opengame status --json` shows `data.review.state: "awaiting_details"`, `data.review.next: "opengame publish"` and the deploy's page in `data.review.url`.
174
+
175
+ - **The creator asked you to publish it.** Run `opengame publish --json`. It confirms the title, description and genre review wrote, publishes, waits until the game is live and prints the address to share in `data.url`. Change what review wrote with `--description`, `--genre` and the other flags in `opengame publish --help`. While a new game goes on OpenGame only as a jam entry, pass the jam's track and the models used with `--track` and `--models`; `opengame jams <slug> --json` lists them.
176
+ - **They did not ask.** Give them `data.review.url`. Signed in, they check the details, enter the jam and publish on that page.
177
+
178
+ To publish in one step, `opengame deploy --publish --json` stays until review passes, then publishes, and takes the same jam flags.
179
+
180
+ An update to a game that is already live publishes by itself once it passes review. It keeps the live game's details, including the genre when the deploy left it to Auto, and its jam entry. The token that deployed it has to hold `submit`, as the `opengame login` token does. When the creator asked only for a preview of an update to a live game, deploy with a token made in their settings with `deploy` alone, set as `OPENGAME_TOKEN`, so the release waits for them.
181
+
182
+ `opengame submit` does not confirm a release that is already in review. The server keeps that submission and prints a `jam_answers_unused` notice: the jam answers you passed were not used. Pass them to `opengame publish` once review passes.
183
+
184
+ While Game Jam #1 runs, a new game goes on OpenGame only as a jam entry, up to 2 for each account. Mods and decomps publish outside the jam at any time and never enter it. When the jam cannot take a build, for example because the account already has 2 entries, the build is not sent to review, and the deploy's page explains why. [Enter a jam](https://docs.opengame.io/guides/jams) has the rules.
185
+
186
+ Follow the release to the end:
187
+
188
+ ```bash
189
+ opengame status --watch --json
190
+ ```
191
+
192
+ | `data.review.state` | What to do |
193
+ | --- | --- |
194
+ | `review`, `playtesting`, `waiting` | Review is running. Watch again. |
195
+ | `awaiting_details` | Run `opengame publish --json` when the creator asked you to publish. Otherwise give them `data.review.url`, and watch again once they say they have published. |
196
+ | `needs_certification` | Give the creator `data.review.url`. Watch again once they say they have done it. |
197
+ | `publishing`, `published` | The game is going live. `data.submission.gameUrl` is its page. |
198
+ | `returned` | Read the findings, fix the game and deploy again. The new deploy is reviewed automatically. |
199
+
200
+ ## What a game may do
201
+
202
+ OpenGame hosts static browser exports. The build needs `index.html` at the root of its output folder.
203
+
204
+ At runtime the game may call its own origin, `https://api.opengame.gg`, and any other `https:` or `wss:` host. Each call comes from the player's browser, so that host sees the player's IP address. Keep API keys on the creator's server, never in the bundle: players can read every file in it. The review sandbox has no internet, so the game must draw its first frame without its server.
205
+
206
+ The published game runs at `https://<label>.opengame.gg`, one origin per game, and `opengame deploy` returns it as `data.gameOrigin`. While an experiment runs, players load each version taking part from a `v-` origin instead. If the creator's servers check `Origin` (WebSocket) or send CORS headers (HTTP), they reject the game's requests until that exact origin is on their list, and online play fails with a closed socket, a 401 or 403 on the upgrade, or a CORS error in the console. Tell the creator to add it, and to add a version's `v-` origin before starting an experiment with it. Never suggest allowing `*.opengame.gg`, `null` or any pattern on `opengame.gg`, because other people's games are served there too and a pattern lets them call the creator's server. Use a token in a header or the first socket message, not a cookie. A private preview runs on a temporary `p-` origin, not the game's. That address is a private link, so keep it out of committed config and logs. [Games that talk to your own servers](https://docs.opengame.io/guides/packaging#games-that-talk-to-your-own-servers) has server examples.
207
+
208
+ A game may not take payments, use crypto, make players create an account or give an email address, show ads, or carry ad pixels or session recording. [Packaging](https://docs.opengame.io/guides/packaging) has every rule and every check.
209
+
210
+ ## Multiplayer
211
+
212
+ OpenGame runs no game server or rooms. A multiplayer game brings its own, through PeerJS or a server the creator runs, and OpenGame supplies the invite link:
213
+
214
+ - **Invites.** Share `og.invite.link(code)`, the game's page on opengame.io with `?join=CODE`, never the game's `opengame.gg` address. After `await og.init()`, a player with `og.invite.code` set opened an invite: join them to that lobby with no menu in between. Codes are 4 to 12 capitals and digits, or 22 characters of `A-Z a-z 0-9 _ -`; for any other code, and outside OpenGame, `link` returns `null`, so keep the code on screen too.
215
+ - **PeerJS.** Run the creator's PeerServer over `wss:` in place of the public `0.peerjs.com`, check `Origin` in front of it, and prefix peer ids with the game's name. Use STUN plus TURN, with TURN credentials issued by the creator's server and kept out of the bundle. When the host leaves, the next player takes over the same lobby id so shared links keep working.
216
+ - **Game servers.** `wss:` and `https:` only. Allow the game's exact origin, never a pattern on `opengame.gg`. Send a token in a header or the first socket message, not a cookie, and treat `og.player.id` as the player's claim.
217
+
218
+ [Multiplayer](https://docs.opengame.io/guides/multiplayer) has the code, the server settings and how to test a lobby with two browsers.
219
+
220
+ ## Engines
221
+
222
+ OpenGame supports games built with Three.js, Unity, Godot, Kaigen and WebAssembly, and static web builds from any JavaScript engine. `opengame check` and the server detect the engine from the build. Any other static browser export uploads as a custom build, under the same file and runtime checks.
223
+
224
+ Run `opengame init . --engine <id>` to record an engine's export folder. `opengame help --json` lists the IDs, and `init` prints the export steps and the guide for the one you choose. The [engine overview](https://docs.opengame.io/engines/overview) links every engine page.
225
+
226
+ Play the private preview before you tell the creator the game works.
227
+ <!-- /generated:procedure -->
228
+
229
+ For field definitions, read [references/manifest.md](references/manifest.md). For the full packaging contract, read [references/packaging.md](references/packaging.md). For sample findings, read [references/json-events.md](references/json-events.md). Read `opengame-jam` for eligibility, certifications and judging rules.
@@ -0,0 +1,63 @@
1
+ # Reading the CLI's JSON
2
+
3
+ With `--json` every line of output is one JSON object. Four kinds can appear before the
4
+ last line, and the last line is always a `result` or an `error`.
5
+
6
+ | `type` | Meaning | What to do |
7
+ | --- | --- | --- |
8
+ | `progress` | A stage started or moved on: `build`, `check`, `upload`, then the server's own stages for the deploy, `certify` and `review:<state>` for a submit, `approval` for a login | Nothing; it is a heartbeat |
9
+ | `notice` | Something the person should know: excluded files, kept website metadata, a resumed upload, a sign-in URL | Read `code` and `message`; pass sign-in and kept-metadata notices on |
10
+ | `finding` | One problem in the game or one check that could not decide | Fix or report it, by its `fault`, `certainty` and `retry` |
11
+ | `result` | The command finished; `data` holds its answer | Read `data` |
12
+ | `error` | The command stopped; `code`, `message`, `exitCode`, `retry`, and `next`, `retryAfterSeconds` or `finding` when they apply | Run `next` when there is one; otherwise act on the exit code below |
13
+
14
+ ## Exit codes
15
+
16
+ | Code | Meaning | What an agent does |
17
+ | --- | --- | --- |
18
+ | 0 | Done | Read the result |
19
+ | 1 | A check failed | Fix the findings, run `opengame check`, then deploy again |
20
+ | 2 | Input missing or invalid | The message names the flag or value to supply |
21
+ | 3 | Not signed in, or the token lacks permission. A login waiting for approval also exits 3, with code `login_pending` | `login_pending`: show the person the URL and code, then run `next` (`opengame login --continue`) until it exits 0. Otherwise `opengame whoami`, then `opengame login`, or ask for a token with the right scope |
22
+ | 4 | Rate limited | Wait `retryAfterSeconds` if the error has it, otherwise a few minutes, then run the same command once. Do not loop |
23
+ | 5 | Our side failed, or a local file could not be read or written | The game is fine. Retry later; never change the game for this |
24
+ | 6 | This CLI is too old for the server | Run `next`, which is `opengame upgrade`. Signed out, run `opengame login` first; it works on this version |
25
+ | 7 | `not_launched`: OpenGame is not open to this caller yet | The CLI has no login. Ask the person to run `opengame login`, then run the same command again. Do not reinstall or retry in a loop |
26
+
27
+ ## A worked repair
28
+
29
+ A game whose `index.html` loads `./Game.js` while the file on disk is `game.js`. It runs
30
+ on the creator's Mac, because the Mac's file system ignores case, and is a missing file for every
31
+ player. `opengame check . --json` prints:
32
+
33
+ ```json
34
+ {"type":"finding","finding":{"release":null,"check":"case-mismatch","checkVersion":"packaging@1","state":"failed","certainty":"certain","fault":"game","evidence":{"observed":"index.html line 1 asks for Game.js, but the file is game.js.","file":"index.html:1"},"fix":"macOS and Windows do not care about capitalisation. The servers that hand your game to a player do. So this loads on your machine and the file is missing for everybody else. Fix the reference or rename the file so the two match exactly.","verify":"opengame check, then opengame deploy","retry":"after-fix"}}
35
+ {"type":"finding","finding":{"release":null,"check":"platform-engine","checkVersion":"packaging@1","evidence":{"observed":"Browser compatibility needs a playtest."},"state":"inconclusive","certainty":"heuristic","fault":"unknown","fix":"Built with Three.js r170, from window.__THREE__ registration. Static browser exports from any engine, or none, go to review, where a playtest checks that this one runs. Every game must pass the same runtime and safety checks before publication. Nothing has to change now; you can deploy as it is.","verify":"opengame deploy","retry":"never"}}
36
+ {"type":"error","code":"check_failed","message":"This build has blockers. Fix them, then run opengame check again.","exitCode":1,"retry":"after-fix"}
37
+ ```
38
+
39
+ Reading it:
40
+
41
+ 1. The first finding is `failed`, `certain` and `fault: "game"`, so it is the game's to
42
+ fix. `evidence.file` says `index.html:1`. Change `./Game.js` to `./game.js` there
43
+ (or rename the file), then run what `verify` says.
44
+ 2. The second finding is `inconclusive`, `heuristic` and `fault: "unknown"`, with
45
+ `retry: "never"`. It does not block anything. Do not add a fake Three.js import to make
46
+ it go away; the playtest in review checks that the game runs.
47
+ 3. After the fix, `opengame check . --json` ends in a `result` and exits 0.
48
+
49
+ ## Findings that are ours
50
+
51
+ A finding with `fault: "platform"`, or an error with exit code 5, means the test machine,
52
+ review or storage failed. The CLI says so in plain words.
53
+ Leave the game alone, wait `retryAfterSeconds` when the finding or error has it (a few
54
+ minutes when it does not), and run the same command again. Rewriting a working game to satisfy a broken check is the failure this rule
55
+ exists to prevent.
56
+
57
+ ## Results worth keeping
58
+
59
+ - `deploy`: `operationId`, `state` (`uploading`, `queued`, `checking`, `ready`,
60
+ `failed`, `expired`), `gameId`, `releaseId`, `url`, and `timingsMs` when it finished.
61
+ Keep `releaseId`: submitting names it.
62
+ - `check`: `files`, `bytes`, `excluded` and `findings`.
63
+ - `whoami`: the signed-in handle and the token's scopes.