@inglorious/engine 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (292) hide show
  1. package/README.md +39 -36
  2. package/package.json +20 -33
  3. package/src/engine/ai/movement/dynamic/align.js +63 -63
  4. package/src/engine/ai/movement/dynamic/arrive.js +42 -43
  5. package/src/engine/ai/movement/dynamic/evade.js +38 -38
  6. package/src/engine/ai/movement/dynamic/face.js +19 -20
  7. package/src/engine/ai/movement/dynamic/flee.js +45 -45
  8. package/src/engine/ai/movement/dynamic/look-where-youre-going.js +16 -17
  9. package/src/engine/ai/movement/dynamic/match-velocity.js +51 -50
  10. package/src/engine/ai/movement/dynamic/pursue.js +38 -38
  11. package/src/engine/ai/movement/dynamic/seek.js +44 -44
  12. package/src/engine/ai/movement/dynamic/wander.js +31 -32
  13. package/src/engine/ai/movement/kinematic/align.js +37 -37
  14. package/src/engine/ai/movement/kinematic/arrive.js +42 -42
  15. package/src/engine/ai/movement/kinematic/face.js +19 -20
  16. package/src/engine/ai/movement/kinematic/flee.js +26 -26
  17. package/src/engine/ai/movement/kinematic/seek.js +26 -26
  18. package/src/engine/ai/movement/kinematic/seek.test.js +42 -42
  19. package/src/engine/ai/movement/kinematic/wander-as-seek.js +31 -31
  20. package/src/engine/ai/movement/kinematic/wander.js +27 -27
  21. package/src/engine/animation/sprite.js +101 -0
  22. package/src/engine/animation/ticker.js +38 -0
  23. package/src/engine/behaviors/camera.js +68 -0
  24. package/src/engine/behaviors/controls/dynamic/modern.js +76 -0
  25. package/src/engine/behaviors/controls/dynamic/shooter.js +84 -0
  26. package/src/engine/behaviors/controls/dynamic/tank.js +69 -0
  27. package/src/engine/behaviors/controls/event-handlers.js +17 -0
  28. package/src/engine/behaviors/controls/kinematic/modern.js +76 -0
  29. package/src/engine/behaviors/controls/kinematic/shooter.js +82 -0
  30. package/src/engine/behaviors/controls/kinematic/tank.js +67 -0
  31. package/src/engine/behaviors/debug/collision.js +35 -0
  32. package/src/engine/behaviors/fps.js +29 -0
  33. package/src/engine/behaviors/fsm.js +33 -0
  34. package/src/{game/decorators → engine/behaviors}/fsm.test.js +49 -56
  35. package/src/engine/behaviors/game.js +15 -0
  36. package/src/engine/behaviors/input/controls.js +37 -0
  37. package/src/engine/behaviors/input/gamepad.js +114 -0
  38. package/src/engine/behaviors/input/input.js +48 -0
  39. package/src/engine/behaviors/input/keyboard.js +64 -0
  40. package/src/engine/behaviors/input/mouse.js +91 -0
  41. package/src/engine/behaviors/physics/bouncy.js +25 -0
  42. package/src/engine/behaviors/physics/clamped.js +36 -0
  43. package/src/{game/decorators/collisions.js → engine/behaviors/physics/collidable.js} +20 -24
  44. package/src/engine/behaviors/physics/jumpable.js +145 -0
  45. package/src/engine/behaviors/ui/button.js +17 -0
  46. package/src/engine/collision/detection.js +110 -115
  47. package/src/engine/core/api.js +34 -0
  48. package/src/engine/core/dev-tools.js +135 -0
  49. package/src/engine/core/engine.js +119 -0
  50. package/src/engine/core/loop.js +15 -0
  51. package/src/engine/{loop → core/loops}/animation-frame.js +25 -26
  52. package/src/engine/{loop → core/loops}/elapsed.js +22 -23
  53. package/src/engine/{loop → core/loops}/fixed.js +27 -28
  54. package/src/engine/{loop → core/loops}/flash.js +13 -14
  55. package/src/engine/{loop → core/loops}/lag.js +26 -27
  56. package/src/engine/core/select.js +26 -0
  57. package/src/engine/core/store.js +178 -0
  58. package/src/engine/core/store.test.js +110 -0
  59. package/src/engine/movement/dynamic/modern.js +21 -24
  60. package/src/engine/movement/dynamic/tank.js +43 -43
  61. package/src/engine/movement/kinematic/modern.js +16 -16
  62. package/src/engine/movement/kinematic/modern.test.js +27 -27
  63. package/src/engine/movement/kinematic/tank.js +27 -27
  64. package/src/engine/physics/bounds.js +138 -0
  65. package/src/engine/physics/position.js +43 -0
  66. package/src/engine/physics/position.test.js +80 -0
  67. package/src/engine/systems/sprite-animation.js +27 -0
  68. package/src/main.js +10 -5
  69. package/src/renderers/canvas/absolute-position.js +18 -0
  70. package/src/renderers/canvas/camera.js +13 -0
  71. package/src/renderers/canvas/canvas-renderer.js +68 -0
  72. package/src/{ui → renderers}/canvas/character.js +38 -35
  73. package/src/{ui → renderers}/canvas/form/button.js +25 -25
  74. package/src/{ui → renderers}/canvas/fps.js +18 -18
  75. package/src/renderers/canvas/image/hitmask.js +51 -0
  76. package/src/{ui → renderers}/canvas/image/image.js +34 -37
  77. package/src/{ui → renderers}/canvas/image/sprite.js +49 -49
  78. package/src/{ui → renderers}/canvas/image/tilemap.js +66 -64
  79. package/src/{ui → renderers}/canvas/mouse.js +37 -37
  80. package/src/renderers/canvas/rendering-system.js +79 -0
  81. package/src/{ui → renderers}/canvas/shapes/circle.js +29 -31
  82. package/src/{ui → renderers}/canvas/shapes/rectangle.js +27 -31
  83. package/src/renderers/react/game/character/index.jsx +20 -0
  84. package/src/{ui → renderers}/react/game/cursor/index.jsx +20 -20
  85. package/src/{ui → renderers}/react/game/form/fields/field/index.jsx +56 -56
  86. package/src/{ui → renderers}/react/game/form/fields/index.jsx +12 -12
  87. package/src/{ui → renderers}/react/game/form/index.jsx +22 -22
  88. package/src/{ui → renderers}/react/game/fps/index.jsx +16 -16
  89. package/src/{ui → renderers}/react/game/game.jsx +72 -71
  90. package/src/{ui → renderers}/react/game/index.jsx +29 -29
  91. package/src/{ui → renderers}/react/game/platform/index.jsx +30 -30
  92. package/src/{ui → renderers}/react/game/scene/index.jsx +27 -25
  93. package/src/{ui → renderers}/react/game/sprite/index.jsx +60 -58
  94. package/src/{ui → renderers}/react/game/stats/index.jsx +22 -22
  95. package/src/{ui → renderers}/react/hocs/with-absolute-position/index.jsx +20 -20
  96. package/src/{ui → renderers}/react/index.jsx +9 -9
  97. package/src/utils/algorithms/decision-tree.js +24 -24
  98. package/src/utils/algorithms/decision-tree.test.js +153 -102
  99. package/src/utils/algorithms/path-finding.js +155 -155
  100. package/src/utils/algorithms/path-finding.test.js +151 -151
  101. package/src/utils/data-structures/array.js +83 -83
  102. package/src/utils/data-structures/array.test.js +173 -173
  103. package/src/utils/data-structures/board.js +159 -159
  104. package/src/utils/data-structures/board.test.js +242 -242
  105. package/src/utils/data-structures/boolean.js +9 -9
  106. package/src/utils/data-structures/heap.js +164 -164
  107. package/src/utils/data-structures/heap.test.js +103 -103
  108. package/src/utils/data-structures/object.js +138 -102
  109. package/src/utils/data-structures/object.test.js +218 -121
  110. package/src/utils/data-structures/objects.js +66 -48
  111. package/src/utils/data-structures/objects.test.js +99 -99
  112. package/src/utils/data-structures/tree.js +36 -36
  113. package/src/utils/data-structures/tree.test.js +33 -33
  114. package/src/utils/functions/functions.js +19 -19
  115. package/src/utils/functions/functions.test.js +23 -23
  116. package/src/utils/math/geometry/circle.js +70 -117
  117. package/src/utils/math/geometry/circle.test.js +97 -97
  118. package/src/utils/math/geometry/hitmask.js +70 -39
  119. package/src/utils/math/geometry/hitmask.test.js +155 -84
  120. package/src/utils/math/geometry/line.js +35 -35
  121. package/src/utils/math/geometry/line.test.js +49 -49
  122. package/src/utils/math/geometry/point.js +78 -71
  123. package/src/utils/math/geometry/point.test.js +81 -81
  124. package/src/utils/math/geometry/rectangle.js +76 -45
  125. package/src/utils/math/geometry/rectangle.test.js +42 -42
  126. package/src/utils/math/geometry/segment.js +80 -80
  127. package/src/utils/math/geometry/segment.test.js +183 -183
  128. package/src/utils/math/geometry/triangle.js +15 -15
  129. package/src/utils/math/geometry/triangle.test.js +11 -11
  130. package/src/utils/math/linear-algebra/2d.js +28 -28
  131. package/src/utils/math/linear-algebra/2d.test.js +17 -17
  132. package/src/utils/math/linear-algebra/quaternion.js +22 -22
  133. package/src/utils/math/linear-algebra/quaternion.test.js +25 -25
  134. package/src/utils/math/linear-algebra/quaternions.js +20 -20
  135. package/src/utils/math/linear-algebra/quaternions.test.js +29 -29
  136. package/src/utils/math/linear-algebra/vector.js +327 -302
  137. package/src/utils/math/linear-algebra/vector.test.js +265 -257
  138. package/src/utils/math/linear-algebra/vectors.js +122 -122
  139. package/src/utils/math/linear-algebra/vectors.test.js +65 -65
  140. package/src/utils/math/linear-interpolation.js +9 -0
  141. package/src/utils/math/numbers.js +90 -90
  142. package/src/utils/math/numbers.test.js +137 -137
  143. package/src/utils/math/rng.js +44 -44
  144. package/src/utils/math/rng.test.js +39 -39
  145. package/src/utils/math/statistics.js +43 -43
  146. package/src/utils/math/statistics.test.js +47 -47
  147. package/src/utils/math/trigonometry.js +89 -89
  148. package/src/utils/math/trigonometry.test.js +52 -52
  149. package/src/utils/physics/acceleration.js +61 -63
  150. package/src/utils/physics/friction.js +28 -30
  151. package/src/utils/physics/friction.test.js +42 -44
  152. package/src/utils/physics/gravity.js +69 -71
  153. package/src/utils/physics/gravity.test.js +77 -80
  154. package/src/utils/physics/jump.js +31 -41
  155. package/src/utils/physics/velocity.js +36 -38
  156. package/src/docs/ai/movement/dynamic/align.js +0 -131
  157. package/src/docs/ai/movement/dynamic/arrive.js +0 -88
  158. package/src/docs/ai/movement/dynamic/dynamic.mdx +0 -99
  159. package/src/docs/ai/movement/dynamic/dynamic.stories.js +0 -58
  160. package/src/docs/ai/movement/dynamic/evade.js +0 -72
  161. package/src/docs/ai/movement/dynamic/face.js +0 -90
  162. package/src/docs/ai/movement/dynamic/flee.js +0 -38
  163. package/src/docs/ai/movement/dynamic/look-where-youre-going.js +0 -114
  164. package/src/docs/ai/movement/dynamic/match-velocity.js +0 -92
  165. package/src/docs/ai/movement/dynamic/pursue.js +0 -72
  166. package/src/docs/ai/movement/dynamic/seek.js +0 -37
  167. package/src/docs/ai/movement/dynamic/wander.js +0 -71
  168. package/src/docs/ai/movement/kinematic/align.js +0 -122
  169. package/src/docs/ai/movement/kinematic/arrive.js +0 -78
  170. package/src/docs/ai/movement/kinematic/face.js +0 -82
  171. package/src/docs/ai/movement/kinematic/flee.js +0 -36
  172. package/src/docs/ai/movement/kinematic/kinematic.mdx +0 -67
  173. package/src/docs/ai/movement/kinematic/kinematic.stories.js +0 -42
  174. package/src/docs/ai/movement/kinematic/seek.js +0 -34
  175. package/src/docs/ai/movement/kinematic/wander-as-seek.js +0 -62
  176. package/src/docs/ai/movement/kinematic/wander.js +0 -28
  177. package/src/docs/bounds.js +0 -7
  178. package/src/docs/code-reuse.js +0 -35
  179. package/src/docs/collision/circles.js +0 -58
  180. package/src/docs/collision/collision.mdx +0 -27
  181. package/src/docs/collision/collision.stories.js +0 -22
  182. package/src/docs/collision/platform.js +0 -76
  183. package/src/docs/collision/tilemap.js +0 -181
  184. package/src/docs/empty.js +0 -1
  185. package/src/docs/engine.mdx +0 -81
  186. package/src/docs/engine.stories.js +0 -37
  187. package/src/docs/event-handlers.js +0 -68
  188. package/src/docs/framerate.js +0 -37
  189. package/src/docs/game.jsx +0 -15
  190. package/src/docs/image/image.js +0 -19
  191. package/src/docs/image/image.stories.js +0 -22
  192. package/src/docs/image/sprite.js +0 -39
  193. package/src/docs/image/tilemap.js +0 -84
  194. package/src/docs/input/controls.js +0 -67
  195. package/src/docs/input/gamepad.js +0 -67
  196. package/src/docs/input/input.mdx +0 -55
  197. package/src/docs/input/input.stories.js +0 -27
  198. package/src/docs/input/keyboard.js +0 -58
  199. package/src/docs/input/mouse.js +0 -32
  200. package/src/docs/instances.js +0 -49
  201. package/src/docs/player/dynamic/double-jump.js +0 -90
  202. package/src/docs/player/dynamic/dynamic.stories.js +0 -32
  203. package/src/docs/player/dynamic/jump.js +0 -83
  204. package/src/docs/player/dynamic/modern-controls.js +0 -57
  205. package/src/docs/player/dynamic/shooter-controls.js +0 -51
  206. package/src/docs/player/dynamic/tank-controls.js +0 -44
  207. package/src/docs/player/kinematic/double-jump.js +0 -90
  208. package/src/docs/player/kinematic/jump.js +0 -82
  209. package/src/docs/player/kinematic/kinematic.stories.js +0 -32
  210. package/src/docs/player/kinematic/modern-controls.js +0 -56
  211. package/src/docs/player/kinematic/shooter-controls.js +0 -48
  212. package/src/docs/player/kinematic/tank-controls.js +0 -42
  213. package/src/docs/quick-start/first-game.js +0 -49
  214. package/src/docs/quick-start/hello-world.js +0 -1
  215. package/src/docs/quick-start.mdx +0 -127
  216. package/src/docs/quick-start.stories.js +0 -17
  217. package/src/docs/recipes/add-and-remove.js +0 -71
  218. package/src/docs/recipes/add-instance.js +0 -42
  219. package/src/docs/recipes/decision-tree.js +0 -169
  220. package/src/docs/recipes/random-instances.js +0 -25
  221. package/src/docs/recipes/recipes.mdx +0 -81
  222. package/src/docs/recipes/recipes.stories.js +0 -37
  223. package/src/docs/recipes/remove-instance.js +0 -52
  224. package/src/docs/recipes/states.js +0 -64
  225. package/src/docs/ui/button.js +0 -28
  226. package/src/docs/ui/form.stories.js +0 -55
  227. package/src/docs/ui-chooser.jsx +0 -6
  228. package/src/docs/utils/data-structures/object.mdx +0 -47
  229. package/src/docs/utils/data-structures/objects.mdx +0 -30
  230. package/src/docs/utils/functions/functions.mdx +0 -34
  231. package/src/docs/utils/math/geometry/circle.mdx +0 -55
  232. package/src/docs/utils/math/geometry/point.mdx +0 -38
  233. package/src/docs/utils/math/geometry/rectangle.mdx +0 -24
  234. package/src/docs/utils/math/geometry/segment.mdx +0 -55
  235. package/src/docs/utils/math/geometry/triangle.mdx +0 -22
  236. package/src/docs/utils/math/linear-algebra/2d.mdx +0 -22
  237. package/src/docs/utils/math/linear-algebra/quaternion.mdx +0 -21
  238. package/src/docs/utils/math/linear-algebra/quaternions.mdx +0 -22
  239. package/src/docs/utils/math/linear-algebra/vector.mdx +0 -177
  240. package/src/docs/utils/math/linear-algebra/vectors.mdx +0 -58
  241. package/src/docs/utils/math/numbers.mdx +0 -76
  242. package/src/docs/utils/math/random.mdx +0 -35
  243. package/src/docs/utils/math/statistics.mdx +0 -38
  244. package/src/docs/utils/math/trigonometry.mdx +0 -85
  245. package/src/docs/utils/physics/friction.mdx +0 -20
  246. package/src/docs/utils/physics/gravity.mdx +0 -28
  247. package/src/engine/loop.js +0 -15
  248. package/src/engine/store.js +0 -174
  249. package/src/engine/store.test.js +0 -256
  250. package/src/engine.js +0 -74
  251. package/src/game/animation.js +0 -26
  252. package/src/game/bounds.js +0 -66
  253. package/src/game/decorators/character.js +0 -5
  254. package/src/game/decorators/clamp-to-bounds.js +0 -15
  255. package/src/game/decorators/controls/dynamic/modern.js +0 -48
  256. package/src/game/decorators/controls/dynamic/shooter.js +0 -47
  257. package/src/game/decorators/controls/dynamic/tank.js +0 -55
  258. package/src/game/decorators/controls/kinematic/modern.js +0 -49
  259. package/src/game/decorators/controls/kinematic/shooter.js +0 -45
  260. package/src/game/decorators/controls/kinematic/tank.js +0 -52
  261. package/src/game/decorators/debug/collisions.js +0 -32
  262. package/src/game/decorators/double-jump.js +0 -70
  263. package/src/game/decorators/fps.js +0 -30
  264. package/src/game/decorators/fsm.js +0 -27
  265. package/src/game/decorators/game.js +0 -11
  266. package/src/game/decorators/image/image.js +0 -5
  267. package/src/game/decorators/image/sprite.js +0 -5
  268. package/src/game/decorators/image/tilemap.js +0 -5
  269. package/src/game/decorators/input/controls.js +0 -27
  270. package/src/game/decorators/input/gamepad.js +0 -74
  271. package/src/game/decorators/input/input.js +0 -41
  272. package/src/game/decorators/input/keyboard.js +0 -49
  273. package/src/game/decorators/input/mouse.js +0 -65
  274. package/src/game/decorators/jump.js +0 -72
  275. package/src/game/decorators/platform.js +0 -5
  276. package/src/game/decorators/ui/button.js +0 -21
  277. package/src/game/sprite.js +0 -119
  278. package/src/ui/canvas/absolute-position.js +0 -17
  279. package/src/ui/canvas/image/hitmask.js +0 -37
  280. package/src/ui/canvas.js +0 -81
  281. package/src/ui/react/game/character/index.jsx +0 -30
  282. package/src/utils/math/geometry/platform.js +0 -42
  283. package/src/utils/math/geometry/platform.test.js +0 -133
  284. /package/src/{ui → renderers}/react/game/character/character.module.scss +0 -0
  285. /package/src/{ui → renderers}/react/game/cursor/cursor.module.scss +0 -0
  286. /package/src/{ui → renderers}/react/game/form/fields/field/field.module.scss +0 -0
  287. /package/src/{ui → renderers}/react/game/form/fields/fields.module.scss +0 -0
  288. /package/src/{ui → renderers}/react/game/form/form.module.scss +0 -0
  289. /package/src/{ui → renderers}/react/game/platform/platform.module.scss +0 -0
  290. /package/src/{ui → renderers}/react/game/scene/scene.module.scss +0 -0
  291. /package/src/{ui → renderers}/react/game/sprite/sprite.module.css +0 -0
  292. /package/src/{ui → renderers}/react/hocs/with-absolute-position/with-absolute-position.module.scss +0 -0
@@ -1,51 +0,0 @@
1
- import { enableCharacter } from "@inglorious/game/decorators/character.js"
2
- import { enableClampToBounds } from "@inglorious/game/decorators/clamp-to-bounds.js"
3
- import { enableShooterControls } from "@inglorious/game/decorators/controls/dynamic/shooter.js"
4
- import {
5
- createControls,
6
- enableControls,
7
- } from "@inglorious/game/decorators/input/controls.js"
8
- import { enableMouse } from "@inglorious/game/decorators/input/mouse.js"
9
- import { pi } from "@inglorious/utils/math/trigonometry.js"
10
-
11
- export default {
12
- types: {
13
- mouse: [enableMouse()],
14
-
15
- ...enableControls(),
16
-
17
- character: [
18
- enableCharacter(),
19
- enableShooterControls(),
20
- enableClampToBounds(),
21
- ],
22
- },
23
-
24
- instances: {
25
- mouse: {
26
- type: "mouse",
27
- position: [400, 0, 300],
28
- },
29
-
30
- ...createControls("input0", {
31
- ArrowUp: "up",
32
- ArrowDown: "down",
33
- ArrowLeft: "left",
34
- ArrowRight: "right",
35
- KeyW: "up",
36
- KeyS: "down",
37
- KeyA: "left",
38
- KeyD: "right",
39
- }),
40
-
41
- character: {
42
- type: "character",
43
- maxAngularAcceleration: 1000,
44
- maxAngularSpeed: 2 * pi(),
45
- maxAcceleration: 500,
46
- maxSpeed: 250,
47
- friction: 250,
48
- position: [400, 0, 300],
49
- },
50
- },
51
- }
@@ -1,44 +0,0 @@
1
- import { enableCharacter } from "@inglorious/game/decorators/character.js"
2
- import { enableClampToBounds } from "@inglorious/game/decorators/clamp-to-bounds.js"
3
- import { enableTankControls } from "@inglorious/game/decorators/controls/dynamic/tank.js"
4
- import {
5
- createControls,
6
- enableControls,
7
- } from "@inglorious/game/decorators/input/controls.js"
8
-
9
- export default {
10
- types: {
11
- ...enableControls(),
12
-
13
- character: [enableCharacter(), enableTankControls(), enableClampToBounds()],
14
- },
15
-
16
- instances: {
17
- ...createControls("input0", {
18
- ArrowUp: "up",
19
- ArrowDown: "down",
20
- ArrowLeft: "left",
21
- ArrowRight: "right",
22
- KeyW: "up",
23
- KeyS: "down",
24
- KeyA: "left",
25
- KeyD: "right",
26
- Btn12: "up",
27
- Btn13: "down",
28
- Btn14: "left",
29
- Btn15: "right",
30
- Axis0: "strafe",
31
- Axis1: "upDown",
32
- Axis2: "leftRight",
33
- }),
34
-
35
- character: {
36
- type: "character",
37
- maxAngularSpeed: 10,
38
- maxAcceleration: 500,
39
- maxSpeed: 250,
40
- friction: 250,
41
- position: [400, 0, 300],
42
- },
43
- },
44
- }
@@ -1,90 +0,0 @@
1
- import { enableCharacter } from "@inglorious/game/decorators/character.js"
2
- import { enableClampToBounds } from "@inglorious/game/decorators/clamp-to-bounds.js"
3
- import { enableModernControls } from "@inglorious/game/decorators/controls/kinematic/modern.js"
4
- import { enableDoubleJump } from "@inglorious/game/decorators/double-jump.js"
5
- import { enableFsm } from "@inglorious/game/decorators/fsm.js"
6
- import {
7
- createControls,
8
- enableControls,
9
- } from "@inglorious/game/decorators/input/controls.js"
10
- import { enableJump } from "@inglorious/game/decorators/jump.js"
11
-
12
- const Y = 1
13
-
14
- export default {
15
- types: {
16
- ...enableControls(),
17
-
18
- stats: {},
19
-
20
- character: [
21
- enableCharacter(),
22
- enableModernControls(),
23
- enableClampToBounds(),
24
- enableDoubleJump(),
25
- enableJump(),
26
- enableFsm({
27
- default: {
28
- "game:update"(instance) {
29
- stopFreeFalling(instance)
30
- },
31
- },
32
-
33
- jumping: {
34
- "game:update"(instance) {
35
- stopFreeFalling(instance)
36
- },
37
- },
38
-
39
- doubleJumping: {
40
- "game:update"(instance) {
41
- stopFreeFalling(instance)
42
- },
43
- },
44
- }),
45
- ],
46
- },
47
-
48
- instances: {
49
- ...createControls("input0", {
50
- ArrowUp: "up",
51
- ArrowDown: "down",
52
- ArrowLeft: "left",
53
- ArrowRight: "right",
54
- Space: "jump",
55
- KeyW: "up",
56
- KeyS: "down",
57
- KeyA: "left",
58
- KeyD: "right",
59
- Btn12: "up",
60
- Btn13: "down",
61
- Btn14: "left",
62
- Btn15: "right",
63
- Btn0: "jump",
64
- Axis0: "leftRight",
65
- Axis1: "upDown",
66
- }),
67
-
68
- stats: {
69
- type: "stats",
70
- position: [600, 0, 600],
71
- target: "character",
72
- },
73
-
74
- character: {
75
- type: "character",
76
- maxSpeed: 250,
77
- position: [400, 0, 300],
78
- maxJump: 100,
79
- maxLeap: 100,
80
- },
81
- },
82
- }
83
-
84
- function stopFreeFalling(instance) {
85
- if (instance.position[Y] <= 0) {
86
- instance.vy = 0
87
- instance.position[Y] = 0
88
- instance.state = "default"
89
- }
90
- }
@@ -1,82 +0,0 @@
1
- import { enableCharacter } from "@inglorious/game/decorators/character.js"
2
- import { enableClampToBounds } from "@inglorious/game/decorators/clamp-to-bounds.js"
3
- import { enableModernControls } from "@inglorious/game/decorators/controls/kinematic/modern.js"
4
- import { enableFsm } from "@inglorious/game/decorators/fsm.js"
5
- import {
6
- createControls,
7
- enableControls,
8
- } from "@inglorious/game/decorators/input/controls.js"
9
- import { enableJump } from "@inglorious/game/decorators/jump.js"
10
-
11
- const Y = 1
12
-
13
- export default {
14
- types: {
15
- ...enableControls(),
16
-
17
- stats: {},
18
-
19
- character: [
20
- enableCharacter(),
21
- enableModernControls(),
22
- enableClampToBounds(),
23
- enableJump(),
24
- enableFsm({
25
- default: {
26
- "game:update"(instance) {
27
- stopFreeFalling(instance)
28
- },
29
- },
30
-
31
- jumping: {
32
- "game:update"(instance) {
33
- stopFreeFalling(instance)
34
- },
35
- },
36
- }),
37
- ],
38
- },
39
-
40
- instances: {
41
- ...createControls("input0", {
42
- ArrowUp: "up",
43
- ArrowDown: "down",
44
- ArrowLeft: "left",
45
- ArrowRight: "right",
46
- Space: "jump",
47
- KeyW: "up",
48
- KeyS: "down",
49
- KeyA: "left",
50
- KeyD: "right",
51
- Btn12: "up",
52
- Btn13: "down",
53
- Btn14: "left",
54
- Btn15: "right",
55
- Btn0: "jump",
56
- Axis0: "leftRight",
57
- Axis1: "upDown",
58
- }),
59
-
60
- stats: {
61
- type: "stats",
62
- position: [600, 0, 600],
63
- target: "character",
64
- },
65
-
66
- character: {
67
- type: "character",
68
- maxSpeed: 250,
69
- position: [400, 0, 300],
70
- maxJump: 100,
71
- maxLeap: 100,
72
- },
73
- },
74
- }
75
-
76
- function stopFreeFalling(instance) {
77
- if (instance.position[Y] <= 0) {
78
- instance.vy = 0
79
- instance.position[Y] = 0
80
- instance.state = "default"
81
- }
82
- }
@@ -1,32 +0,0 @@
1
- import UiChooser from "@inglorious/docs/ui-chooser.jsx"
2
-
3
- import doubleJump from "./double-jump.js"
4
- import jump from "./jump.js"
5
- import modernControls from "./modern-controls.js"
6
- import shooterControls from "./shooter-controls.js"
7
- import tankControls from "./tank-controls.js"
8
-
9
- export default {
10
- title: "Engine/Player/Kinematic",
11
- component: UiChooser,
12
- }
13
-
14
- export const ModernControls = {
15
- args: { config: modernControls },
16
- }
17
-
18
- export const TankControls = {
19
- args: { config: tankControls },
20
- }
21
-
22
- export const ShooterControls = {
23
- args: { config: shooterControls },
24
- }
25
-
26
- export const Jump = {
27
- args: { config: jump },
28
- }
29
-
30
- export const DoubleJump = {
31
- args: { config: doubleJump },
32
- }
@@ -1,56 +0,0 @@
1
- import { enableCharacter } from "@inglorious/game/decorators/character.js"
2
- import { enableClampToBounds } from "@inglorious/game/decorators/clamp-to-bounds.js"
3
- import { enableModernControls } from "@inglorious/game/decorators/controls/kinematic/modern.js"
4
- import {
5
- createControls,
6
- enableControls,
7
- } from "@inglorious/game/decorators/input/controls.js"
8
-
9
- export default {
10
- types: {
11
- ...enableControls(),
12
-
13
- stats: {},
14
-
15
- character: [
16
- enableCharacter(),
17
- enableModernControls(),
18
- enableClampToBounds(),
19
- ],
20
- },
21
-
22
- instances: {
23
- ...createControls("input0", {
24
- ArrowUp: "up",
25
- ArrowDown: "down",
26
- ArrowLeft: "left",
27
- ArrowRight: "right",
28
- Space: "jump",
29
- KeyW: "up",
30
- KeyS: "down",
31
- KeyA: "left",
32
- KeyD: "right",
33
- Btn12: "up",
34
- Btn13: "down",
35
- Btn14: "left",
36
- Btn15: "right",
37
- Btn0: "jump",
38
- Axis0: "leftRight",
39
- Axis1: "upDown",
40
- }),
41
-
42
- stats: {
43
- type: "stats",
44
- position: [600, 0, 600],
45
- target: "character",
46
- },
47
-
48
- character: {
49
- type: "character",
50
- maxSpeed: 250,
51
- position: [400, 0, 300],
52
- maxJump: 100,
53
- maxLeap: 100,
54
- },
55
- },
56
- }
@@ -1,48 +0,0 @@
1
- import { enableCharacter } from "@inglorious/game/decorators/character.js"
2
- import { enableClampToBounds } from "@inglorious/game/decorators/clamp-to-bounds.js"
3
- import { enableShooterControls } from "@inglorious/game/decorators/controls/kinematic/shooter.js"
4
- import {
5
- createControls,
6
- enableControls,
7
- } from "@inglorious/game/decorators/input/controls.js"
8
- import { enableMouse } from "@inglorious/game/decorators/input/mouse.js"
9
- import { pi } from "@inglorious/utils/math/trigonometry.js"
10
-
11
- export default {
12
- types: {
13
- mouse: [enableMouse()],
14
-
15
- ...enableControls(),
16
-
17
- character: [
18
- enableCharacter(),
19
- enableShooterControls(),
20
- enableClampToBounds(),
21
- ],
22
- },
23
-
24
- instances: {
25
- mouse: {
26
- type: "mouse",
27
- position: [400, 0, 300],
28
- },
29
-
30
- ...createControls("input0", {
31
- ArrowLeft: "left",
32
- ArrowRight: "right",
33
- ArrowDown: "down",
34
- ArrowUp: "up",
35
- KeyA: "left",
36
- KeyD: "right",
37
- KeyS: "down",
38
- KeyW: "up",
39
- }),
40
-
41
- character: {
42
- type: "character",
43
- maxAngularSpeed: 2 * pi(),
44
- maxSpeed: 250,
45
- position: [400, 0, 300],
46
- },
47
- },
48
- }
@@ -1,42 +0,0 @@
1
- import { enableCharacter } from "@inglorious/game/decorators/character.js"
2
- import { enableClampToBounds } from "@inglorious/game/decorators/clamp-to-bounds"
3
- import { enableTankControls } from "@inglorious/game/decorators/controls/kinematic/tank.js"
4
- import {
5
- createControls,
6
- enableControls,
7
- } from "@inglorious/game/decorators/input/controls.js"
8
-
9
- export default {
10
- types: {
11
- ...enableControls(),
12
-
13
- character: [enableCharacter(), enableTankControls(), enableClampToBounds()],
14
- },
15
-
16
- instances: {
17
- ...createControls("input0", {
18
- ArrowUp: "up",
19
- ArrowDown: "down",
20
- ArrowLeft: "left",
21
- ArrowRight: "right",
22
- KeyW: "up",
23
- KeyS: "down",
24
- KeyA: "left",
25
- KeyD: "right",
26
- Btn12: "up",
27
- Btn13: "down",
28
- Btn14: "left",
29
- Btn15: "right",
30
- Axis0: "strafe",
31
- Axis1: "upDown",
32
- Axis2: "leftRight",
33
- }),
34
-
35
- character: {
36
- type: "character",
37
- maxAngularSpeed: 10,
38
- maxSpeed: 250,
39
- position: [400, 0, 300],
40
- },
41
- },
42
- }
@@ -1,49 +0,0 @@
1
- export default {
2
- types: {
3
- character: {
4
- draw(ctx, instance) {
5
- const {
6
- size = 24,
7
- orientation = 0,
8
- stroke = "black",
9
- fill = "transparent",
10
- } = instance
11
-
12
- const radius = size * 0.5
13
-
14
- ctx.save()
15
- ctx.rotate(-orientation)
16
- ctx.translate(radius - 1, 0)
17
-
18
- ctx.fillStyle = "black"
19
-
20
- ctx.beginPath()
21
- ctx.moveTo(0, 6)
22
- ctx.lineTo(0, -6)
23
- ctx.lineTo(6, 0)
24
- ctx.fill()
25
- ctx.closePath()
26
- ctx.restore()
27
-
28
- ctx.save()
29
- ctx.lineWidth = 1
30
- ctx.strokeStyle = stroke
31
- ctx.fillStyle = fill
32
-
33
- ctx.beginPath()
34
- ctx.arc(0, 0, radius, 0, 2 * 3.14)
35
- ctx.fill()
36
- ctx.stroke()
37
- ctx.closePath()
38
- ctx.restore()
39
- },
40
- },
41
- },
42
-
43
- instances: {
44
- character: {
45
- type: "character",
46
- position: [400, 0, 300],
47
- },
48
- },
49
- }
@@ -1 +0,0 @@
1
- export default {}
@@ -1,127 +0,0 @@
1
- import { Canvas, Meta, Source } from '@storybook/blocks'
2
- import * as QuickStart from './quick-start.stories'
3
-
4
- import helloWorld from './quick-start/hello-world?raw'
5
- import firstGame from './quick-start/first-game?raw'
6
-
7
- <Meta of={QuickStart} />
8
-
9
- # Quick Start Guide
10
-
11
- Welcome to Inglorious Engine! This guide will get you up and running in minutes.
12
-
13
- ## What is Inglorious Engine?
14
-
15
- Inglorious Engine is a **functional programming** game engine for JavaScript. Instead of object-oriented programming, it uses:
16
- - **Global state** - One source of truth for your entire game
17
- - **Immutability** - State changes create new state, never modify existing
18
- - **Pure functions** - Predictable, testable, and reusable functions
19
- - **Function composition** - Combine behaviors like building blocks
20
-
21
- ## Your First Game
22
-
23
- ### Step 1: Basic Setup
24
-
25
- Create an HTML file with this structure:
26
-
27
- ```html
28
- <!doctype html>
29
- <html lang="en">
30
- <body>
31
- <canvas id="canvas"></canvas>
32
-
33
- <script type="importmap">
34
- {
35
- "imports": {
36
- "immer": "https://unpkg.com/immer@10.1.1/dist/immer.mjs",
37
- "@inglorious/": "/src/",
38
- "game": "./my-game.js"
39
- }
40
- }
41
- </script>
42
-
43
- <script type="module" src="/src/main.js"></script>
44
- </body>
45
- </html>
46
- ```
47
-
48
- ### Step 2: Hello World
49
-
50
- Create `my-game.js` with the simplest possible game:
51
-
52
- <Source dark code={helloWorld} />
53
-
54
- <Canvas of={QuickStart.HelloWorld} />
55
-
56
- This creates an 800x600 canvas with a light grey background. Not exciting yet, but it's working!
57
-
58
- ### Step 3: Add a Character
59
-
60
- Let's add something to the scene:
61
-
62
- <Source dark code={firstGame} />
63
-
64
- <Canvas of={QuickStart.FirstGame} />
65
-
66
- ## Key Concepts
67
-
68
- ### 1. Game Configuration Structure
69
-
70
- Every game has this structure:
71
- ```javascript
72
- export default {
73
- // Static definitions - never change
74
- types: {
75
- // Define what kinds of objects exist
76
- },
77
-
78
- // Dynamic state - changes during gameplay
79
- instances: {
80
- // Actual objects in the scene
81
- }
82
- }
83
- ```
84
-
85
- ### 2. Types vs Instances
86
-
87
- - **Types**: Define what something *is* (like a blueprint)
88
- - **Instances**: Define specific *examples* of that type (like actual objects)
89
-
90
- ### 3. Event Handlers
91
-
92
- To make things move and interact, use event handlers:
93
-
94
- ```javascript
95
- types: {
96
- character: {
97
- // Drawing logic here
98
- draw(ctx, instance) { /* ... */ },
99
-
100
- // Event handlers here
101
- events: {
102
- 'game:update': (instance, event, { dt, config, instances }) => {
103
- // This runs every frame
104
- // Update position, velocity, etc.
105
- }
106
- }
107
- }
108
- }
109
- ```
110
-
111
- ## Next Steps
112
-
113
- Now that you have a basic understanding of the engine, you're ready to dive deeper.
114
-
115
- Continue to the **[Core Concepts](/docs/engine--docs)** page to learn about event handlers, code reuse, and other essential features.
116
-
117
- ## Why Functional Programming?
118
-
119
- Traditional game engines use objects with methods that modify internal state. Inglorious Engine is different:
120
-
121
- ✅ **Predictable**: Same input always produces same output
122
- ✅ **Testable**: Pure functions are easy to test
123
- ✅ **Composable**: Combine behaviors like LEGO blocks
124
- ✅ **Debuggable**: State changes are explicit and traceable
125
- ✅ **Performant**: Immutability enables efficient rendering
126
-
127
- Ready to build your first game? Let's go!
@@ -1,17 +0,0 @@
1
- import UiChooser from "@inglorious/docs/ui-chooser.jsx"
2
-
3
- import firstGame from "./quick-start/first-game.js"
4
- import helloWorld from "./quick-start/hello-world.js"
5
-
6
- export default {
7
- title: "Quick Start",
8
- component: UiChooser,
9
- }
10
-
11
- export const HelloWorld = {
12
- args: { config: helloWorld },
13
- }
14
-
15
- export const FirstGame = {
16
- args: { config: firstGame },
17
- }