brick-engine-js 1.0.1 → 1.0.2

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 (225) hide show
  1. package/dist/docs/GAME_DEVELOPER_GUIDE.html +1 -1
  2. package/dist/docs/brick-engine-guide.html +1 -1
  3. package/dist/docs/getting-started.html +1 -1
  4. package/dist/docs/jsdoc_standard.html +1 -1
  5. package/dist/docs/publishing.html +1 -1
  6. package/dist/docs/reference/interfaces/modules/Session.html +1 -1
  7. package/dist/docs/reference/modules/GameMenu.html +1 -1
  8. package/dist/docs/reference/modules/GameSession.html +1 -1
  9. package/dist/docs/reference/modules/InitialStateSnapshot.html +1 -1
  10. package/dist/docs/reference/modules/SessionModal.html +1 -1
  11. package/dist/docs/testing_best_practices.html +1 -1
  12. package/package.json +7 -1
  13. package/.env.local.example +0 -2
  14. package/.github/workflows/publish.yml +0 -73
  15. package/.prettierignore +0 -2
  16. package/.prettierrc.json +0 -8
  17. package/eslint.config.mjs +0 -29
  18. package/public/CNAME +0 -1
  19. package/public/docs/GAME_DEVELOPER_GUIDE.html +0 -727
  20. package/public/docs/brick-engine-guide.html +0 -610
  21. package/public/docs/diagrams/lifecycle.mmd +0 -19
  22. package/public/docs/documentation_style_guide.html +0 -994
  23. package/public/docs/getting-started.html +0 -648
  24. package/public/docs/images/lifecycle.svg +0 -1
  25. package/public/docs/index.html +0 -593
  26. package/public/docs/jsdoc_standard.html +0 -656
  27. package/public/docs/publishing.html +0 -573
  28. package/public/docs/reference/enums/Color.html +0 -533
  29. package/public/docs/reference/enums/ControlEventType.html +0 -505
  30. package/public/docs/reference/enums/ControlKey.html +0 -529
  31. package/public/docs/reference/enums/FontAlignment.html +0 -545
  32. package/public/docs/reference/enums/FontSize.html +0 -517
  33. package/public/docs/reference/enums/Sound.html +0 -558
  34. package/public/docs/reference/enums/StateProperty.html +0 -525
  35. package/public/docs/reference/helpers/CellHelper.html +0 -520
  36. package/public/docs/reference/helpers/ControlInputHandlerHelper.html +0 -569
  37. package/public/docs/reference/helpers/CoordinateHelper.html +0 -703
  38. package/public/docs/reference/helpers/RelativeValuesHelper.html +0 -560
  39. package/public/docs/reference/interfaces/Debuggable.html +0 -501
  40. package/public/docs/reference/interfaces/GameModules.html +0 -544
  41. package/public/docs/reference/interfaces/Initializable.html +0 -495
  42. package/public/docs/reference/interfaces/RendererInitializable.html +0 -517
  43. package/public/docs/reference/interfaces/StateSyncable.html +0 -542
  44. package/public/docs/reference/interfaces/modules/Control.html +0 -648
  45. package/public/docs/reference/interfaces/modules/Grid.html +0 -1256
  46. package/public/docs/reference/interfaces/modules/Renderer.html +0 -522
  47. package/public/docs/reference/interfaces/modules/RendererComposite.html +0 -577
  48. package/public/docs/reference/interfaces/modules/Score.html +0 -669
  49. package/public/docs/reference/interfaces/modules/Session.html +0 -585
  50. package/public/docs/reference/interfaces/modules/State.html +0 -897
  51. package/public/docs/reference/interfaces/modules/Text.html +0 -668
  52. package/public/docs/reference/interfaces/modules/Time.html +0 -684
  53. package/public/docs/reference/modules/Debugger.html +0 -579
  54. package/public/docs/reference/modules/DisplayRenderer.html +0 -557
  55. package/public/docs/reference/modules/Game.html +0 -909
  56. package/public/docs/reference/modules/GameControl.html +0 -716
  57. package/public/docs/reference/modules/GameGrid.html +0 -1910
  58. package/public/docs/reference/modules/GameHudGrid.html +0 -508
  59. package/public/docs/reference/modules/GameMenu.html +0 -538
  60. package/public/docs/reference/modules/GameRenderer.html +0 -589
  61. package/public/docs/reference/modules/GameScore.html +0 -664
  62. package/public/docs/reference/modules/GameSession.html +0 -533
  63. package/public/docs/reference/modules/GameSound.html +0 -636
  64. package/public/docs/reference/modules/GameState.html +0 -922
  65. package/public/docs/reference/modules/GameText.html +0 -701
  66. package/public/docs/reference/modules/GameTime.html +0 -696
  67. package/public/docs/reference/modules/HudRenderer.html +0 -568
  68. package/public/docs/reference/modules/InitialStateSnapshot.html +0 -557
  69. package/public/docs/reference/modules/SessionModal.html +0 -520
  70. package/public/docs/reference/types/Axis.html +0 -505
  71. package/public/docs/reference/types/Cell.html +0 -514
  72. package/public/docs/reference/types/ControlCallback.html +0 -488
  73. package/public/docs/reference/types/Coordinate.html +0 -510
  74. package/public/docs/reference/types/GameEntry.html +0 -514
  75. package/public/docs/reference/types/GameEvent.html +0 -514
  76. package/public/docs/reference/types/Piece.html +0 -506
  77. package/public/docs/reference/types/RendererMetrics.html +0 -514
  78. package/public/docs/reference/types/Vector.html +0 -509
  79. package/public/docs/testing_best_practices.html +0 -770
  80. package/public/favicon.ico +0 -0
  81. package/public/fonts/digital-7.monoitalic.ttf +0 -0
  82. package/public/images/cell.svg +0 -32
  83. package/public/images/close.png +0 -0
  84. package/public/images/games.png +0 -0
  85. package/public/images/github.png +0 -0
  86. package/public/images/letter-a.png +0 -0
  87. package/public/images/letter-d.png +0 -0
  88. package/public/images/letter-j.png +0 -0
  89. package/public/images/letter-s.png +0 -0
  90. package/public/images/letter-w.png +0 -0
  91. package/public/images/meta-image.png +0 -0
  92. package/public/images/number-1.png +0 -0
  93. package/public/images/number-2.png +0 -0
  94. package/public/images/number-3.png +0 -0
  95. package/public/images/number-4.png +0 -0
  96. package/public/images/number-5.png +0 -0
  97. package/public/images/number-6.png +0 -0
  98. package/public/images/splash.gif +0 -0
  99. package/public/index.html +0 -15
  100. package/public/sounds/sound_00.wav +0 -0
  101. package/public/sounds/sound_01.wav +0 -0
  102. package/public/sounds/sound_02.wav +0 -0
  103. package/public/sounds/sound_03.wav +0 -0
  104. package/public/sounds/sound_04.wav +0 -0
  105. package/public/sounds/sound_05.wav +0 -0
  106. package/public/sounds/sound_06.wav +0 -0
  107. package/public/sounds/sound_07.wav +0 -0
  108. package/public/sounds/sound_08.wav +0 -0
  109. package/public/sounds/sound_09.wav +0 -0
  110. package/public/sounds/sound_10.wav +0 -0
  111. package/public/sounds/sound_11.wav +0 -0
  112. package/public/sounds/sound_12.wav +0 -0
  113. package/public/sounds/sound_13.wav +0 -0
  114. package/public/sounds/sound_14.wav +0 -0
  115. package/public/sounds/sound_15.wav +0 -0
  116. package/public/style/body.css +0 -86
  117. package/public/style/buttons.css +0 -233
  118. package/public/style/debugger.css +0 -117
  119. package/public/style/sessionModal.css +0 -155
  120. package/public/style/sourceCodeAndCommands.css +0 -74
  121. package/public/style/splash.css +0 -13
  122. package/public/style/theme.css +0 -137
  123. package/scripts/generate-diagrams.sh +0 -20
  124. package/scripts/generate-docs.js +0 -111
  125. package/src/client-game.d.ts +0 -1
  126. package/src/config/configs.test.ts +0 -20
  127. package/src/config/configs.ts +0 -197
  128. package/src/config/env.test.ts +0 -59
  129. package/src/config/env.ts +0 -7
  130. package/src/config/styles.ts +0 -5
  131. package/src/core/Game.test.ts +0 -167
  132. package/src/core/Game.ts +0 -307
  133. package/src/core/InitialStateSnapshot.test.ts +0 -51
  134. package/src/core/InitialStateSnapshot.ts +0 -46
  135. package/src/core/helpers/CellHelper.test.ts +0 -33
  136. package/src/core/helpers/CellHelper.ts +0 -21
  137. package/src/core/helpers/ControlInputHandlerHelper.test.ts +0 -116
  138. package/src/core/helpers/ControlInputHandlerHelper.ts +0 -68
  139. package/src/core/helpers/CoordinateHelper.test.ts +0 -113
  140. package/src/core/helpers/CoordinateHelper.ts +0 -82
  141. package/src/core/helpers/InterfaceIdentifierHelper.test.ts +0 -122
  142. package/src/core/helpers/InterfaceIdentifierHelper.ts +0 -43
  143. package/src/core/helpers/RelativeValuesHelper.test.ts +0 -47
  144. package/src/core/helpers/RelativeValuesHelper.ts +0 -29
  145. package/src/core/module/control/GameControl.test.ts +0 -82
  146. package/src/core/module/control/GameControl.ts +0 -142
  147. package/src/core/module/control/GameControlKeyBinding.test.ts +0 -59
  148. package/src/core/module/control/GameControlKeyBinding.ts +0 -92
  149. package/src/core/module/grid/GameGrid.test.ts +0 -83
  150. package/src/core/module/grid/GameGrid.ts +0 -610
  151. package/src/core/module/grid/GameHudGrid.test.ts +0 -22
  152. package/src/core/module/grid/GameHudGrid.ts +0 -40
  153. package/src/core/module/grid/engines/GridAnalysisEngine.test.ts +0 -157
  154. package/src/core/module/grid/engines/GridAnalysisEngine.ts +0 -124
  155. package/src/core/module/grid/engines/GridLineEngine.test.ts +0 -132
  156. package/src/core/module/grid/engines/GridLineEngine.ts +0 -165
  157. package/src/core/module/grid/engines/GridMovementEngine.test.ts +0 -125
  158. package/src/core/module/grid/engines/GridMovementEngine.ts +0 -113
  159. package/src/core/module/grid/engines/GridRegionEngine.test.ts +0 -136
  160. package/src/core/module/grid/engines/GridRegionEngine.ts +0 -52
  161. package/src/core/module/grid/engines/GridTransformEngine.test.ts +0 -98
  162. package/src/core/module/grid/engines/GridTransformEngine.ts +0 -70
  163. package/src/core/module/renderer/DisplayRenderer.test.ts +0 -86
  164. package/src/core/module/renderer/DisplayRenderer.ts +0 -152
  165. package/src/core/module/renderer/GameRenderer.test.ts +0 -103
  166. package/src/core/module/renderer/GameRenderer.ts +0 -144
  167. package/src/core/module/renderer/HudRenderer.test.ts +0 -108
  168. package/src/core/module/renderer/HudRenderer.ts +0 -203
  169. package/src/core/module/score/GameScore.test.ts +0 -71
  170. package/src/core/module/score/GameScore.ts +0 -188
  171. package/src/core/module/session/GameSession.test.ts +0 -176
  172. package/src/core/module/session/GameSession.ts +0 -103
  173. package/src/core/module/sound/GameSound.test.ts +0 -117
  174. package/src/core/module/sound/GameSound.ts +0 -229
  175. package/src/core/module/state/GameState.test.ts +0 -101
  176. package/src/core/module/state/GameState.ts +0 -339
  177. package/src/core/module/text/GameText.test.ts +0 -87
  178. package/src/core/module/text/GameText.ts +0 -150
  179. package/src/core/module/time/GameTime.test.ts +0 -86
  180. package/src/core/module/time/GameTime.ts +0 -144
  181. package/src/core/types/Interfaces.ts +0 -59
  182. package/src/core/types/Types.ts +0 -124
  183. package/src/core/types/enums.ts +0 -113
  184. package/src/core/types/modules.ts +0 -841
  185. package/src/index.test.ts +0 -15
  186. package/src/index.ts +0 -9
  187. package/src/main.test.ts +0 -137
  188. package/src/main.ts +0 -77
  189. package/src/menu/GameMenu.test.ts +0 -157
  190. package/src/menu/GameMenu.ts +0 -124
  191. package/src/menu/GameMenuSingleton.test.ts +0 -26
  192. package/src/menu/GameMenuSingleton.ts +0 -13
  193. package/src/menu/GameRepository.test.ts +0 -46
  194. package/src/menu/GameRepository.ts +0 -47
  195. package/src/menu/manager/GameManager.test.ts +0 -68
  196. package/src/menu/manager/GameManager.ts +0 -50
  197. package/src/types/global.d.ts +0 -8
  198. package/src/types/interfaces.ts +0 -5
  199. package/src/view/Debugger.test.ts +0 -152
  200. package/src/view/Debugger.ts +0 -124
  201. package/src/view/GameView.test.ts +0 -95
  202. package/src/view/GameView.ts +0 -244
  203. package/src/view/SessionModal.test.ts +0 -141
  204. package/src/view/SessionModal.ts +0 -73
  205. package/src/view/components/layout/ButtonLayout.test.ts +0 -28
  206. package/src/view/components/layout/ButtonLayout.ts +0 -63
  207. package/src/view/components/layout/ContainerLayout.test.ts +0 -48
  208. package/src/view/components/layout/ContainerLayout.ts +0 -50
  209. package/src/view/components/layout/FrameLayout.test.ts +0 -24
  210. package/src/view/components/layout/FrameLayout.ts +0 -25
  211. package/src/view/components/ui/BigButton.test.ts +0 -28
  212. package/src/view/components/ui/BigButton.ts +0 -31
  213. package/src/view/components/ui/Button.test.ts +0 -30
  214. package/src/view/components/ui/Button.ts +0 -30
  215. package/src/view/components/ui/Canvas.test.ts +0 -32
  216. package/src/view/components/ui/Canvas.ts +0 -34
  217. package/src/view/components/ui/SmallButton.test.ts +0 -48
  218. package/src/view/components/ui/SmallButton.ts +0 -32
  219. package/src/view/theme/applyColors.test.ts +0 -47
  220. package/src/view/theme/applyColors.ts +0 -38
  221. package/src/view/theme/dimensions.test.ts +0 -34
  222. package/src/view/theme/dimensions.ts +0 -53
  223. package/tsconfig.json +0 -16
  224. package/vitest.config.ts +0 -14
  225. package/webpack.config.js +0 -133
package/public/docs/getting-started.html DELETED
@@ -1,648 +0,0 @@
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="Detailed instructions for setting up and building games with the Brick Engine.">
9
- <title>Getting Started Guide</title>
10
- <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">
11
- <style>
12
- /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
13
- /* Uncomment the following line when using as a custom stylesheet */
14
- /* @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"; */
15
- html{font-family:sans-serif;-webkit-text-size-adjust:100%}
16
- a{background:none}
17
- a:focus{outline:thin dotted}
18
- a:active,a:hover{outline:0}
19
- h1{font-size:2em;margin:.67em 0}
20
- b,strong{font-weight:bold}
21
- abbr{font-size:.9em}
22
- abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
23
- dfn{font-style:italic}
24
- hr{height:0}
25
- mark{background:#ff0;color:#000}
26
- code,kbd,pre,samp{font-family:monospace;font-size:1em}
27
- pre{white-space:pre-wrap}
28
- q{quotes:"\201C" "\201D" "\2018" "\2019"}
29
- small{font-size:80%}
30
- sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
31
- sup{top:-.5em}
32
- sub{bottom:-.25em}
33
- img{border:0}
34
- svg:not(:root){overflow:hidden}
35
- figure{margin:0}
36
- audio,video{display:inline-block}
37
- audio:not([controls]){display:none;height:0}
38
- fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
39
- legend{border:0;padding:0}
40
- button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
41
- button,input{line-height:normal}
42
- button,select{text-transform:none}
43
- button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
44
- button[disabled],html input[disabled]{cursor:default}
45
- input[type=checkbox],input[type=radio]{padding:0}
46
- button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
47
- textarea{overflow:auto;vertical-align:top}
48
- table{border-collapse:collapse;border-spacing:0}
49
- *,::before,::after{box-sizing:border-box}
50
- html,body{font-size:100%}
51
- 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}
52
- a:hover{cursor:pointer}
53
- img,object,embed{max-width:100%;height:auto}
54
- object,embed{height:100%}
55
- img{-ms-interpolation-mode:bicubic}
56
- .left{float:left!important}
57
- .right{float:right!important}
58
- .text-left{text-align:left!important}
59
- .text-right{text-align:right!important}
60
- .text-center{text-align:center!important}
61
- .text-justify{text-align:justify!important}
62
- .hide{display:none}
63
- img,object,svg{display:inline-block;vertical-align:middle}
64
- textarea{height:auto;min-height:50px}
65
- select{width:100%}
66
- .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}
67
- 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}
68
- a{color:#2156a5;text-decoration:underline;line-height:inherit}
69
- a:hover,a:focus{color:#1d4b8f}
70
- a img{border:0}
71
- p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
72
- p aside{font-size:.875em;line-height:1.35;font-style:italic}
73
- 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}
74
- 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}
75
- h1{font-size:2.125em}
76
- h2{font-size:1.6875em}
77
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
78
- h4,h5{font-size:1.125em}
79
- h6{font-size:1em}
80
- hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
81
- em,i{font-style:italic;line-height:inherit}
82
- strong,b{font-weight:bold;line-height:inherit}
83
- small{font-size:60%;line-height:inherit}
84
- code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
85
- ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
86
- ul,ol{margin-left:1.5em}
87
- ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
88
- ul.circle{list-style-type:circle}
89
- ul.disc{list-style-type:disc}
90
- ul.square{list-style-type:square}
91
- ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
92
- ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
93
- dl dt{margin-bottom:.3125em;font-weight:bold}
94
- dl dd{margin-bottom:1.25em}
95
- blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
96
- blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
97
- @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
98
- h1{font-size:2.75em}
99
- h2{font-size:2.3125em}
100
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
101
- h4{font-size:1.4375em}}
102
- table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
103
- table thead,table tfoot{background:#f7f8f7}
104
- 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}
105
- table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
106
- table tr.even,table tr.alt{background:#f8f8f7}
107
- table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
108
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
109
- h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
110
- .center{margin-left:auto;margin-right:auto}
111
- .stretch{width:100%}
112
- .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
113
- .clearfix::after,.float-group::after{clear:both}
114
- :not(pre).nobreak{word-wrap:normal}
115
- :not(pre).nowrap{white-space:nowrap}
116
- :not(pre).pre-wrap{white-space:pre-wrap}
117
- :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}
118
- pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
119
- pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
120
- pre>code{display:block}
121
- pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
122
- em em{font-style:normal}
123
- strong strong{font-weight:400}
124
- .keyseq{color:rgba(51,51,51,.8)}
125
- 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}
126
- .keyseq kbd:first-child{margin-left:0}
127
- .keyseq kbd:last-child{margin-right:0}
128
- .menuseq,.menuref{color:#000}
129
- .menuseq b:not(.caret),.menuref{font-weight:inherit}
130
- .menuseq{word-spacing:-.02em}
131
- .menuseq b.caret{font-size:1.25em;line-height:.8}
132
- .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
133
- b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
134
- b.button::before{content:"[";padding:0 3px 0 2px}
135
- b.button::after{content:"]";padding:0 2px 0 3px}
136
- p a>code:hover{color:rgba(0,0,0,.9)}
137
- #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
138
- #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
139
- #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
140
- #content{margin-top:1.25em}
141
- #content::before{content:none}
142
- #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
143
- #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
144
- #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
145
- #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}
146
- #header .details span:first-child{margin-left:-.125em}
147
- #header .details span.email a{color:rgba(0,0,0,.85)}
148
- #header .details br{display:none}
149
- #header .details br+span::before{content:"\00a0\2013\00a0"}
150
- #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
151
- #header .details br+span#revremark::before{content:"\00a0|\00a0"}
152
- #header #revnumber{text-transform:capitalize}
153
- #header #revnumber::after{content:"\00a0"}
154
- #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}
155
- #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
156
- #toc>ul{margin-left:.125em}
157
- #toc ul.sectlevel0>li>a{font-style:italic}
158
- #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
159
- #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
160
- #toc li{line-height:1.3334;margin-top:.3334em}
161
- #toc a{text-decoration:none}
162
- #toc a:active{text-decoration:underline}
163
- #toctitle{color:#7a2518;font-size:1.2em}
164
- @media screen and (min-width:768px){#toctitle{font-size:1.375em}
165
- body.toc2{padding-left:15em;padding-right:0}
166
- #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}
167
- #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
168
- #toc.toc2>ul{font-size:.9em;margin-bottom:0}
169
- #toc.toc2 ul ul{margin-left:0;padding-left:1em}
170
- #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
171
- body.toc2.toc-right{padding-left:0;padding-right:15em}
172
- body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
173
- @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
174
- #toc.toc2{width:20em}
175
- #toc.toc2 #toctitle{font-size:1.375em}
176
- #toc.toc2>ul{font-size:.95em}
177
- #toc.toc2 ul ul{padding-left:1.25em}
178
- body.toc2.toc-right{padding-left:0;padding-right:20em}}
179
- #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
180
- #content #toc>:first-child{margin-top:0}
181
- #content #toc>:last-child{margin-bottom:0}
182
- #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
183
- #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
184
- #content{margin-bottom:.625em}
185
- .sect1{padding-bottom:.625em}
186
- @media screen and (min-width:768px){#content{margin-bottom:1.25em}
187
- .sect1{padding-bottom:1.25em}}
188
- .sect1:last-child{padding-bottom:0}
189
- .sect1+.sect1{border-top:1px solid #e7e7e9}
190
- #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}
191
- #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}
192
- #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}
193
- #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}
194
- #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}
195
- details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
196
- details{margin-left:1.25rem}
197
- details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
198
- details>summary::-webkit-details-marker{display:none}
199
- 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%)}
200
- details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
201
- details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
202
- .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}
203
- table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
204
- .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)}
205
- .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
206
- .admonitionblock>table td.icon{text-align:center;width:80px}
207
- .admonitionblock>table td.icon img{max-width:none}
208
- .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
209
- .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}
210
- .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211
- .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
212
- .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
213
- .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214
- .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
215
- .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}
216
- .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
217
- @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
218
- @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
219
- .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
220
- .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
221
- .listingblock>.content{position:relative}
222
- .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}
223
- .listingblock:hover code[data-lang]::before{display:block}
224
- .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
225
- .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
226
- .listingblock pre.highlightjs{padding:0}
227
- .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
228
- .listingblock pre.prettyprint{border-width:0}
229
- .prettyprint{background:#f7f7f8}
230
- pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
231
- pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
232
- pre.prettyprint li code[data-lang]::before{opacity:1}
233
- pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
234
- table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
235
- table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
236
- table.linenotable td.code{padding-left:.75em}
237
- 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}
238
- pre.pygments span.linenos{display:inline-block;margin-right:.75em}
239
- .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
240
- .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
241
- .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}
242
- .quoteblock blockquote{margin:0;padding:0;border:0}
243
- .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)}
244
- .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
245
- .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
246
- .verseblock{margin:0 1em 1.25em}
247
- .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}
248
- .verseblock pre strong{font-weight:400}
249
- .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250
- .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251
- .quoteblock .attribution br,.verseblock .attribution br{display:none}
252
- .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253
- .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
254
- .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}
255
- .quoteblock.abstract{margin:0 1em 1.25em;display:block}
256
- .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
257
- .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
258
- .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
259
- .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
260
- .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
261
- p.tableblock:last-child{margin-bottom:0}
262
- td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
263
- td.tableblock>.content>:last-child{margin-bottom:-1.25em}
264
- table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
265
- table.grid-all>*>tr>*{border-width:1px}
266
- table.grid-cols>*>tr>*{border-width:0 1px}
267
- table.grid-rows>*>tr>*{border-width:1px 0}
268
- table.frame-all{border-width:1px}
269
- table.frame-ends{border-width:1px 0}
270
- table.frame-sides{border-width:0 1px}
271
- table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
272
- table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
273
- table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
274
- table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
275
- 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}
276
- th.halign-left,td.halign-left{text-align:left}
277
- th.halign-right,td.halign-right{text-align:right}
278
- th.halign-center,td.halign-center{text-align:center}
279
- th.valign-top,td.valign-top{vertical-align:top}
280
- th.valign-bottom,td.valign-bottom{vertical-align:bottom}
281
- th.valign-middle,td.valign-middle{vertical-align:middle}
282
- table thead th,table tfoot th{font-weight:bold}
283
- tbody tr th{background:#f7f8f7}
284
- tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
285
- p.tableblock>code:only-child{background:none;padding:0}
286
- p.tableblock{font-size:1em}
287
- ol{margin-left:1.75em}
288
- ul li ol{margin-left:1.5em}
289
- dl dd{margin-left:1.125em}
290
- dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
291
- li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
292
- ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
293
- ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
294
- ul.unstyled,ol.unstyled{margin-left:0}
295
- li>p:empty:only-child::before{content:"";display:inline-block}
296
- ul.checklist>li>p:first-child{margin-left:-1em}
297
- 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}
298
- ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
299
- ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
300
- ul.inline>li{margin-left:1.25em}
301
- .unstyled dl dt{font-weight:400;font-style:normal}
302
- ol.arabic{list-style-type:decimal}
303
- ol.decimal{list-style-type:decimal-leading-zero}
304
- ol.loweralpha{list-style-type:lower-alpha}
305
- ol.upperalpha{list-style-type:upper-alpha}
306
- ol.lowerroman{list-style-type:lower-roman}
307
- ol.upperroman{list-style-type:upper-roman}
308
- ol.lowergreek{list-style-type:lower-greek}
309
- .hdlist>table,.colist>table{border:0;background:none}
310
- .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
311
- td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
312
- td.hdlist1{font-weight:bold;padding-bottom:1.25em}
313
- td.hdlist2{word-wrap:anywhere}
314
- .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
315
- .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
316
- .colist td:not([class]):first-child img{max-width:none}
317
- .colist td:not([class]):last-child{padding:.25em 0}
318
- .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
319
- .imageblock.left{margin:.25em .625em 1.25em 0}
320
- .imageblock.right{margin:.25em 0 1.25em .625em}
321
- .imageblock>.title{margin-bottom:0}
322
- .imageblock.thumb,.imageblock.th{border-width:6px}
323
- .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
324
- .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
325
- .image.left{margin-right:.625em}
326
- .image.right{margin-left:.625em}
327
- a.image{text-decoration:none;display:inline-block}
328
- a.image object{pointer-events:none}
329
- sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
330
- sup.footnote a,sup.footnoteref a{text-decoration:none}
331
- sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
332
- #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
333
- #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
334
- #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
335
- #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
336
- #footnotes .footnote:last-of-type{margin-bottom:0}
337
- #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
338
- div.unbreakable{page-break-inside:avoid}
339
- .big{font-size:larger}
340
- .small{font-size:smaller}
341
- .underline{text-decoration:underline}
342
- .overline{text-decoration:overline}
343
- .line-through{text-decoration:line-through}
344
- .aqua{color:#00bfbf}
345
- .aqua-background{background:#00fafa}
346
- .black{color:#000}
347
- .black-background{background:#000}
348
- .blue{color:#0000bf}
349
- .blue-background{background:#0000fa}
350
- .fuchsia{color:#bf00bf}
351
- .fuchsia-background{background:#fa00fa}
352
- .gray{color:#606060}
353
- .gray-background{background:#7d7d7d}
354
- .green{color:#006000}
355
- .green-background{background:#007d00}
356
- .lime{color:#00bf00}
357
- .lime-background{background:#00fa00}
358
- .maroon{color:#600000}
359
- .maroon-background{background:#7d0000}
360
- .navy{color:#000060}
361
- .navy-background{background:#00007d}
362
- .olive{color:#606000}
363
- .olive-background{background:#7d7d00}
364
- .purple{color:#600060}
365
- .purple-background{background:#7d007d}
366
- .red{color:#bf0000}
367
- .red-background{background:#fa0000}
368
- .silver{color:#909090}
369
- .silver-background{background:#bcbcbc}
370
- .teal{color:#006060}
371
- .teal-background{background:#007d7d}
372
- .white{color:#bfbfbf}
373
- .white-background{background:#fafafa}
374
- .yellow{color:#bfbf00}
375
- .yellow-background{background:#fafa00}
376
- span.icon>.fa{cursor:default}
377
- a span.icon>.fa{cursor:inherit}
378
- .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
379
- .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
380
- .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
381
- .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
382
- .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
383
- .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
384
- .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}
385
- .conum[data-value] *{color:#fff!important}
386
- .conum[data-value]+b{display:none}
387
- .conum[data-value]::after{content:attr(data-value)}
388
- pre .conum[data-value]{position:relative;top:-.125em}
389
- b.conum *{color:inherit!important}
390
- .conum:not([data-value]):empty{display:none}
391
- dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
392
- h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
393
- p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
394
- p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
395
- p{margin-bottom:1.25rem}
396
- .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
397
- .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
398
- .print-only{display:none!important}
399
- @page{margin:1.25cm .75cm}
400
- @media print{*{box-shadow:none!important;text-shadow:none!important}
401
- html{font-size:80%}
402
- a{color:inherit!important;text-decoration:underline!important}
403
- a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
404
- a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
405
- abbr[title]{border-bottom:1px dotted}
406
- abbr[title]::after{content:" (" attr(title) ")"}
407
- pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
408
- thead{display:table-header-group}
409
- svg{max-width:100%}
410
- p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
411
- h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
412
- #header,#content,#footnotes,#footer{max-width:none}
413
- #toc,.sidebarblock,.exampleblock>.content{background:none!important}
414
- #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
415
- body.book #header{text-align:center}
416
- body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
417
- body.book #header .details{border:0!important;display:block;padding:0!important}
418
- body.book #header .details span:first-child{margin-left:0!important}
419
- body.book #header .details br{display:block}
420
- body.book #header .details br+span::before{content:none!important}
421
- body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
422
- body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
423
- .listingblock code[data-lang]::before{display:block}
424
- #footer{padding:0 .9375em}
425
- .hide-on-print{display:none!important}
426
- .print-only{display:block!important}
427
- .hide-for-print{display:none!important}
428
- .show-for-print{display:inherit!important}}
429
- @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
430
- .sect1{padding:0!important}
431
- .sect1+.sect1{border:0}
432
- #footer{background:none}
433
- #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
434
- @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
435
- </style>
436
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
437
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/styles/github.min.css">
438
- </head>
439
- <body class="article toc2 toc-left">
440
- <div id="header">
441
- <h1>Getting Started Guide</h1>
442
- <div id="toc" class="toc2">
443
- <div id="toctitle">Table of Contents</div>
444
- <ul class="sectlevel1">
445
- <li><a href="#_installation">1. Installation</a>
446
- <ul class="sectlevel2">
447
- <li><a href="#_quick_start_cli">1.1. Quick Start (CLI)</a></li>
448
- <li><a href="#_available_scripts">1.2. Available Scripts</a></li>
449
- <li><a href="#_manual_installation">1.3. Manual Installation</a></li>
450
- </ul>
451
- </li>
452
- <li><a href="#_creating_a_game">2. Creating a Game</a></li>
453
- <li><a href="#_next_steps">3. Next Steps</a></li>
454
- </ul>
455
- </div>
456
- </div>
457
- <div id="content">
458
- <div id="preamble">
459
- <div class="sectionbody">
460
- <div class="paragraph">
461
- <p>This guide provides everything you need to know to start building retro grid-based games with the <strong>Brick Engine</strong>.</p>
462
- </div>
463
- </div>
464
- </div>
465
- <div class="sect1">
466
- <h2 id="_installation"><a class="link" href="#_installation">1. Installation</a></h2>
467
- <div class="sectionbody">
468
- <div class="paragraph">
469
- <p>The fastest way to build a game is using the <strong>Brick Engine CLI</strong>, which scaffolds a complete project with build tools and quality checks.</p>
470
- </div>
471
- <div class="sect2">
472
- <h3 id="_quick_start_cli"><a class="link" href="#_quick_start_cli">1.1. Quick Start (CLI)</a></h3>
473
- <div class="paragraph">
474
- <p>Use <code>npx</code> to create a new project without installing anything globally:</p>
475
- </div>
476
- <div class="listingblock">
477
- <div class="content">
478
- <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">npx brick-engine-cli init my-brick-game</code></pre>
479
- </div>
480
- </div>
481
- <div class="paragraph">
482
- <p>This command will:
483
- * Create a project directory with a ready-to-use structure.
484
- * Generate <code>src/index.ts</code> with a boilerplate <code>Game</code> implementation, ready for coding.
485
- * Configure <strong>Webpack</strong> for development and production builds.
486
- * (Optional) Set up <strong>ESLint</strong> and <strong>Prettier</strong> for code quality.</p>
487
- </div>
488
- </div>
489
- <div class="sect2">
490
- <h3 id="_available_scripts"><a class="link" href="#_available_scripts">1.2. Available Scripts</a></h3>
491
- <div class="paragraph">
492
- <p>Once your project is created, use the following commands:</p>
493
- </div>
494
- <table class="tableblock frame-all grid-all stretch">
495
- <colgroup>
496
- <col style="width: 25%;">
497
- <col style="width: 75%;">
498
- </colgroup>
499
- <thead>
500
- <tr>
501
- <th class="tableblock halign-left valign-top">Command</th>
502
- <th class="tableblock halign-left valign-top">Description</th>
503
- </tr>
504
- </thead>
505
- <tbody>
506
- <tr>
507
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>npm start</code></p></td>
508
- <td class="tableblock halign-left valign-top"><p class="tableblock">Starts the dev server with hot reload at <code>localhost:8080</code>.</p></td>
509
- </tr>
510
- <tr>
511
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>npm run build:standalone</code></p></td>
512
- <td class="tableblock halign-left valign-top"><p class="tableblock">Generates a production-ready <code>/dist</code> folder for independent hosting.</p></td>
513
- </tr>
514
- <tr>
515
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>npm run build:bundle</code></p></td>
516
- <td class="tableblock halign-left valign-top"><p class="tableblock">Generates a bundle optimized for <a href="https://brickengine.com.br">brickengine.com.br</a>.</p></td>
517
- </tr>
518
- <tr>
519
- <td class="tableblock halign-left valign-top"><p class="tableblock"><code>npm run lint</code> / <code>npm run format</code></p></td>
520
- <td class="tableblock halign-left valign-top"><p class="tableblock">Checks and fixes code style (if enabled during init).</p></td>
521
- </tr>
522
- </tbody>
523
- </table>
524
- </div>
525
- <div class="sect2">
526
- <h3 id="_manual_installation"><a class="link" href="#_manual_installation">1.3. Manual Installation</a></h3>
527
- <div class="paragraph">
528
- <p>If you prefer to integrate the engine into an existing project, install it via npm:</p>
529
- </div>
530
- <div class="listingblock">
531
- <div class="content">
532
- <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">npm install brick-engine-js p5
533
- npm install --save-dev @types/p5</code></pre>
534
- </div>
535
- </div>
536
- </div>
537
- </div>
538
- </div>
539
- <div class="sect1">
540
- <h2 id="_creating_a_game"><a class="link" href="#_creating_a_game">2. Creating a Game</a></h2>
541
- <div class="sectionbody">
542
- <div class="paragraph">
543
- <p>To create a game, you must extend the abstract <code>Game</code> class. If you used the CLI, this logic is already scaffolded in <code>src/index.ts</code>. Here is a reference implementation:</p>
544
- </div>
545
- <div class="listingblock">
546
- <div class="content">
547
- <pre class="highlightjs highlight"><code class="language-typescript hljs" data-lang="typescript">import { Game, FontSize, ControlKey, ControlEventType, Sound, FontAlign, FontVerticalAlign } from 'brick-engine-js';
548
-
549
- export default class MyGame extends Game {
550
- /**
551
- * Called once after the engine and its modules are fully initialized.
552
- * Ideal for setting initial state, text sizes, and subscribing to controls.
553
- */
554
- setupGame(): void {
555
- // Example: Subscriber to ACTION button
556
- this.modules.control.subscribe(ControlKey.ACTION, ControlEventType.PRESSED, () =&gt; {
557
- console.log('Action pressed!');
558
- this.modules.sound.play(Sound.ACTION_1);
559
- });
560
- }
561
-
562
- /**
563
- * Called on every logic "tick". The frequency is defined by the game's tickInterval.
564
- * This is where movement, collision, and state updates should happen.
565
- * Logic here ONLY runs when the game is in the PLAYING state.
566
- */
567
- update(deltaTime: number): void {
568
- // Move players, check collisions, etc.
569
- }
570
-
571
- /**
572
- * Called every rendering frame (60fps).
573
- * Used for visual-only effects that don't impact game state (e.g. animations).
574
- * Runs during PLAYING and PAUSED states.
575
- */
576
- render(): void {
577
- const { text } = this.modules;
578
-
579
- text.setTextSize(FontSize.MEDIUM);
580
- text.setTextAlign(FontAlign.CENTER, FontVerticalAlign.CENTER);
581
- text.textOnDisplay('MY GAME', { x: 0.5, y: 0.4 });
582
- text.textOnDisplay('Playing', { x: 0.5, y: 0.6 });
583
- }
584
-
585
- /**
586
- * returns a unique key for LocalStorage.
587
- * Prevents data collisions between different games on the same domain.
588
- */
589
- getPersistenceKey(): string {
590
- return 'my-awesome-game-v1';
591
- }
592
-
593
- /**
594
- * Rendered every frame when the device is ON but the game hasn't started.
595
- * Usually displays the title and "Press Start" instructions.
596
- */
597
- drawTitleScreen(): void {
598
- const { text } = this.modules;
599
-
600
- text.setTextSize(FontSize.MEDIUM);
601
- text.setTextAlign(FontAlign.CENTER, FontVerticalAlign.CENTER);
602
- text.textOnDisplay('MY GAME', { x: 0.5, y: 0.4 });
603
- text.textOnDisplay('PRESS START', { x: 0.5, y: 0.6 });
604
- }
605
-
606
- /**
607
- * Rendered every frame when the game state reaches GAME OVER.
608
- * Replaces standard `render()` calls to show scores or restart messages.
609
- * Usually displays the game over message and "Press START to restart" instructions, and the final score.
610
- */
611
- drawGameOverScreen(): void {
612
- const { text, score } = this.modules;
613
-
614
- text.setTextSize(FontSize.MEDIUM);
615
- text.setTextAlign(FontAlign.CENTER, FontVerticalAlign.CENTER);
616
- text.textOnDisplay('GAME OVER', { x: 0.5, y: 0.4 });
617
- text.textOnDisplay(`SCORE: ${score.getScore()}`, { x: 0.5, y: 0.6 });
618
- }
619
- }</code></pre>
620
- </div>
621
- </div>
622
- </div>
623
- </div>
624
- <div class="sect1">
625
- <h2 id="_next_steps"><a class="link" href="#_next_steps">3. Next Steps</a></h2>
626
- <div class="sectionbody">
627
- <div class="paragraph">
628
- <p>Once you&#8217;ve set up your project and created your game class:
629
- * Explore the modules reference to learn about all the engine&#8217;s capabilities.
630
- * Learn how to share your completed game in the <strong><a href="publishing.html">Publishing Guide</a></strong>.</p>
631
- </div>
632
- </div>
633
- </div>
634
- </div>
635
- <div id="footer">
636
- <div id="footer-text">
637
- Last updated 2026-02-23 19:45:09 UTC
638
- </div>
639
- </div>
640
- <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
641
- <script>
642
- if (!hljs.initHighlighting.called) {
643
- hljs.initHighlighting.called = true
644
- ;[].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) { hljs.highlightBlock(el) })
645
- }
646
- </script>
647
- </body>
648
- </html>