brick-engine-js 1.0.1

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 (477) hide show
  1. package/.env.local.example +2 -0
  2. package/.github/workflows/publish.yml +73 -0
  3. package/.prettierignore +2 -0
  4. package/.prettierrc.json +8 -0
  5. package/README.adoc +84 -0
  6. package/dist/8e23286c2fdf41fd795f.svg +32 -0
  7. package/dist/CNAME +1 -0
  8. package/dist/app.js +2 -0
  9. package/dist/app.js.map +1 -0
  10. package/dist/brick-engine.js +2 -0
  11. package/dist/brick-engine.js.map +1 -0
  12. package/dist/config/configs.d.ts +180 -0
  13. package/dist/config/configs.test.d.ts +1 -0
  14. package/dist/config/env.d.ts +2 -0
  15. package/dist/config/env.test.d.ts +1 -0
  16. package/dist/config/styles.d.ts +0 -0
  17. package/dist/core/Game.d.ts +107 -0
  18. package/dist/core/Game.test.d.ts +1 -0
  19. package/dist/core/InitialStateSnapshot.d.ts +19 -0
  20. package/dist/core/InitialStateSnapshot.test.d.ts +1 -0
  21. package/dist/core/helpers/CellHelper.d.ts +13 -0
  22. package/dist/core/helpers/CellHelper.test.d.ts +1 -0
  23. package/dist/core/helpers/ControlInputHandlerHelper.d.ts +32 -0
  24. package/dist/core/helpers/ControlInputHandlerHelper.test.d.ts +1 -0
  25. package/dist/core/helpers/CoordinateHelper.d.ts +54 -0
  26. package/dist/core/helpers/CoordinateHelper.test.d.ts +1 -0
  27. package/dist/core/helpers/InterfaceIdentifierHelper.d.ts +7 -0
  28. package/dist/core/helpers/InterfaceIdentifierHelper.test.d.ts +1 -0
  29. package/dist/core/helpers/RelativeValuesHelper.d.ts +23 -0
  30. package/dist/core/helpers/RelativeValuesHelper.test.d.ts +1 -0
  31. package/dist/core/module/control/GameControl.d.ts +62 -0
  32. package/dist/core/module/control/GameControl.test.d.ts +1 -0
  33. package/dist/core/module/control/GameControlKeyBinding.d.ts +36 -0
  34. package/dist/core/module/control/GameControlKeyBinding.test.d.ts +1 -0
  35. package/dist/core/module/grid/GameGrid.d.ts +399 -0
  36. package/dist/core/module/grid/GameGrid.test.d.ts +1 -0
  37. package/dist/core/module/grid/GameHudGrid.d.ts +24 -0
  38. package/dist/core/module/grid/GameHudGrid.test.d.ts +1 -0
  39. package/dist/core/module/grid/engines/GridAnalysisEngine.d.ts +29 -0
  40. package/dist/core/module/grid/engines/GridAnalysisEngine.test.d.ts +1 -0
  41. package/dist/core/module/grid/engines/GridLineEngine.d.ts +56 -0
  42. package/dist/core/module/grid/engines/GridLineEngine.test.d.ts +1 -0
  43. package/dist/core/module/grid/engines/GridMovementEngine.d.ts +29 -0
  44. package/dist/core/module/grid/engines/GridMovementEngine.test.d.ts +1 -0
  45. package/dist/core/module/grid/engines/GridRegionEngine.d.ts +26 -0
  46. package/dist/core/module/grid/engines/GridRegionEngine.test.d.ts +1 -0
  47. package/dist/core/module/grid/engines/GridTransformEngine.d.ts +24 -0
  48. package/dist/core/module/grid/engines/GridTransformEngine.test.d.ts +1 -0
  49. package/dist/core/module/renderer/DisplayRenderer.d.ts +51 -0
  50. package/dist/core/module/renderer/DisplayRenderer.test.d.ts +1 -0
  51. package/dist/core/module/renderer/GameRenderer.d.ts +59 -0
  52. package/dist/core/module/renderer/GameRenderer.test.d.ts +1 -0
  53. package/dist/core/module/renderer/HudRenderer.d.ts +56 -0
  54. package/dist/core/module/renderer/HudRenderer.test.d.ts +1 -0
  55. package/dist/core/module/score/GameScore.d.ts +117 -0
  56. package/dist/core/module/score/GameScore.test.d.ts +1 -0
  57. package/dist/core/module/session/GameSession.d.ts +20 -0
  58. package/dist/core/module/session/GameSession.test.d.ts +1 -0
  59. package/dist/core/module/sound/GameSound.d.ts +85 -0
  60. package/dist/core/module/sound/GameSound.test.d.ts +1 -0
  61. package/dist/core/module/state/GameState.d.ts +172 -0
  62. package/dist/core/module/state/GameState.test.d.ts +1 -0
  63. package/dist/core/module/text/GameText.d.ts +87 -0
  64. package/dist/core/module/text/GameText.test.d.ts +1 -0
  65. package/dist/core/module/time/GameTime.d.ts +76 -0
  66. package/dist/core/module/time/GameTime.test.d.ts +1 -0
  67. package/dist/core/types/Interfaces.d.ts +53 -0
  68. package/dist/core/types/Types.d.ts +114 -0
  69. package/dist/core/types/enums.d.ts +106 -0
  70. package/dist/core/types/modules.d.ts +723 -0
  71. package/dist/css/app.743066d8e4172b0e73f9.css +824 -0
  72. package/dist/css/app.743066d8e4172b0e73f9.css.map +1 -0
  73. package/dist/docs/GAME_DEVELOPER_GUIDE.html +727 -0
  74. package/dist/docs/brick-engine-guide.html +610 -0
  75. package/dist/docs/diagrams/lifecycle.mmd +19 -0
  76. package/dist/docs/documentation_style_guide.html +994 -0
  77. package/dist/docs/getting-started.html +648 -0
  78. package/dist/docs/images/lifecycle.svg +1 -0
  79. package/dist/docs/index.html +593 -0
  80. package/dist/docs/jsdoc_standard.html +656 -0
  81. package/dist/docs/publishing.html +573 -0
  82. package/dist/docs/reference/enums/Color.html +533 -0
  83. package/dist/docs/reference/enums/ControlEventType.html +505 -0
  84. package/dist/docs/reference/enums/ControlKey.html +529 -0
  85. package/dist/docs/reference/enums/FontAlignment.html +545 -0
  86. package/dist/docs/reference/enums/FontSize.html +517 -0
  87. package/dist/docs/reference/enums/Sound.html +558 -0
  88. package/dist/docs/reference/enums/StateProperty.html +525 -0
  89. package/dist/docs/reference/helpers/CellHelper.html +520 -0
  90. package/dist/docs/reference/helpers/ControlInputHandlerHelper.html +569 -0
  91. package/dist/docs/reference/helpers/CoordinateHelper.html +703 -0
  92. package/dist/docs/reference/helpers/RelativeValuesHelper.html +560 -0
  93. package/dist/docs/reference/interfaces/Debuggable.html +501 -0
  94. package/dist/docs/reference/interfaces/GameModules.html +544 -0
  95. package/dist/docs/reference/interfaces/Initializable.html +495 -0
  96. package/dist/docs/reference/interfaces/RendererInitializable.html +517 -0
  97. package/dist/docs/reference/interfaces/StateSyncable.html +542 -0
  98. package/dist/docs/reference/interfaces/modules/Control.html +648 -0
  99. package/dist/docs/reference/interfaces/modules/Grid.html +1256 -0
  100. package/dist/docs/reference/interfaces/modules/Renderer.html +522 -0
  101. package/dist/docs/reference/interfaces/modules/RendererComposite.html +577 -0
  102. package/dist/docs/reference/interfaces/modules/Score.html +669 -0
  103. package/dist/docs/reference/interfaces/modules/Session.html +585 -0
  104. package/dist/docs/reference/interfaces/modules/State.html +897 -0
  105. package/dist/docs/reference/interfaces/modules/Text.html +668 -0
  106. package/dist/docs/reference/interfaces/modules/Time.html +684 -0
  107. package/dist/docs/reference/modules/Debugger.html +579 -0
  108. package/dist/docs/reference/modules/DisplayRenderer.html +557 -0
  109. package/dist/docs/reference/modules/Game.html +909 -0
  110. package/dist/docs/reference/modules/GameControl.html +716 -0
  111. package/dist/docs/reference/modules/GameGrid.html +1910 -0
  112. package/dist/docs/reference/modules/GameHudGrid.html +508 -0
  113. package/dist/docs/reference/modules/GameMenu.html +538 -0
  114. package/dist/docs/reference/modules/GameRenderer.html +589 -0
  115. package/dist/docs/reference/modules/GameScore.html +664 -0
  116. package/dist/docs/reference/modules/GameSession.html +533 -0
  117. package/dist/docs/reference/modules/GameSound.html +636 -0
  118. package/dist/docs/reference/modules/GameState.html +922 -0
  119. package/dist/docs/reference/modules/GameText.html +701 -0
  120. package/dist/docs/reference/modules/GameTime.html +696 -0
  121. package/dist/docs/reference/modules/HudRenderer.html +568 -0
  122. package/dist/docs/reference/modules/InitialStateSnapshot.html +557 -0
  123. package/dist/docs/reference/modules/SessionModal.html +520 -0
  124. package/dist/docs/reference/types/Axis.html +505 -0
  125. package/dist/docs/reference/types/Cell.html +514 -0
  126. package/dist/docs/reference/types/ControlCallback.html +488 -0
  127. package/dist/docs/reference/types/Coordinate.html +510 -0
  128. package/dist/docs/reference/types/GameEntry.html +514 -0
  129. package/dist/docs/reference/types/GameEvent.html +514 -0
  130. package/dist/docs/reference/types/Piece.html +506 -0
  131. package/dist/docs/reference/types/RendererMetrics.html +514 -0
  132. package/dist/docs/reference/types/Vector.html +509 -0
  133. package/dist/docs/testing_best_practices.html +770 -0
  134. package/dist/favicon.ico +0 -0
  135. package/dist/fonts/digital-7.monoitalic.ttf +0 -0
  136. package/dist/images/cell.svg +32 -0
  137. package/dist/images/close.png +0 -0
  138. package/dist/images/games.png +0 -0
  139. package/dist/images/github.png +0 -0
  140. package/dist/images/letter-a.png +0 -0
  141. package/dist/images/letter-d.png +0 -0
  142. package/dist/images/letter-j.png +0 -0
  143. package/dist/images/letter-s.png +0 -0
  144. package/dist/images/letter-w.png +0 -0
  145. package/dist/images/meta-image.png +0 -0
  146. package/dist/images/number-1.png +0 -0
  147. package/dist/images/number-2.png +0 -0
  148. package/dist/images/number-3.png +0 -0
  149. package/dist/images/number-4.png +0 -0
  150. package/dist/images/number-5.png +0 -0
  151. package/dist/images/number-6.png +0 -0
  152. package/dist/images/splash.gif +0 -0
  153. package/dist/index.d.ts +8 -0
  154. package/dist/index.html +1 -0
  155. package/dist/index.test.d.ts +1 -0
  156. package/dist/main.d.ts +3 -0
  157. package/dist/main.test.d.ts +1 -0
  158. package/dist/menu/GameMenu.d.ts +15 -0
  159. package/dist/menu/GameMenu.test.d.ts +1 -0
  160. package/dist/menu/GameMenuSingleton.d.ts +6 -0
  161. package/dist/menu/GameMenuSingleton.test.d.ts +1 -0
  162. package/dist/menu/GameRepository.d.ts +7 -0
  163. package/dist/menu/GameRepository.test.d.ts +1 -0
  164. package/dist/menu/manager/GameManager.d.ts +6 -0
  165. package/dist/menu/manager/GameManager.test.d.ts +1 -0
  166. package/dist/sounds/sound_00.wav +0 -0
  167. package/dist/sounds/sound_01.wav +0 -0
  168. package/dist/sounds/sound_02.wav +0 -0
  169. package/dist/sounds/sound_03.wav +0 -0
  170. package/dist/sounds/sound_04.wav +0 -0
  171. package/dist/sounds/sound_05.wav +0 -0
  172. package/dist/sounds/sound_06.wav +0 -0
  173. package/dist/sounds/sound_07.wav +0 -0
  174. package/dist/sounds/sound_08.wav +0 -0
  175. package/dist/sounds/sound_09.wav +0 -0
  176. package/dist/sounds/sound_10.wav +0 -0
  177. package/dist/sounds/sound_11.wav +0 -0
  178. package/dist/sounds/sound_12.wav +0 -0
  179. package/dist/sounds/sound_13.wav +0 -0
  180. package/dist/sounds/sound_14.wav +0 -0
  181. package/dist/sounds/sound_15.wav +0 -0
  182. package/dist/types/interfaces.d.ts +5 -0
  183. package/dist/vendor/p5.min.js +1 -0
  184. package/dist/view/Debugger.d.ts +12 -0
  185. package/dist/view/Debugger.test.d.ts +1 -0
  186. package/dist/view/GameView.d.ts +101 -0
  187. package/dist/view/GameView.test.d.ts +1 -0
  188. package/dist/view/SessionModal.d.ts +12 -0
  189. package/dist/view/SessionModal.test.d.ts +4 -0
  190. package/dist/view/components/layout/ButtonLayout.d.ts +25 -0
  191. package/dist/view/components/layout/ButtonLayout.test.d.ts +1 -0
  192. package/dist/view/components/layout/ContainerLayout.d.ts +23 -0
  193. package/dist/view/components/layout/ContainerLayout.test.d.ts +1 -0
  194. package/dist/view/components/layout/FrameLayout.d.ts +11 -0
  195. package/dist/view/components/layout/FrameLayout.test.d.ts +1 -0
  196. package/dist/view/components/ui/BigButton.d.ts +13 -0
  197. package/dist/view/components/ui/BigButton.test.d.ts +1 -0
  198. package/dist/view/components/ui/Button.d.ts +12 -0
  199. package/dist/view/components/ui/Button.test.d.ts +1 -0
  200. package/dist/view/components/ui/Canvas.d.ts +22 -0
  201. package/dist/view/components/ui/Canvas.test.d.ts +1 -0
  202. package/dist/view/components/ui/SmallButton.d.ts +13 -0
  203. package/dist/view/components/ui/SmallButton.test.d.ts +1 -0
  204. package/dist/view/theme/applyColors.d.ts +10 -0
  205. package/dist/view/theme/applyColors.test.d.ts +1 -0
  206. package/dist/view/theme/dimensions.d.ts +13 -0
  207. package/dist/view/theme/dimensions.test.d.ts +1 -0
  208. package/docs/GAME_DEVELOPER_GUIDE.adoc +167 -0
  209. package/docs/brick-engine-guide.adoc +87 -0
  210. package/docs/diagrams/lifecycle.mmd +19 -0
  211. package/docs/documentation_style_guide.adoc +210 -0
  212. package/docs/getting-started.adoc +147 -0
  213. package/docs/images/lifecycle.svg +1 -0
  214. package/docs/jsdoc_standard.adoc +109 -0
  215. package/docs/publishing.adoc +58 -0
  216. package/docs/reference/enums/Color.adoc +35 -0
  217. package/docs/reference/enums/ControlEventType.adoc +28 -0
  218. package/docs/reference/enums/ControlKey.adoc +34 -0
  219. package/docs/reference/enums/FontAlignment.adoc +43 -0
  220. package/docs/reference/enums/FontSize.adoc +31 -0
  221. package/docs/reference/enums/Sound.adoc +42 -0
  222. package/docs/reference/enums/StateProperty.adoc +33 -0
  223. package/docs/reference/helpers/CellHelper.adoc +37 -0
  224. package/docs/reference/helpers/ControlInputHandlerHelper.adoc +57 -0
  225. package/docs/reference/helpers/CoordinateHelper.adoc +118 -0
  226. package/docs/reference/helpers/RelativeValuesHelper.adoc +53 -0
  227. package/docs/reference/interfaces/Debuggable.adoc +29 -0
  228. package/docs/reference/interfaces/GameModules.adoc +35 -0
  229. package/docs/reference/interfaces/Initializable.adoc +24 -0
  230. package/docs/reference/interfaces/RendererInitializable.adoc +33 -0
  231. package/docs/reference/interfaces/StateSyncable.adoc +41 -0
  232. package/docs/reference/interfaces/modules/Control.adoc +98 -0
  233. package/docs/reference/interfaces/modules/Grid.adoc +411 -0
  234. package/docs/reference/interfaces/modules/Renderer.adoc +34 -0
  235. package/docs/reference/interfaces/modules/RendererComposite.adoc +57 -0
  236. package/docs/reference/interfaces/modules/Score.adoc +107 -0
  237. package/docs/reference/interfaces/modules/Session.adoc +66 -0
  238. package/docs/reference/interfaces/modules/State.adoc +290 -0
  239. package/docs/reference/interfaces/modules/Text.adoc +110 -0
  240. package/docs/reference/interfaces/modules/Time.adoc +119 -0
  241. package/docs/reference/modules/Debugger.adoc +71 -0
  242. package/docs/reference/modules/DisplayRenderer.adoc +55 -0
  243. package/docs/reference/modules/Game.adoc +256 -0
  244. package/docs/reference/modules/GameControl.adoc +139 -0
  245. package/docs/reference/modules/GameGrid.adoc +794 -0
  246. package/docs/reference/modules/GameHudGrid.adoc +38 -0
  247. package/docs/reference/modules/GameMenu.adoc +39 -0
  248. package/docs/reference/modules/GameRenderer.adoc +79 -0
  249. package/docs/reference/modules/GameScore.adoc +138 -0
  250. package/docs/reference/modules/GameSession.adoc +43 -0
  251. package/docs/reference/modules/GameSound.adoc +111 -0
  252. package/docs/reference/modules/GameState.adoc +318 -0
  253. package/docs/reference/modules/GameText.adoc +139 -0
  254. package/docs/reference/modules/GameTime.adoc +141 -0
  255. package/docs/reference/modules/HudRenderer.adoc +56 -0
  256. package/docs/reference/modules/InitialStateSnapshot.adoc +47 -0
  257. package/docs/reference/modules/SessionModal.adoc +34 -0
  258. package/docs/reference/types/Axis.adoc +28 -0
  259. package/docs/reference/types/Cell.adoc +29 -0
  260. package/docs/reference/types/ControlCallback.adoc +23 -0
  261. package/docs/reference/types/Coordinate.adoc +29 -0
  262. package/docs/reference/types/GameEntry.adoc +29 -0
  263. package/docs/reference/types/GameEvent.adoc +29 -0
  264. package/docs/reference/types/Piece.adoc +32 -0
  265. package/docs/reference/types/RendererMetrics.adoc +29 -0
  266. package/docs/reference/types/Vector.adoc +28 -0
  267. package/docs/testing_best_practices.adoc +190 -0
  268. package/eslint.config.mjs +29 -0
  269. package/package.json +54 -0
  270. package/public/CNAME +1 -0
  271. package/public/docs/GAME_DEVELOPER_GUIDE.html +727 -0
  272. package/public/docs/brick-engine-guide.html +610 -0
  273. package/public/docs/diagrams/lifecycle.mmd +19 -0
  274. package/public/docs/documentation_style_guide.html +994 -0
  275. package/public/docs/getting-started.html +648 -0
  276. package/public/docs/images/lifecycle.svg +1 -0
  277. package/public/docs/index.html +593 -0
  278. package/public/docs/jsdoc_standard.html +656 -0
  279. package/public/docs/publishing.html +573 -0
  280. package/public/docs/reference/enums/Color.html +533 -0
  281. package/public/docs/reference/enums/ControlEventType.html +505 -0
  282. package/public/docs/reference/enums/ControlKey.html +529 -0
  283. package/public/docs/reference/enums/FontAlignment.html +545 -0
  284. package/public/docs/reference/enums/FontSize.html +517 -0
  285. package/public/docs/reference/enums/Sound.html +558 -0
  286. package/public/docs/reference/enums/StateProperty.html +525 -0
  287. package/public/docs/reference/helpers/CellHelper.html +520 -0
  288. package/public/docs/reference/helpers/ControlInputHandlerHelper.html +569 -0
  289. package/public/docs/reference/helpers/CoordinateHelper.html +703 -0
  290. package/public/docs/reference/helpers/RelativeValuesHelper.html +560 -0
  291. package/public/docs/reference/interfaces/Debuggable.html +501 -0
  292. package/public/docs/reference/interfaces/GameModules.html +544 -0
  293. package/public/docs/reference/interfaces/Initializable.html +495 -0
  294. package/public/docs/reference/interfaces/RendererInitializable.html +517 -0
  295. package/public/docs/reference/interfaces/StateSyncable.html +542 -0
  296. package/public/docs/reference/interfaces/modules/Control.html +648 -0
  297. package/public/docs/reference/interfaces/modules/Grid.html +1256 -0
  298. package/public/docs/reference/interfaces/modules/Renderer.html +522 -0
  299. package/public/docs/reference/interfaces/modules/RendererComposite.html +577 -0
  300. package/public/docs/reference/interfaces/modules/Score.html +669 -0
  301. package/public/docs/reference/interfaces/modules/Session.html +585 -0
  302. package/public/docs/reference/interfaces/modules/State.html +897 -0
  303. package/public/docs/reference/interfaces/modules/Text.html +668 -0
  304. package/public/docs/reference/interfaces/modules/Time.html +684 -0
  305. package/public/docs/reference/modules/Debugger.html +579 -0
  306. package/public/docs/reference/modules/DisplayRenderer.html +557 -0
  307. package/public/docs/reference/modules/Game.html +909 -0
  308. package/public/docs/reference/modules/GameControl.html +716 -0
  309. package/public/docs/reference/modules/GameGrid.html +1910 -0
  310. package/public/docs/reference/modules/GameHudGrid.html +508 -0
  311. package/public/docs/reference/modules/GameMenu.html +538 -0
  312. package/public/docs/reference/modules/GameRenderer.html +589 -0
  313. package/public/docs/reference/modules/GameScore.html +664 -0
  314. package/public/docs/reference/modules/GameSession.html +533 -0
  315. package/public/docs/reference/modules/GameSound.html +636 -0
  316. package/public/docs/reference/modules/GameState.html +922 -0
  317. package/public/docs/reference/modules/GameText.html +701 -0
  318. package/public/docs/reference/modules/GameTime.html +696 -0
  319. package/public/docs/reference/modules/HudRenderer.html +568 -0
  320. package/public/docs/reference/modules/InitialStateSnapshot.html +557 -0
  321. package/public/docs/reference/modules/SessionModal.html +520 -0
  322. package/public/docs/reference/types/Axis.html +505 -0
  323. package/public/docs/reference/types/Cell.html +514 -0
  324. package/public/docs/reference/types/ControlCallback.html +488 -0
  325. package/public/docs/reference/types/Coordinate.html +510 -0
  326. package/public/docs/reference/types/GameEntry.html +514 -0
  327. package/public/docs/reference/types/GameEvent.html +514 -0
  328. package/public/docs/reference/types/Piece.html +506 -0
  329. package/public/docs/reference/types/RendererMetrics.html +514 -0
  330. package/public/docs/reference/types/Vector.html +509 -0
  331. package/public/docs/testing_best_practices.html +770 -0
  332. package/public/favicon.ico +0 -0
  333. package/public/fonts/digital-7.monoitalic.ttf +0 -0
  334. package/public/images/cell.svg +32 -0
  335. package/public/images/close.png +0 -0
  336. package/public/images/games.png +0 -0
  337. package/public/images/github.png +0 -0
  338. package/public/images/letter-a.png +0 -0
  339. package/public/images/letter-d.png +0 -0
  340. package/public/images/letter-j.png +0 -0
  341. package/public/images/letter-s.png +0 -0
  342. package/public/images/letter-w.png +0 -0
  343. package/public/images/meta-image.png +0 -0
  344. package/public/images/number-1.png +0 -0
  345. package/public/images/number-2.png +0 -0
  346. package/public/images/number-3.png +0 -0
  347. package/public/images/number-4.png +0 -0
  348. package/public/images/number-5.png +0 -0
  349. package/public/images/number-6.png +0 -0
  350. package/public/images/splash.gif +0 -0
  351. package/public/index.html +15 -0
  352. package/public/sounds/sound_00.wav +0 -0
  353. package/public/sounds/sound_01.wav +0 -0
  354. package/public/sounds/sound_02.wav +0 -0
  355. package/public/sounds/sound_03.wav +0 -0
  356. package/public/sounds/sound_04.wav +0 -0
  357. package/public/sounds/sound_05.wav +0 -0
  358. package/public/sounds/sound_06.wav +0 -0
  359. package/public/sounds/sound_07.wav +0 -0
  360. package/public/sounds/sound_08.wav +0 -0
  361. package/public/sounds/sound_09.wav +0 -0
  362. package/public/sounds/sound_10.wav +0 -0
  363. package/public/sounds/sound_11.wav +0 -0
  364. package/public/sounds/sound_12.wav +0 -0
  365. package/public/sounds/sound_13.wav +0 -0
  366. package/public/sounds/sound_14.wav +0 -0
  367. package/public/sounds/sound_15.wav +0 -0
  368. package/public/style/body.css +86 -0
  369. package/public/style/buttons.css +233 -0
  370. package/public/style/debugger.css +117 -0
  371. package/public/style/sessionModal.css +155 -0
  372. package/public/style/sourceCodeAndCommands.css +74 -0
  373. package/public/style/splash.css +13 -0
  374. package/public/style/theme.css +137 -0
  375. package/scripts/generate-diagrams.sh +20 -0
  376. package/scripts/generate-docs.js +111 -0
  377. package/src/client-game.d.ts +1 -0
  378. package/src/config/configs.test.ts +20 -0
  379. package/src/config/configs.ts +197 -0
  380. package/src/config/env.test.ts +59 -0
  381. package/src/config/env.ts +7 -0
  382. package/src/config/styles.ts +5 -0
  383. package/src/core/Game.test.ts +167 -0
  384. package/src/core/Game.ts +307 -0
  385. package/src/core/InitialStateSnapshot.test.ts +51 -0
  386. package/src/core/InitialStateSnapshot.ts +46 -0
  387. package/src/core/helpers/CellHelper.test.ts +33 -0
  388. package/src/core/helpers/CellHelper.ts +21 -0
  389. package/src/core/helpers/ControlInputHandlerHelper.test.ts +116 -0
  390. package/src/core/helpers/ControlInputHandlerHelper.ts +68 -0
  391. package/src/core/helpers/CoordinateHelper.test.ts +113 -0
  392. package/src/core/helpers/CoordinateHelper.ts +82 -0
  393. package/src/core/helpers/InterfaceIdentifierHelper.test.ts +122 -0
  394. package/src/core/helpers/InterfaceIdentifierHelper.ts +43 -0
  395. package/src/core/helpers/RelativeValuesHelper.test.ts +47 -0
  396. package/src/core/helpers/RelativeValuesHelper.ts +29 -0
  397. package/src/core/module/control/GameControl.test.ts +82 -0
  398. package/src/core/module/control/GameControl.ts +142 -0
  399. package/src/core/module/control/GameControlKeyBinding.test.ts +59 -0
  400. package/src/core/module/control/GameControlKeyBinding.ts +92 -0
  401. package/src/core/module/grid/GameGrid.test.ts +83 -0
  402. package/src/core/module/grid/GameGrid.ts +610 -0
  403. package/src/core/module/grid/GameHudGrid.test.ts +22 -0
  404. package/src/core/module/grid/GameHudGrid.ts +40 -0
  405. package/src/core/module/grid/engines/GridAnalysisEngine.test.ts +157 -0
  406. package/src/core/module/grid/engines/GridAnalysisEngine.ts +124 -0
  407. package/src/core/module/grid/engines/GridLineEngine.test.ts +132 -0
  408. package/src/core/module/grid/engines/GridLineEngine.ts +165 -0
  409. package/src/core/module/grid/engines/GridMovementEngine.test.ts +125 -0
  410. package/src/core/module/grid/engines/GridMovementEngine.ts +113 -0
  411. package/src/core/module/grid/engines/GridRegionEngine.test.ts +136 -0
  412. package/src/core/module/grid/engines/GridRegionEngine.ts +52 -0
  413. package/src/core/module/grid/engines/GridTransformEngine.test.ts +98 -0
  414. package/src/core/module/grid/engines/GridTransformEngine.ts +70 -0
  415. package/src/core/module/renderer/DisplayRenderer.test.ts +86 -0
  416. package/src/core/module/renderer/DisplayRenderer.ts +152 -0
  417. package/src/core/module/renderer/GameRenderer.test.ts +103 -0
  418. package/src/core/module/renderer/GameRenderer.ts +144 -0
  419. package/src/core/module/renderer/HudRenderer.test.ts +108 -0
  420. package/src/core/module/renderer/HudRenderer.ts +203 -0
  421. package/src/core/module/score/GameScore.test.ts +71 -0
  422. package/src/core/module/score/GameScore.ts +188 -0
  423. package/src/core/module/session/GameSession.test.ts +176 -0
  424. package/src/core/module/session/GameSession.ts +103 -0
  425. package/src/core/module/sound/GameSound.test.ts +117 -0
  426. package/src/core/module/sound/GameSound.ts +229 -0
  427. package/src/core/module/state/GameState.test.ts +101 -0
  428. package/src/core/module/state/GameState.ts +339 -0
  429. package/src/core/module/text/GameText.test.ts +87 -0
  430. package/src/core/module/text/GameText.ts +150 -0
  431. package/src/core/module/time/GameTime.test.ts +86 -0
  432. package/src/core/module/time/GameTime.ts +144 -0
  433. package/src/core/types/Interfaces.ts +59 -0
  434. package/src/core/types/Types.ts +124 -0
  435. package/src/core/types/enums.ts +113 -0
  436. package/src/core/types/modules.ts +841 -0
  437. package/src/index.test.ts +15 -0
  438. package/src/index.ts +9 -0
  439. package/src/main.test.ts +137 -0
  440. package/src/main.ts +77 -0
  441. package/src/menu/GameMenu.test.ts +157 -0
  442. package/src/menu/GameMenu.ts +124 -0
  443. package/src/menu/GameMenuSingleton.test.ts +26 -0
  444. package/src/menu/GameMenuSingleton.ts +13 -0
  445. package/src/menu/GameRepository.test.ts +46 -0
  446. package/src/menu/GameRepository.ts +47 -0
  447. package/src/menu/manager/GameManager.test.ts +68 -0
  448. package/src/menu/manager/GameManager.ts +50 -0
  449. package/src/types/global.d.ts +8 -0
  450. package/src/types/interfaces.ts +5 -0
  451. package/src/view/Debugger.test.ts +152 -0
  452. package/src/view/Debugger.ts +124 -0
  453. package/src/view/GameView.test.ts +95 -0
  454. package/src/view/GameView.ts +244 -0
  455. package/src/view/SessionModal.test.ts +141 -0
  456. package/src/view/SessionModal.ts +73 -0
  457. package/src/view/components/layout/ButtonLayout.test.ts +28 -0
  458. package/src/view/components/layout/ButtonLayout.ts +63 -0
  459. package/src/view/components/layout/ContainerLayout.test.ts +48 -0
  460. package/src/view/components/layout/ContainerLayout.ts +50 -0
  461. package/src/view/components/layout/FrameLayout.test.ts +24 -0
  462. package/src/view/components/layout/FrameLayout.ts +25 -0
  463. package/src/view/components/ui/BigButton.test.ts +28 -0
  464. package/src/view/components/ui/BigButton.ts +31 -0
  465. package/src/view/components/ui/Button.test.ts +30 -0
  466. package/src/view/components/ui/Button.ts +30 -0
  467. package/src/view/components/ui/Canvas.test.ts +32 -0
  468. package/src/view/components/ui/Canvas.ts +34 -0
  469. package/src/view/components/ui/SmallButton.test.ts +48 -0
  470. package/src/view/components/ui/SmallButton.ts +32 -0
  471. package/src/view/theme/applyColors.test.ts +47 -0
  472. package/src/view/theme/applyColors.ts +38 -0
  473. package/src/view/theme/dimensions.test.ts +34 -0
  474. package/src/view/theme/dimensions.ts +53 -0
  475. package/tsconfig.json +16 -0
  476. package/vitest.config.ts +14 -0
  477. package/webpack.config.js +133 -0
package/dist/docs/documentation_style_guide.html ADDED
@@ -0,0 +1,994 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
7
+ <meta name="generator" content="Asciidoctor 2.0.20">
8
+ <meta name="description" content="Project standards for creating and maintaining high-quality documentation.">
9
+ <meta name="keywords" content="documentation, style-guide, standards, asciidoc">
10
+ <title>Documentation Style Guide &amp; Lessons Learned</title>
11
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
12
+ <style>
13
+ /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
14
+ /* Uncomment the following line when using as a custom stylesheet */
15
+ /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
16
+ html{font-family:sans-serif;-webkit-text-size-adjust:100%}
17
+ a{background:none}
18
+ a:focus{outline:thin dotted}
19
+ a:active,a:hover{outline:0}
20
+ h1{font-size:2em;margin:.67em 0}
21
+ b,strong{font-weight:bold}
22
+ abbr{font-size:.9em}
23
+ abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
24
+ dfn{font-style:italic}
25
+ hr{height:0}
26
+ mark{background:#ff0;color:#000}
27
+ code,kbd,pre,samp{font-family:monospace;font-size:1em}
28
+ pre{white-space:pre-wrap}
29
+ q{quotes:"\201C" "\201D" "\2018" "\2019"}
30
+ small{font-size:80%}
31
+ sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
32
+ sup{top:-.5em}
33
+ sub{bottom:-.25em}
34
+ img{border:0}
35
+ svg:not(:root){overflow:hidden}
36
+ figure{margin:0}
37
+ audio,video{display:inline-block}
38
+ audio:not([controls]){display:none;height:0}
39
+ fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
40
+ legend{border:0;padding:0}
41
+ button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
42
+ button,input{line-height:normal}
43
+ button,select{text-transform:none}
44
+ button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
45
+ button[disabled],html input[disabled]{cursor:default}
46
+ input[type=checkbox],input[type=radio]{padding:0}
47
+ button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
48
+ textarea{overflow:auto;vertical-align:top}
49
+ table{border-collapse:collapse;border-spacing:0}
50
+ *,::before,::after{box-sizing:border-box}
51
+ html,body{font-size:100%}
52
+ body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
53
+ a:hover{cursor:pointer}
54
+ img,object,embed{max-width:100%;height:auto}
55
+ object,embed{height:100%}
56
+ img{-ms-interpolation-mode:bicubic}
57
+ .left{float:left!important}
58
+ .right{float:right!important}
59
+ .text-left{text-align:left!important}
60
+ .text-right{text-align:right!important}
61
+ .text-center{text-align:center!important}
62
+ .text-justify{text-align:justify!important}
63
+ .hide{display:none}
64
+ img,object,svg{display:inline-block;vertical-align:middle}
65
+ textarea{height:auto;min-height:50px}
66
+ select{width:100%}
67
+ .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
68
+ div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
69
+ a{color:#2156a5;text-decoration:underline;line-height:inherit}
70
+ a:hover,a:focus{color:#1d4b8f}
71
+ a img{border:0}
72
+ p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
73
+ p aside{font-size:.875em;line-height:1.35;font-style:italic}
74
+ h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
75
+ h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
76
+ h1{font-size:2.125em}
77
+ h2{font-size:1.6875em}
78
+ h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
79
+ h4,h5{font-size:1.125em}
80
+ h6{font-size:1em}
81
+ hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
82
+ em,i{font-style:italic;line-height:inherit}
83
+ strong,b{font-weight:bold;line-height:inherit}
84
+ small{font-size:60%;line-height:inherit}
85
+ code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
86
+ ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
87
+ ul,ol{margin-left:1.5em}
88
+ ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
89
+ ul.circle{list-style-type:circle}
90
+ ul.disc{list-style-type:disc}
91
+ ul.square{list-style-type:square}
92
+ ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
93
+ ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
94
+ dl dt{margin-bottom:.3125em;font-weight:bold}
95
+ dl dd{margin-bottom:1.25em}
96
+ blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
97
+ blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
98
+ @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
99
+ h1{font-size:2.75em}
100
+ h2{font-size:2.3125em}
101
+ h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
102
+ h4{font-size:1.4375em}}
103
+ table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
104
+ table thead,table tfoot{background:#f7f8f7}
105
+ table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
106
+ table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
107
+ table tr.even,table tr.alt{background:#f8f8f7}
108
+ table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
109
+ h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
110
+ h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
111
+ .center{margin-left:auto;margin-right:auto}
112
+ .stretch{width:100%}
113
+ .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
114
+ .clearfix::after,.float-group::after{clear:both}
115
+ :not(pre).nobreak{word-wrap:normal}
116
+ :not(pre).nowrap{white-space:nowrap}
117
+ :not(pre).pre-wrap{white-space:pre-wrap}
118
+ :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
119
+ pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
120
+ pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
121
+ pre>code{display:block}
122
+ pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
123
+ em em{font-style:normal}
124
+ strong strong{font-weight:400}
125
+ .keyseq{color:rgba(51,51,51,.8)}
126
+ kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
127
+ .keyseq kbd:first-child{margin-left:0}
128
+ .keyseq kbd:last-child{margin-right:0}
129
+ .menuseq,.menuref{color:#000}
130
+ .menuseq b:not(.caret),.menuref{font-weight:inherit}
131
+ .menuseq{word-spacing:-.02em}
132
+ .menuseq b.caret{font-size:1.25em;line-height:.8}
133
+ .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
134
+ b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
135
+ b.button::before{content:"[";padding:0 3px 0 2px}
136
+ b.button::after{content:"]";padding:0 2px 0 3px}
137
+ p a>code:hover{color:rgba(0,0,0,.9)}
138
+ #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
139
+ #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
140
+ #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
141
+ #content{margin-top:1.25em}
142
+ #content::before{content:none}
143
+ #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
144
+ #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
145
+ #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
146
+ #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
147
+ #header .details span:first-child{margin-left:-.125em}
148
+ #header .details span.email a{color:rgba(0,0,0,.85)}
149
+ #header .details br{display:none}
150
+ #header .details br+span::before{content:"\00a0\2013\00a0"}
151
+ #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
152
+ #header .details br+span#revremark::before{content:"\00a0|\00a0"}
153
+ #header #revnumber{text-transform:capitalize}
154
+ #header #revnumber::after{content:"\00a0"}
155
+ #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
156
+ #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
157
+ #toc>ul{margin-left:.125em}
158
+ #toc ul.sectlevel0>li>a{font-style:italic}
159
+ #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
160
+ #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
161
+ #toc li{line-height:1.3334;margin-top:.3334em}
162
+ #toc a{text-decoration:none}
163
+ #toc a:active{text-decoration:underline}
164
+ #toctitle{color:#7a2518;font-size:1.2em}
165
+ @media screen and (min-width:768px){#toctitle{font-size:1.375em}
166
+ body.toc2{padding-left:15em;padding-right:0}
167
+ #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
168
+ #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
169
+ #toc.toc2>ul{font-size:.9em;margin-bottom:0}
170
+ #toc.toc2 ul ul{margin-left:0;padding-left:1em}
171
+ #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
172
+ body.toc2.toc-right{padding-left:0;padding-right:15em}
173
+ body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
174
+ @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
175
+ #toc.toc2{width:20em}
176
+ #toc.toc2 #toctitle{font-size:1.375em}
177
+ #toc.toc2>ul{font-size:.95em}
178
+ #toc.toc2 ul ul{padding-left:1.25em}
179
+ body.toc2.toc-right{padding-left:0;padding-right:20em}}
180
+ #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
181
+ #content #toc>:first-child{margin-top:0}
182
+ #content #toc>:last-child{margin-bottom:0}
183
+ #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
184
+ #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
185
+ #content{margin-bottom:.625em}
186
+ .sect1{padding-bottom:.625em}
187
+ @media screen and (min-width:768px){#content{margin-bottom:1.25em}
188
+ .sect1{padding-bottom:1.25em}}
189
+ .sect1:last-child{padding-bottom:0}
190
+ .sect1+.sect1{border-top:1px solid #e7e7e9}
191
+ #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
192
+ #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
193
+ #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
194
+ #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
195
+ #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
196
+ details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
197
+ details{margin-left:1.25rem}
198
+ details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
199
+ details>summary::-webkit-details-marker{display:none}
200
+ details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
201
+ details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
202
+ details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
203
+ .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
204
+ table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
205
+ .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
206
+ .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
207
+ .admonitionblock>table td.icon{text-align:center;width:80px}
208
+ .admonitionblock>table td.icon img{max-width:none}
209
+ .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
210
+ .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
211
+ .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
212
+ .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
213
+ .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
214
+ .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
215
+ .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
216
+ .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
217
+ .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
218
+ @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
219
+ @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
220
+ .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
221
+ .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
222
+ .listingblock>.content{position:relative}
223
+ .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
224
+ .listingblock:hover code[data-lang]::before{display:block}
225
+ .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
226
+ .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
227
+ .listingblock pre.highlightjs{padding:0}
228
+ .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
229
+ .listingblock pre.prettyprint{border-width:0}
230
+ .prettyprint{background:#f7f7f8}
231
+ pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
232
+ pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
233
+ pre.prettyprint li code[data-lang]::before{opacity:1}
234
+ pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
235
+ table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
236
+ table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
237
+ table.linenotable td.code{padding-left:.75em}
238
+ table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
239
+ pre.pygments span.linenos{display:inline-block;margin-right:.75em}
240
+ .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
241
+ .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
242
+ .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
243
+ .quoteblock blockquote{margin:0;padding:0;border:0}
244
+ .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
245
+ .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
246
+ .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
247
+ .verseblock{margin:0 1em 1.25em}
248
+ .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
249
+ .verseblock pre strong{font-weight:400}
250
+ .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
251
+ .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
252
+ .quoteblock .attribution br,.verseblock .attribution br{display:none}
253
+ .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
254
+ .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
255
+ .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
256
+ .quoteblock.abstract{margin:0 1em 1.25em;display:block}
257
+ .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
258
+ .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
259
+ .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
260
+ .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
261
+ .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
262
+ p.tableblock:last-child{margin-bottom:0}
263
+ td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
264
+ td.tableblock>.content>:last-child{margin-bottom:-1.25em}
265
+ table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
266
+ table.grid-all>*>tr>*{border-width:1px}
267
+ table.grid-cols>*>tr>*{border-width:0 1px}
268
+ table.grid-rows>*>tr>*{border-width:1px 0}
269
+ table.frame-all{border-width:1px}
270
+ table.frame-ends{border-width:1px 0}
271
+ table.frame-sides{border-width:0 1px}
272
+ table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
273
+ table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
274
+ table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
275
+ table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
276
+ table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
277
+ th.halign-left,td.halign-left{text-align:left}
278
+ th.halign-right,td.halign-right{text-align:right}
279
+ th.halign-center,td.halign-center{text-align:center}
280
+ th.valign-top,td.valign-top{vertical-align:top}
281
+ th.valign-bottom,td.valign-bottom{vertical-align:bottom}
282
+ th.valign-middle,td.valign-middle{vertical-align:middle}
283
+ table thead th,table tfoot th{font-weight:bold}
284
+ tbody tr th{background:#f7f8f7}
285
+ tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
286
+ p.tableblock>code:only-child{background:none;padding:0}
287
+ p.tableblock{font-size:1em}
288
+ ol{margin-left:1.75em}
289
+ ul li ol{margin-left:1.5em}
290
+ dl dd{margin-left:1.125em}
291
+ dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
292
+ li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
293
+ ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
294
+ ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
295
+ ul.unstyled,ol.unstyled{margin-left:0}
296
+ li>p:empty:only-child::before{content:"";display:inline-block}
297
+ ul.checklist>li>p:first-child{margin-left:-1em}
298
+ ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
299
+ ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
300
+ ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
301
+ ul.inline>li{margin-left:1.25em}
302
+ .unstyled dl dt{font-weight:400;font-style:normal}
303
+ ol.arabic{list-style-type:decimal}
304
+ ol.decimal{list-style-type:decimal-leading-zero}
305
+ ol.loweralpha{list-style-type:lower-alpha}
306
+ ol.upperalpha{list-style-type:upper-alpha}
307
+ ol.lowerroman{list-style-type:lower-roman}
308
+ ol.upperroman{list-style-type:upper-roman}
309
+ ol.lowergreek{list-style-type:lower-greek}
310
+ .hdlist>table,.colist>table{border:0;background:none}
311
+ .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
312
+ td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
313
+ td.hdlist1{font-weight:bold;padding-bottom:1.25em}
314
+ td.hdlist2{word-wrap:anywhere}
315
+ .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
316
+ .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
317
+ .colist td:not([class]):first-child img{max-width:none}
318
+ .colist td:not([class]):last-child{padding:.25em 0}
319
+ .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
320
+ .imageblock.left{margin:.25em .625em 1.25em 0}
321
+ .imageblock.right{margin:.25em 0 1.25em .625em}
322
+ .imageblock>.title{margin-bottom:0}
323
+ .imageblock.thumb,.imageblock.th{border-width:6px}
324
+ .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
325
+ .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
326
+ .image.left{margin-right:.625em}
327
+ .image.right{margin-left:.625em}
328
+ a.image{text-decoration:none;display:inline-block}
329
+ a.image object{pointer-events:none}
330
+ sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
331
+ sup.footnote a,sup.footnoteref a{text-decoration:none}
332
+ sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
333
+ #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
334
+ #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
335
+ #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
336
+ #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
337
+ #footnotes .footnote:last-of-type{margin-bottom:0}
338
+ #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
339
+ div.unbreakable{page-break-inside:avoid}
340
+ .big{font-size:larger}
341
+ .small{font-size:smaller}
342
+ .underline{text-decoration:underline}
343
+ .overline{text-decoration:overline}
344
+ .line-through{text-decoration:line-through}
345
+ .aqua{color:#00bfbf}
346
+ .aqua-background{background:#00fafa}
347
+ .black{color:#000}
348
+ .black-background{background:#000}
349
+ .blue{color:#0000bf}
350
+ .blue-background{background:#0000fa}
351
+ .fuchsia{color:#bf00bf}
352
+ .fuchsia-background{background:#fa00fa}
353
+ .gray{color:#606060}
354
+ .gray-background{background:#7d7d7d}
355
+ .green{color:#006000}
356
+ .green-background{background:#007d00}
357
+ .lime{color:#00bf00}
358
+ .lime-background{background:#00fa00}
359
+ .maroon{color:#600000}
360
+ .maroon-background{background:#7d0000}
361
+ .navy{color:#000060}
362
+ .navy-background{background:#00007d}
363
+ .olive{color:#606000}
364
+ .olive-background{background:#7d7d00}
365
+ .purple{color:#600060}
366
+ .purple-background{background:#7d007d}
367
+ .red{color:#bf0000}
368
+ .red-background{background:#fa0000}
369
+ .silver{color:#909090}
370
+ .silver-background{background:#bcbcbc}
371
+ .teal{color:#006060}
372
+ .teal-background{background:#007d7d}
373
+ .white{color:#bfbfbf}
374
+ .white-background{background:#fafafa}
375
+ .yellow{color:#bfbf00}
376
+ .yellow-background{background:#fafa00}
377
+ span.icon>.fa{cursor:default}
378
+ a span.icon>.fa{cursor:inherit}
379
+ .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
380
+ .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
381
+ .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
382
+ .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
383
+ .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
384
+ .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
385
+ .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
386
+ .conum[data-value] *{color:#fff!important}
387
+ .conum[data-value]+b{display:none}
388
+ .conum[data-value]::after{content:attr(data-value)}
389
+ pre .conum[data-value]{position:relative;top:-.125em}
390
+ b.conum *{color:inherit!important}
391
+ .conum:not([data-value]):empty{display:none}
392
+ dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
393
+ h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
394
+ p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
395
+ p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
396
+ p{margin-bottom:1.25rem}
397
+ .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
398
+ .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
399
+ .print-only{display:none!important}
400
+ @page{margin:1.25cm .75cm}
401
+ @media print{*{box-shadow:none!important;text-shadow:none!important}
402
+ html{font-size:80%}
403
+ a{color:inherit!important;text-decoration:underline!important}
404
+ a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
405
+ a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
406
+ abbr[title]{border-bottom:1px dotted}
407
+ abbr[title]::after{content:" (" attr(title) ")"}
408
+ pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
409
+ thead{display:table-header-group}
410
+ svg{max-width:100%}
411
+ p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
412
+ h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
413
+ #header,#content,#footnotes,#footer{max-width:none}
414
+ #toc,.sidebarblock,.exampleblock>.content{background:none!important}
415
+ #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
416
+ body.book #header{text-align:center}
417
+ body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
418
+ body.book #header .details{border:0!important;display:block;padding:0!important}
419
+ body.book #header .details span:first-child{margin-left:0!important}
420
+ body.book #header .details br{display:block}
421
+ body.book #header .details br+span::before{content:none!important}
422
+ body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
423
+ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
424
+ .listingblock code[data-lang]::before{display:block}
425
+ #footer{padding:0 .9375em}
426
+ .hide-on-print{display:none!important}
427
+ .print-only{display:block!important}
428
+ .hide-for-print{display:none!important}
429
+ .show-for-print{display:inherit!important}}
430
+ @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
431
+ .sect1{padding:0!important}
432
+ .sect1+.sect1{border:0}
433
+ #footer{background:none}
434
+ #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
435
+ @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
436
+ </style>
437
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
438
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/styles/github.min.css">
439
+ </head>
440
+ <body class="article toc2 toc-left">
441
+ <div id="header">
442
+ <h1>Documentation Style Guide &amp; Lessons Learned</h1>
443
+ <div id="toc" class="toc2">
444
+ <div id="toctitle">Table of Contents</div>
445
+ <ul class="sectlevel1">
446
+ <li><a href="#architectural-patterns">1. Architectural Patterns</a>
447
+ <ul class="sectlevel2">
448
+ <li><a href="#1-centralized-persistence">1.1. 1. Centralized Persistence</a></li>
449
+ <li><a href="#2-event-driven-state">1.2. 2. Event-Driven State</a></li>
450
+ <li><a href="#3-strict-module-interfaces">1.3. 3. Strict Module Interfaces</a></li>
451
+ <li><a href="#entry-point-responsibility">1.4. Entry Point Responsibility</a></li>
452
+ <li><a href="#reference-directory-structure">1.5. Reference Directory Structure</a></li>
453
+ <li><a href="#html-friendly-formatting-standards">1.6. HTML-Friendly Formatting Standards</a></li>
454
+ <li><a href="#single-item-structure-types-enums-interfaces">1.7. Single-Item Structure (Types, Enums, Interfaces)</a></li>
455
+ </ul>
456
+ </li>
457
+ <li><a href="#formatting-guidelines">2. Formatting Guidelines</a>
458
+ <ul class="sectlevel2">
459
+ <li><a href="#asciidoc-features">2.1. AsciiDoc Features</a></li>
460
+ <li><a href="#jsdoc-source-code">2.2. JSDoc (Source Code)</a></li>
461
+ </ul>
462
+ </li>
463
+ <li><a href="#lessons-learned">3. Lessons Learned</a>
464
+ <ul class="sectlevel2">
465
+ <li><a href="#audio-latency">3.1. Audio Latency</a></li>
466
+ <li><a href="#enumerations">3.2. Enumerations</a></li>
467
+ <li><a href="#coordinate-systems">3.3. Coordinate Systems</a></li>
468
+ <li><a href="#decoupled-state-sync">3.4. Decoupled State Sync</a></li>
469
+ <li><a href="#persistence-namespacing">3.5. Persistence Namespacing</a></li>
470
+ <li><a href="#documentation-granularity">3.6. Documentation Granularity</a></li>
471
+ <li><a href="#cross-linking-context">3.7. Cross-Linking Context</a></li>
472
+ <li><a href="#topic-based-scannability">3.8. Topic-Based Scannability</a></li>
473
+ <li><a href="#redundant-separators">3.9. Redundant Separators</a></li>
474
+ <li><a href="#module-interface-organization">3.10. Module Interface Organization</a></li>
475
+ </ul>
476
+ </li>
477
+ <li><a href="#cross-referencing-standards">4. Cross-Referencing Standards</a>
478
+ <ul class="sectlevel2">
479
+ <li><a href="#syntax">4.1. Syntax</a></li>
480
+ <li><a href="#rules">4.2. Rules</a></li>
481
+ <li><a href="#examples">4.3. Examples</a></li>
482
+ </ul>
483
+ </li>
484
+ </ul>
485
+ </div>
486
+ </div>
487
+ <div id="content">
488
+ <div id="preamble">
489
+ <div class="sectionbody">
490
+ <div class="paragraph">
491
+ <p>This document serves as the <strong>authoritative reference</strong> for creating and maintaining documentation in the Brick Engine project. It consolidates lessons learned during development and defines the standards for future contributions.</p>
492
+ </div>
493
+ </div>
494
+ </div>
495
+ <div class="sect1">
496
+ <h2 id="architectural-patterns"><a class="link" href="#architectural-patterns">1. Architectural Patterns</a></h2>
497
+ <div class="sectionbody">
498
+ <div class="paragraph">
499
+ <p>These patterns must be reflected in both the code and the documentation.</p>
500
+ </div>
501
+ <div class="sect2">
502
+ <h3 id="1-centralized-persistence"><a class="link" href="#1-centralized-persistence">1.1. 1. Centralized Persistence</a></h3>
503
+ <div class="ulist">
504
+ <ul>
505
+ <li>
506
+ <p><strong>Principle</strong>: <code>GameState</code> is the <strong>single source of truth</strong> for all persistent data (e.g., <code>muted</code>, <code>highScore</code>, <code>colorEnabled</code>).</p>
507
+ </li>
508
+ <li>
509
+ <p><strong>Rule</strong>: Other modules (e.g., <code>GameSound</code>, <code>GameRenderer</code>) must <strong>NOT</strong> implement their own <code>localStorage</code> logic.</p>
510
+ </li>
511
+ <li>
512
+ <p><strong>Pattern</strong>:</p>
513
+ <div class="olist arabic">
514
+ <ol class="arabic">
515
+ <li>
516
+ <p><strong>Interface</strong>: Modules requiring state must implement <code>StateSyncable</code>.</p>
517
+ </li>
518
+ <li>
519
+ <p><strong>Initialization</strong>: <code>Game.ts</code> iterates over modules and calls <code>syncState(state)</code> on those that implement the interface.</p>
520
+ </li>
521
+ <li>
522
+ <p><strong>Decoupling</strong>: <code>GameState</code> must <strong>NOT</strong> have dependencies on other game modules.</p>
523
+ </li>
524
+ <li>
525
+ <p><strong>Persistence Key</strong>: The <code>Game</code> class must provide a unique key to <code>GameState</code> to prefix all <code>localStorage</code> entries.</p>
526
+ </li>
527
+ <li>
528
+ <p><strong>Updates</strong>: Modules subscribe to <code>GameState</code> changes via <code>state.subscribe()</code>.</p>
529
+ </li>
530
+ </ol>
531
+ </div>
532
+ </li>
533
+ </ul>
534
+ </div>
535
+ </div>
536
+ <div class="sect2">
537
+ <h3 id="2-event-driven-state"><a class="link" href="#2-event-driven-state">1.2. 2. Event-Driven State</a></h3>
538
+ <div class="ulist">
539
+ <ul>
540
+ <li>
541
+ <p><strong>Principle</strong>: Reactivity over polling.</p>
542
+ </li>
543
+ <li>
544
+ <p><strong>Mechanism</strong>:</p>
545
+ </li>
546
+ <li>
547
+ <p>State properties are encapsulated with <strong>getters/setters</strong>.</p>
548
+ </li>
549
+ <li>
550
+ <p>Setters automatically trigger <code>_notify(property, value)</code>.</p>
551
+ </li>
552
+ <li>
553
+ <p>Subscribers receive the new value immediately.</p>
554
+ </li>
555
+ </ul>
556
+ </div>
557
+ </div>
558
+ <div class="sect2">
559
+ <h3 id="3-strict-module-interfaces"><a class="link" href="#3-strict-module-interfaces">1.3. 3. Strict Module Interfaces</a></h3>
560
+ <div class="ulist">
561
+ <ul>
562
+ <li>
563
+ <p><strong>Principle</strong>: Coupling through interfaces, not implementation.</p>
564
+ </li>
565
+ <li>
566
+ <p><strong>Guideline</strong>: Define module shapes in <code>src/core/types/modules.ts</code> (e.g., <code>Sound</code>, <code>Grid</code>, <code>Time</code>).</p>
567
+ </li>
568
+ </ul>
569
+ </div>
570
+ </div>
571
+ <div class="sect2">
572
+ <h3 id="entry-point-responsibility"><a class="link" href="#entry-point-responsibility">1.4. Entry Point Responsibility</a></h3>
573
+ <div class="paragraph">
574
+ <p>The <code>README.adoc</code> is the <strong>main entry point</strong> of the application and contains the "Getting Started" guide.</p>
575
+ </div>
576
+ <div class="paragraph">
577
+ <p><strong>Rule</strong>: Whenever adding new abstract methods to the <code>Game</code> class or making breaking changes to the initialization flow, you <strong>MUST</strong> verify and update the code snippet in <code>README.adoc</code> to ensure it remains a valid boilerplate for developers.</p>
578
+ </div>
579
+ </div>
580
+ <div class="sect2">
581
+ <h3 id="reference-directory-structure"><a class="link" href="#reference-directory-structure">1.5. Reference Directory Structure</a></h3>
582
+ <div class="paragraph">
583
+ <p>To maintain scannability, documentation is organized into specialized subdirectories:
584
+ - <code>modules/</code>: Core engine services (Grid, State, etc.).
585
+ - <code>interfaces/</code>: System contracts and module shapes.
586
+ - <code>enums/</code>: Fixed set of values (Color, Sound, etc.).
587
+ - <code>types/</code>: Data interfaces and composite shapes (Cell, Coordinate, etc.).
588
+ - <code>helpers/</code>: Static utility classes.</p>
589
+ </div>
590
+ </div>
591
+ <div class="sect2">
592
+ <h3 id="html-friendly-formatting-standards"><a class="link" href="#html-friendly-formatting-standards">1.6. HTML-Friendly Formatting Standards</a></h3>
593
+ <div class="paragraph">
594
+ <p>Documentation should be optimized for both internal reading and HTML conversion.</p>
595
+ </div>
596
+ <div class="olist arabic">
597
+ <ol class="arabic">
598
+ <li>
599
+ <p><strong>Mandatory Metadata</strong>: All top-level documentation files must include <code>:description:</code> and <code>:keywords:</code> attributes.</p>
600
+ </li>
601
+ <li>
602
+ <p><strong>Structural Tables</strong>: High-level summaries (such as the list of modules in README) must use tables instead of bullet points.</p>
603
+ <div class="ulist">
604
+ <ul>
605
+ <li>
606
+ <p>Use <code>[cols="1,3", options="header"]</code> for a professional layout.</p>
607
+ </li>
608
+ </ul>
609
+ </div>
610
+ </li>
611
+ <li>
612
+ <p><strong>Cross-Linking</strong>: Every occurrence of a system entity MUST be cross-linked using the <code>xref:</code> macro.</p>
613
+ </li>
614
+ <li>
615
+ <p><strong>Header Attributes</strong>: Use the standard header set to ensure a consistent side-bar TOC and numbered sections:</p>
616
+ <div class="listingblock">
617
+ <div class="content">
618
+ <pre class="highlightjs highlight"><code class="language-asciidoc hljs" data-lang="asciidoc">:toc: left
619
+ :toclevels: 3
620
+ :sectnums:
621
+ :sectlinks:
622
+ :idprefix:
623
+ :idseparator: -</code></pre>
624
+ </div>
625
+ </div>
626
+ <div class="ulist">
627
+ <ul>
628
+ <li>
629
+ <p>Use <code>===</code> for all functional topics within a module&#8217;s API reference.</p>
630
+ </li>
631
+ <li>
632
+ <p><strong>Topic Summaries</strong>: Each topic section should begin with a brief description of its general utility before listing its methods.</p>
633
+ </li>
634
+ <li>
635
+ <p><strong>Method Headers</strong>: Use <code>====</code> for method headers when they are nested under functional topics.</p>
636
+ </li>
637
+ <li>
638
+ <p><strong>Separators</strong>: Place a horizontal rule (<code>'''</code>) before every method/topic header except the first one in a section.</p>
639
+ </li>
640
+ <li>
641
+ <p><strong>Organization Strategy</strong>:</p>
642
+ <div class="ulist">
643
+ <ul>
644
+ <li>
645
+ <p><strong>Simple Modules</strong>: Maintain a flat list of methods using <code>===</code> headers.</p>
646
+ </li>
647
+ <li>
648
+ <p><strong>Complex Modules</strong>: Group methods into logical topics (e.g., "Movement", "Transformations"). This improves scannability when a module exceeds ~10 methods.</p>
649
+ <div class="olist arabic">
650
+ <ol class="arabic">
651
+ <li>
652
+ <p><strong>Parameters</strong>:</p>
653
+ </li>
654
+ </ol>
655
+ </div>
656
+ </li>
657
+ </ul>
658
+ </div>
659
+ </li>
660
+ <li>
661
+ <p>Use a table for arguments.</p>
662
+ </li>
663
+ <li>
664
+ <p><strong>OMIT this section completely</strong> if there are no parameters.</p>
665
+ <div class="olist arabic">
666
+ <ol class="arabic">
667
+ <li>
668
+ <p><strong>Returns</strong>:</p>
669
+ </li>
670
+ </ol>
671
+ </div>
672
+ </li>
673
+ <li>
674
+ <p>Describe the return value.</p>
675
+ </li>
676
+ <li>
677
+ <p><strong>OMIT this section completely</strong> if the return type is <code>void</code>.</p>
678
+ <div class="olist arabic">
679
+ <ol class="arabic">
680
+ <li>
681
+ <p><strong>Behavior</strong>: Use full sentences and paragraphs.</p>
682
+ </li>
683
+ <li>
684
+ <p><strong>Examples</strong>: Provide realistic usage scenarios.</p>
685
+ </li>
686
+ </ol>
687
+ </div>
688
+ </li>
689
+ </ul>
690
+ </div>
691
+ </li>
692
+ </ol>
693
+ </div>
694
+ </div>
695
+ <div class="sect2">
696
+ <h3 id="single-item-structure-types-enums-interfaces"><a class="link" href="#single-item-structure-types-enums-interfaces">1.7. Single-Item Structure (Types, Enums, Interfaces)</a></h3>
697
+ <div class="paragraph">
698
+ <p>For entities that define data shapes or fixed values, use the following structure:</p>
699
+ </div>
700
+ <div class="listingblock">
701
+ <div class="content">
702
+ <pre class="highlightjs highlight"><code class="language-asciidoc hljs" data-lang="asciidoc">= EntityName Reference
703
+
704
+ &lt;Brief description of the entity's purpose and usage.&gt;
705
+
706
+ == Attributes / Properties / Values
707
+
708
+ [cols="1,1,3"]
709
+ |===
710
+ |Name |Type |Description
711
+ |`prop1` |`Type` |Description of property 1.
712
+ |`prop2` |`Type` |Description of property 2.
713
+ |===
714
+
715
+ == General Usage
716
+
717
+ &lt;Detailed explanation of how this entity is used within the engine's ecosystem.&gt;</code></pre>
718
+ </div>
719
+ </div>
720
+ </div>
721
+ </div>
722
+ </div>
723
+ <div class="sect1">
724
+ <h2 id="formatting-guidelines"><a class="link" href="#formatting-guidelines">2. Formatting Guidelines</a></h2>
725
+ <div class="sectionbody">
726
+ <div class="sect2">
727
+ <h3 id="asciidoc-features"><a class="link" href="#asciidoc-features">2.1. AsciiDoc Features</a></h3>
728
+ <div class="paragraph">
729
+ <p>We use <strong>AsciiDoc</strong> (<code>.adoc</code>) for all documentation to leverage advanced features.</p>
730
+ </div>
731
+ <div class="ulist">
732
+ <ul>
733
+ <li>
734
+ <p><strong>Headers</strong>: Use <code>=</code> for document titles, <code>==</code> for sections.</p>
735
+ </li>
736
+ <li>
737
+ <p><strong>Code Blocks</strong>: Use <code>[source,typescript]</code> for syntax highlighting.</p>
738
+ </li>
739
+ <li>
740
+ <p><strong>Admonitions</strong>: Use <code>NOTE:</code>, <code>TIP:</code>, <code>WARNING:</code> for emphasis.</p>
741
+ </li>
742
+ <li>
743
+ <p><strong>Diagrams</strong>: Use Mermaid via <code>mermaid-cli</code> for generation (embedded as generic images).</p>
744
+ </li>
745
+ </ul>
746
+ </div>
747
+ </div>
748
+ <div class="sect2">
749
+ <h3 id="jsdoc-source-code"><a class="link" href="#jsdoc-source-code">2.2. JSDoc (Source Code)</a></h3>
750
+ <div class="paragraph">
751
+ <p>Refer to <code>docs/jsdoc_standard.adoc</code> for inline code documentation rules.
752
+ * <strong>Enforce</strong>: <code>@param</code> and <code>@returns</code> for every method.
753
+ * <strong>Strict Typing</strong>: No <code>any</code>.</p>
754
+ </div>
755
+ </div>
756
+ </div>
757
+ </div>
758
+ <div class="sect1">
759
+ <h2 id="lessons-learned"><a class="link" href="#lessons-learned">3. Lessons Learned</a></h2>
760
+ <div class="sectionbody">
761
+ <div class="sect2">
762
+ <h3 id="audio-latency"><a class="link" href="#audio-latency">3.1. Audio Latency</a></h3>
763
+ <div class="ulist">
764
+ <ul>
765
+ <li>
766
+ <p><strong>Issue</strong>: <code>AudioContext</code> autoplay policy and startup latency.</p>
767
+ </li>
768
+ <li>
769
+ <p><strong>Solution</strong>:</p>
770
+ <div class="olist arabic">
771
+ <ol class="arabic">
772
+ <li>
773
+ <p>Use <code>latencyHint: 'interactive'</code>.</p>
774
+ </li>
775
+ <li>
776
+ <p>Preload all sounds into <code>AudioBuffer`s during `setup()</code>.</p>
777
+ </li>
778
+ <li>
779
+ <p>Resume context on first user interaction if suspended.</p>
780
+ </li>
781
+ </ol>
782
+ </div>
783
+ </li>
784
+ </ul>
785
+ </div>
786
+ </div>
787
+ <div class="sect2">
788
+ <h3 id="enumerations"><a class="link" href="#enumerations">3.2. Enumerations</a></h3>
789
+ <div class="ulist">
790
+ <ul>
791
+ <li>
792
+ <p><strong>Issue</strong>: String literals ('pressed', 'held') caused typos and refactoring pain.</p>
793
+ </li>
794
+ <li>
795
+ <p><strong>Solution</strong>: Use TypeScript <code>enum</code> (e.g., <code>ControlEventType</code>) for all fixed sets of values.</p>
796
+ </li>
797
+ </ul>
798
+ </div>
799
+ </div>
800
+ <div class="sect2">
801
+ <h3 id="coordinate-systems"><a class="link" href="#coordinate-systems">3.3. Coordinate Systems</a></h3>
802
+ <div class="ulist">
803
+ <ul>
804
+ <li>
805
+ <p><strong>Standard</strong>:</p>
806
+ </li>
807
+ <li>
808
+ <p><strong>Grid</strong>: Integers <code>{x, y}</code> representing column/row index.</p>
809
+ </li>
810
+ <li>
811
+ <p><strong>Display</strong>: Normalized floats <code>0.0</code> to <code>1.0</code> (percentage of screen).</p>
812
+ </li>
813
+ <li>
814
+ <p>Use <code>CoordinateHelper</code> methods to convert between Grid, Display, and Pixel values.</p>
815
+ </li>
816
+ </ul>
817
+ </div>
818
+ </div>
819
+ <div class="sect2">
820
+ <h3 id="decoupled-state-sync"><a class="link" href="#decoupled-state-sync">3.4. Decoupled State Sync</a></h3>
821
+ <div class="ulist">
822
+ <ul>
823
+ <li>
824
+ <p><strong>Issue</strong>: <code>GameState.syncModules</code> creates a circular dependency or high coupling by making the state module know about every other module.</p>
825
+ </li>
826
+ <li>
827
+ <p><strong>Solution</strong>: Use the <code>StateSyncable</code> interface. The <code>Game</code> class (owner) handles the linking, allowing <code>GameState</code> to remain an independent "data store" module.</p>
828
+ </li>
829
+ </ul>
830
+ </div>
831
+ </div>
832
+ <div class="sect2">
833
+ <h3 id="persistence-namespacing"><a class="link" href="#persistence-namespacing">3.5. Persistence Namespacing</a></h3>
834
+ <div class="ulist">
835
+ <ul>
836
+ <li>
837
+ <p><strong>Issue</strong>: If multiple games built with the engine are hosted on the same domain, they share the same <code>localStorage</code>, leading to property collisions (e.g., both games trying to store <code>highScore</code>).</p>
838
+ </li>
839
+ <li>
840
+ <p><strong>Solution</strong>: Require an abstract <code>getPersistenceKey()</code> method in the <code>Game</code> class and use its return value as a prefix in <code>GameState</code> (e.g., <code>localStorage.setItem(</code>${prefix}.${key}`, value)`).</p>
841
+ </li>
842
+ </ul>
843
+ </div>
844
+ </div>
845
+ <div class="sect2">
846
+ <h3 id="documentation-granularity"><a class="link" href="#documentation-granularity">3.6. Documentation Granularity</a></h3>
847
+ <div class="ulist">
848
+ <ul>
849
+ <li>
850
+ <p><strong>Issue</strong>: Grouping multiple types or enums in a single file makes the documentation harder to navigate via sidebars or search, and leads to extremely long pages.</p>
851
+ </li>
852
+ <li>
853
+ <p><strong>Solution</strong>: "Explode" documentation into individual files (One File Per Item). This improves scannability and allows for precise cross-referencing.</p>
854
+ </li>
855
+ </ul>
856
+ </div>
857
+ </div>
858
+ <div class="sect2">
859
+ <h3 id="cross-linking-context"><a class="link" href="#cross-linking-context">3.7. Cross-Linking Context</a></h3>
860
+ <div class="ulist">
861
+ <ul>
862
+ <li>
863
+ <p><strong>Recommendation</strong>: When referencing an entity in a table (e.g., a return type or parameter type), always use an <code>xref:</code> link to its dedicated documentation page.</p>
864
+ </li>
865
+ <li>
866
+ <p><strong>Pattern</strong>: Use relative paths (e.g., <code><a href="../enums/Color.html">Color</a></code>) to link between subdirectories.</p>
867
+ </li>
868
+ </ul>
869
+ </div>
870
+ </div>
871
+ <div class="sect2">
872
+ <h3 id="topic-based-scannability"><a class="link" href="#topic-based-scannability">3.8. Topic-Based Scannability</a></h3>
873
+ <div class="ulist">
874
+ <ul>
875
+ <li>
876
+ <p><strong>Issue</strong>: Modules with many methods (e.g., <code>GameGrid</code>) become "walls of text" when documented as a single flat list, making it hard for developers to find specific functionality.</p>
877
+ </li>
878
+ <li>
879
+ <p><strong>Solution</strong>: Group methods by functional topics (e.g., "Line Management", "Grid Analysis"). Each topic acts as a sub-module view, providing context on why those methods exist together.</p>
880
+ </li>
881
+ <li>
882
+ <p><strong>Rule</strong>: When a module exceeds 10 methods, transitioning to a topic-based structure is <strong>mandatory</strong>.</p>
883
+ </li>
884
+ </ul>
885
+ </div>
886
+ </div>
887
+ <div class="sect2">
888
+ <h3 id="redundant-separators"><a class="link" href="#redundant-separators">3.9. Redundant Separators</a></h3>
889
+ <div class="ulist">
890
+ <ul>
891
+ <li>
892
+ <p><strong>Issue</strong>: Automated or careless application of the "expanded method" style often leads to placing a horizontal rule (<code>'''</code>) at the very beginning of the <code>== Methods</code> section.</p>
893
+ </li>
894
+ <li>
895
+ <p><strong>Solution</strong>: Always verify that the first method header appears immediately after the section header. This maintains a clean vertical rhythm and avoids unnecessary whitespace or lines at the top of the API list.</p>
896
+ </li>
897
+ </ul>
898
+ </div>
899
+ </div>
900
+ <div class="sect2">
901
+ <h3 id="module-interface-organization"><a class="link" href="#module-interface-organization">3.10. Module Interface Organization</a></h3>
902
+ <div class="ulist">
903
+ <ul>
904
+ <li>
905
+ <p><strong>Issue</strong>: Mixing generic engine contracts (e.g., <code>Initializable</code>) with specific module definitions (e.g., <code>Grid</code>, <code>State</code>) in a flat directory structure created clutter and obscured the architectural distinction between "core traits" and "major subsystems."</p>
906
+ </li>
907
+ <li>
908
+ <p><strong>Solution</strong>: Moved module-specific interfaces to a dedicated <code>modules/</code> subdirectory.</p>
909
+ </li>
910
+ <li>
911
+ <p><strong>Impact</strong>: When cross-referencing files in nested directories, developers must pay extra attention to relative paths (e.g., using <code>xref:../../types/</code> instead of <code>xref:../types/</code>).</p>
912
+ </li>
913
+ </ul>
914
+ </div>
915
+ </div>
916
+ </div>
917
+ </div>
918
+ <div class="sect1">
919
+ <h2 id="cross-referencing-standards"><a class="link" href="#cross-referencing-standards">4. Cross-Referencing Standards</a></h2>
920
+ <div class="sectionbody">
921
+ <div class="paragraph">
922
+ <p>To ensure a navigable and cohesive documentation set, strict cross-referencing is mandatory for all internal entities.</p>
923
+ </div>
924
+ <div class="sect2">
925
+ <h3 id="syntax"><a class="link" href="#syntax">4.1. Syntax</a></h3>
926
+ <div class="paragraph">
927
+ <p>Use the AsciiDoc <code>xref</code> macro with relative paths:
928
+ <code><a href="path/to/File.html">LinkText</a></code></p>
929
+ </div>
930
+ </div>
931
+ <div class="sect2">
932
+ <h3 id="rules"><a class="link" href="#rules">4.2. Rules</a></h3>
933
+ <div class="olist arabic">
934
+ <ol class="arabic">
935
+ <li>
936
+ <p><strong>Mandatory Linking</strong>: Every occurrence of a type, interface, enum, or module in a method signature, property type, or description MUST be linked.</p>
937
+ </li>
938
+ <li>
939
+ <p><strong>Relative Paths</strong>: references must use relative paths from the current file&#8217;s location.</p>
940
+ <div class="ulist">
941
+ <ul>
942
+ <li>
943
+ <p>Sibling file: <code><a href="Sibling.html">Sibling</a></code></p>
944
+ </li>
945
+ <li>
946
+ <p>Parent directory: <code><a href="../types/Cell.html">Cell</a></code></p>
947
+ </li>
948
+ </ul>
949
+ </div>
950
+ </li>
951
+ <li>
952
+ <p><strong>Parameter Tables</strong>: Types listed in input/output tables must be linked, not just the text in the method signature.</p>
953
+ </li>
954
+ <li>
955
+ <p><strong>Consistency</strong>: exact file names should be used for the link target, and the link text should match the entity name.</p>
956
+ </li>
957
+ </ol>
958
+ </div>
959
+ </div>
960
+ <div class="sect2">
961
+ <h3 id="examples"><a class="link" href="#examples">4.3. Examples</a></h3>
962
+ <div class="paragraph">
963
+ <p><strong>Good:</strong></p>
964
+ </div>
965
+ <div class="listingblock">
966
+ <div class="content">
967
+ <pre class="highlightjs highlight"><code class="language-asciidoc hljs" data-lang="asciidoc">|`color` |`xref:../enums/Color.adoc[Color]` |The theme color.</code></pre>
968
+ </div>
969
+ </div>
970
+ <div class="paragraph">
971
+ <p><strong>Bad:</strong></p>
972
+ </div>
973
+ <div class="listingblock">
974
+ <div class="content">
975
+ <pre class="highlightjs highlight"><code class="language-asciidoc hljs" data-lang="asciidoc">|`color` |`Color` |The theme color.</code></pre>
976
+ </div>
977
+ </div>
978
+ </div>
979
+ </div>
980
+ </div>
981
+ </div>
982
+ <div id="footer">
983
+ <div id="footer-text">
984
+ </div>
985
+ </div>
986
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
987
+ <script>
988
+ if (!hljs.initHighlighting.called) {
989
+ hljs.initHighlighting.called = true
990
+ ;[].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) { hljs.highlightBlock(el) })
991
+ }
992
+ </script>
993
+ </body>
994
+ </html>