sfml.js 1.0.0-rc.1 → 1.0.0-rc.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 (333) hide show
  1. package/README.ja.md +173 -0
  2. package/README.ko.md +173 -0
  3. package/README.md +115 -14
  4. package/README.zh-CN.md +173 -0
  5. package/assets/branding/sfml-js-symbol-pentagon.svg +24 -0
  6. package/assets/branding/sfml-js-wordmark-dark.svg +20 -0
  7. package/assets/branding/sfml-js-wordmark.svg +19 -0
  8. package/assets/breakout.png +0 -0
  9. package/dist/audio/effect-processor.d.ts +53 -8
  10. package/dist/audio/effect-processor.js +35 -5
  11. package/dist/audio/input-sound-file.d.ts +101 -15
  12. package/dist/audio/input-sound-file.js +101 -15
  13. package/dist/audio/listener.d.ts +74 -12
  14. package/dist/audio/listener.js +74 -12
  15. package/dist/audio/music.d.ts +172 -22
  16. package/dist/audio/music.js +185 -24
  17. package/dist/audio/output-sound-file.d.ts +36 -4
  18. package/dist/audio/output-sound-file.js +36 -4
  19. package/dist/audio/playback-device.d.ts +103 -17
  20. package/dist/audio/playback-device.js +97 -16
  21. package/dist/audio/sound-buffer-recorder.d.ts +89 -9
  22. package/dist/audio/sound-buffer-recorder.js +89 -9
  23. package/dist/audio/sound-buffer.d.ts +121 -16
  24. package/dist/audio/sound-buffer.js +98 -13
  25. package/dist/audio/sound-file-factory.d.ts +84 -11
  26. package/dist/audio/sound-file-factory.js +84 -11
  27. package/dist/audio/sound-file-reader.d.ts +155 -24
  28. package/dist/audio/sound-file-reader.js +84 -13
  29. package/dist/audio/sound-file-writer.d.ts +49 -7
  30. package/dist/audio/sound-file-writer.js +13 -2
  31. package/dist/audio/sound-recorder.d.ts +143 -19
  32. package/dist/audio/sound-recorder.js +142 -18
  33. package/dist/audio/sound-source.d.ts +273 -45
  34. package/dist/audio/sound-source.js +273 -45
  35. package/dist/audio/sound-stream.d.ts +57 -9
  36. package/dist/audio/sound-stream.js +43 -7
  37. package/dist/audio/sound.d.ts +32 -5
  38. package/dist/audio/sound.js +32 -5
  39. package/dist/audio/value.d.ts +291 -48
  40. package/dist/audio/value.js +235 -39
  41. package/dist/audio/worker.d.ts +256 -38
  42. package/dist/graphics/blend-mode.d.ts +199 -33
  43. package/dist/graphics/blend-mode.js +163 -27
  44. package/dist/graphics/boolean-vector.d.ts +102 -16
  45. package/dist/graphics/boolean-vector.js +102 -16
  46. package/dist/graphics/circle-shape.d.ts +68 -11
  47. package/dist/graphics/circle-shape.js +37 -6
  48. package/dist/graphics/color.d.ts +227 -42
  49. package/dist/graphics/color.js +177 -32
  50. package/dist/graphics/convex-shape.d.ts +45 -7
  51. package/dist/graphics/convex-shape.js +31 -5
  52. package/dist/graphics/drawable.d.ts +15 -2
  53. package/dist/graphics/drawable.js +6 -1
  54. package/dist/graphics/font.d.ts +153 -24
  55. package/dist/graphics/font.js +116 -18
  56. package/dist/graphics/glsl-matrix.d.ts +44 -7
  57. package/dist/graphics/glsl-matrix.js +44 -7
  58. package/dist/graphics/glsl.d.ts +129 -21
  59. package/dist/graphics/glsl.js +123 -20
  60. package/dist/graphics/glyph.d.ts +106 -17
  61. package/dist/graphics/glyph.js +76 -12
  62. package/dist/graphics/image.d.ts +159 -24
  63. package/dist/graphics/image.js +122 -18
  64. package/dist/graphics/primitive-type.d.ts +42 -7
  65. package/dist/graphics/primitive-type.js +42 -7
  66. package/dist/graphics/rect.d.ts +162 -26
  67. package/dist/graphics/rect.js +101 -16
  68. package/dist/graphics/rectangle-shape.d.ts +44 -7
  69. package/dist/graphics/rectangle-shape.js +31 -5
  70. package/dist/graphics/render-states.d.ts +153 -25
  71. package/dist/graphics/render-states.js +49 -8
  72. package/dist/graphics/render-target.d.ts +145 -22
  73. package/dist/graphics/render-target.js +110 -17
  74. package/dist/graphics/render-texture.d.ts +100 -16
  75. package/dist/graphics/render-texture.js +80 -13
  76. package/dist/graphics/render-window.d.ts +106 -17
  77. package/dist/graphics/render-window.js +57 -9
  78. package/dist/graphics/shader.d.ts +153 -24
  79. package/dist/graphics/shader.js +126 -20
  80. package/dist/graphics/shape.d.ts +133 -21
  81. package/dist/graphics/shape.js +115 -18
  82. package/dist/graphics/sprite.d.ts +71 -11
  83. package/dist/graphics/sprite.js +57 -9
  84. package/dist/graphics/stencil-mode.d.ts +193 -32
  85. package/dist/graphics/stencil-mode.js +121 -20
  86. package/dist/graphics/swap.d.ts +13 -2
  87. package/dist/graphics/text.d.ts +624 -103
  88. package/dist/graphics/text.js +443 -73
  89. package/dist/graphics/texture.d.ts +209 -32
  90. package/dist/graphics/texture.js +137 -21
  91. package/dist/graphics/transform.d.ts +93 -14
  92. package/dist/graphics/transform.js +93 -14
  93. package/dist/graphics/transformable.d.ts +13 -2
  94. package/dist/graphics/transformable.js +13 -2
  95. package/dist/graphics/vertex-array.d.ts +83 -14
  96. package/dist/graphics/vertex-array.js +70 -12
  97. package/dist/graphics/vertex-buffer.d.ts +162 -26
  98. package/dist/graphics/vertex-buffer.js +106 -17
  99. package/dist/graphics/vertex.d.ts +83 -14
  100. package/dist/graphics/vertex.js +43 -7
  101. package/dist/graphics/view.d.ts +140 -22
  102. package/dist/graphics/view.js +103 -16
  103. package/dist/internal/glsl-value.d.ts +30 -5
  104. package/dist/internal/glsl-value.js +30 -5
  105. package/dist/internal/scalar.d.ts +9 -1
  106. package/dist/internal/transformable.d.ts +84 -13
  107. package/dist/internal/value-storage.d.ts +8 -1
  108. package/dist/network/common.d.ts +6 -1
  109. package/dist/network/common.js +6 -1
  110. package/dist/network/dns.d.ts +103 -14
  111. package/dist/network/dns.js +55 -6
  112. package/dist/network/ftp.d.ts +217 -33
  113. package/dist/network/ftp.js +217 -33
  114. package/dist/network/gen/constants.d.ts +750 -124
  115. package/dist/network/gen/constants.js +750 -124
  116. package/dist/network/http.d.ts +365 -57
  117. package/dist/network/http.js +365 -57
  118. package/dist/network/ip-address.d.ts +179 -26
  119. package/dist/network/ip-address.js +164 -24
  120. package/dist/network/packet.d.ts +200 -29
  121. package/dist/network/packet.js +101 -13
  122. package/dist/network/sftp.d.ts +525 -84
  123. package/dist/network/sftp.js +322 -53
  124. package/dist/network/socket-selector.d.ts +109 -15
  125. package/dist/network/socket-selector.js +103 -14
  126. package/dist/network/socket.d.ts +245 -33
  127. package/dist/network/socket.js +205 -28
  128. package/dist/network/tcp-listener.d.ts +91 -13
  129. package/dist/network/tcp-listener.js +85 -12
  130. package/dist/network/tcp-socket.d.ts +232 -33
  131. package/dist/network/tcp-socket.js +153 -22
  132. package/dist/network/tls-material.d.ts +18 -2
  133. package/dist/network/tls-material.js +18 -2
  134. package/dist/network/udp-socket.d.ts +137 -19
  135. package/dist/network/udp-socket.js +101 -13
  136. package/dist/system/angle.d.ts +60 -10
  137. package/dist/system/angle.js +60 -10
  138. package/dist/system/clock.d.ts +51 -8
  139. package/dist/system/clock.js +51 -8
  140. package/dist/system/err.d.ts +14 -2
  141. package/dist/system/err.js +14 -2
  142. package/dist/system/error.d.ts +12 -2
  143. package/dist/system/error.js +12 -2
  144. package/dist/system/file-input-stream.d.ts +54 -7
  145. package/dist/system/file-input-stream.js +54 -7
  146. package/dist/system/input-stream.d.ts +97 -13
  147. package/dist/system/input-stream.js +60 -8
  148. package/dist/system/operators.d.ts +146 -19
  149. package/dist/system/operators.js +118 -15
  150. package/dist/system/sleep.d.ts +6 -1
  151. package/dist/system/sleep.js +6 -1
  152. package/dist/system/suspend-aware-clock.d.ts +18 -3
  153. package/dist/system/suspend-aware-clock.js +18 -3
  154. package/dist/system/time.d.ts +81 -12
  155. package/dist/system/time.js +63 -9
  156. package/dist/system/timeout-with-predicate.d.ts +48 -7
  157. package/dist/system/timeout-with-predicate.js +20 -3
  158. package/dist/system/unicode.d.ts +42 -6
  159. package/dist/system/unicode.js +42 -6
  160. package/dist/system/vector2.d.ts +240 -36
  161. package/dist/system/vector2.js +105 -16
  162. package/dist/system/vector3.d.ts +197 -31
  163. package/dist/system/vector3.js +104 -16
  164. package/dist/system/version.d.ts +43 -7
  165. package/dist/system/version.js +7 -1
  166. package/dist/window/clipboard.d.ts +12 -2
  167. package/dist/window/clipboard.js +12 -2
  168. package/dist/window/context-settings.d.ts +78 -13
  169. package/dist/window/context-settings.js +30 -5
  170. package/dist/window/context.d.ts +70 -10
  171. package/dist/window/context.js +52 -7
  172. package/dist/window/cursor.d.ts +44 -6
  173. package/dist/window/cursor.js +28 -4
  174. package/dist/window/event.d.ts +423 -70
  175. package/dist/window/event.js +36 -6
  176. package/dist/window/gen/constants.d.ts +1890 -314
  177. package/dist/window/gen/constants.js +1890 -314
  178. package/dist/window/joystick.d.ts +67 -11
  179. package/dist/window/joystick.js +43 -7
  180. package/dist/window/keyboard.d.ts +42 -6
  181. package/dist/window/keyboard.js +26 -4
  182. package/dist/window/mouse.d.ts +24 -3
  183. package/dist/window/mouse.js +24 -3
  184. package/dist/window/sensor.d.ts +20 -3
  185. package/dist/window/sensor.js +20 -3
  186. package/dist/window/touch.d.ts +19 -4
  187. package/dist/window/touch.js +19 -4
  188. package/dist/window/video-mode.d.ts +61 -10
  189. package/dist/window/video-mode.js +36 -6
  190. package/dist/window/vulkan.d.ts +26 -3
  191. package/dist/window/vulkan.js +26 -3
  192. package/dist/window/window.d.ts +296 -44
  193. package/dist/window/window.js +241 -34
  194. package/docs/README.ja.md +30 -0
  195. package/docs/README.ko.md +30 -0
  196. package/docs/README.md +30 -0
  197. package/docs/README.zh-CN.md +30 -0
  198. package/docs/api.ja.md +84 -0
  199. package/docs/api.ko.md +84 -0
  200. package/docs/api.md +48 -1080
  201. package/docs/api.zh-CN.md +81 -0
  202. package/docs/audio.ja.md +249 -0
  203. package/docs/audio.ko.md +251 -0
  204. package/docs/audio.md +132 -92
  205. package/docs/audio.zh-CN.md +252 -0
  206. package/docs/concepts.ja.md +130 -0
  207. package/docs/concepts.ko.md +130 -0
  208. package/docs/concepts.md +131 -0
  209. package/docs/concepts.zh-CN.md +131 -0
  210. package/docs/development.ja.md +148 -0
  211. package/docs/development.ko.md +148 -0
  212. package/docs/development.md +115 -42
  213. package/docs/development.zh-CN.md +150 -0
  214. package/docs/getting-started.ja.md +154 -0
  215. package/docs/getting-started.ko.md +154 -0
  216. package/docs/getting-started.md +156 -0
  217. package/docs/getting-started.zh-CN.md +156 -0
  218. package/docs/graphics.ja.md +256 -0
  219. package/docs/graphics.ko.md +254 -0
  220. package/docs/graphics.md +255 -0
  221. package/docs/graphics.zh-CN.md +257 -0
  222. package/docs/network.ja.md +214 -0
  223. package/docs/network.ko.md +216 -0
  224. package/docs/network.md +133 -84
  225. package/docs/network.zh-CN.md +218 -0
  226. package/docs/system.ja.md +169 -0
  227. package/docs/system.ko.md +171 -0
  228. package/docs/system.md +173 -0
  229. package/docs/system.zh-CN.md +173 -0
  230. package/docs/window.ja.md +138 -0
  231. package/docs/window.ko.md +140 -0
  232. package/docs/window.md +141 -0
  233. package/docs/window.zh-CN.md +141 -0
  234. package/package.json +13 -3
  235. package/src/audio/effect-processor.ts +53 -8
  236. package/src/audio/input-sound-file.ts +101 -15
  237. package/src/audio/listener.ts +74 -12
  238. package/src/audio/music.ts +191 -25
  239. package/src/audio/output-sound-file.ts +36 -4
  240. package/src/audio/playback-device.ts +103 -17
  241. package/src/audio/sound-buffer-recorder.ts +89 -9
  242. package/src/audio/sound-buffer.ts +121 -16
  243. package/src/audio/sound-file-factory.ts +84 -11
  244. package/src/audio/sound-file-reader.ts +155 -24
  245. package/src/audio/sound-file-writer.ts +49 -7
  246. package/src/audio/sound-recorder.ts +155 -20
  247. package/src/audio/sound-source.ts +273 -45
  248. package/src/audio/sound-stream.ts +57 -9
  249. package/src/audio/sound.ts +32 -5
  250. package/src/audio/value.ts +291 -48
  251. package/src/audio/worker.ts +256 -38
  252. package/src/graphics/blend-mode.ts +199 -33
  253. package/src/graphics/boolean-vector.ts +102 -16
  254. package/src/graphics/circle-shape.ts +68 -11
  255. package/src/graphics/color.ts +227 -42
  256. package/src/graphics/convex-shape.ts +45 -7
  257. package/src/graphics/drawable.ts +15 -2
  258. package/src/graphics/font.ts +153 -24
  259. package/src/graphics/glsl-matrix.ts +44 -7
  260. package/src/graphics/glsl.ts +129 -21
  261. package/src/graphics/glyph.ts +106 -17
  262. package/src/graphics/image.ts +159 -24
  263. package/src/graphics/primitive-type.ts +42 -7
  264. package/src/graphics/rect.ts +162 -26
  265. package/src/graphics/rectangle-shape.ts +44 -7
  266. package/src/graphics/render-states.ts +153 -25
  267. package/src/graphics/render-target.ts +145 -22
  268. package/src/graphics/render-texture.ts +100 -16
  269. package/src/graphics/render-window.ts +113 -18
  270. package/src/graphics/shader.ts +153 -24
  271. package/src/graphics/shape.ts +133 -21
  272. package/src/graphics/sprite.ts +71 -11
  273. package/src/graphics/stencil-mode.ts +193 -32
  274. package/src/graphics/swap.ts +13 -2
  275. package/src/graphics/text.ts +624 -103
  276. package/src/graphics/texture.ts +209 -32
  277. package/src/graphics/transform.ts +93 -14
  278. package/src/graphics/transformable.ts +13 -2
  279. package/src/graphics/vertex-array.ts +83 -14
  280. package/src/graphics/vertex-buffer.ts +162 -26
  281. package/src/graphics/vertex.ts +83 -14
  282. package/src/graphics/view.ts +140 -22
  283. package/src/internal/glsl-value.ts +30 -5
  284. package/src/internal/scalar.ts +9 -1
  285. package/src/internal/transformable.ts +84 -13
  286. package/src/internal/value-storage.ts +8 -1
  287. package/src/network/common.ts +6 -1
  288. package/src/network/dns.ts +103 -14
  289. package/src/network/ftp.ts +217 -33
  290. package/src/network/gen/constants.ts +750 -124
  291. package/src/network/http.ts +365 -57
  292. package/src/network/ip-address.ts +179 -26
  293. package/src/network/packet.ts +200 -29
  294. package/src/network/sftp.ts +525 -84
  295. package/src/network/socket-selector.ts +109 -15
  296. package/src/network/socket.ts +245 -33
  297. package/src/network/tcp-listener.ts +91 -13
  298. package/src/network/tcp-socket.ts +232 -33
  299. package/src/network/tls-material.ts +18 -2
  300. package/src/network/udp-socket.ts +137 -19
  301. package/src/system/angle.ts +60 -10
  302. package/src/system/clock.ts +51 -8
  303. package/src/system/err.ts +14 -2
  304. package/src/system/error.ts +12 -2
  305. package/src/system/file-input-stream.ts +54 -7
  306. package/src/system/input-stream.ts +97 -13
  307. package/src/system/operators.ts +146 -19
  308. package/src/system/sleep.ts +6 -1
  309. package/src/system/suspend-aware-clock.ts +18 -3
  310. package/src/system/time.ts +81 -12
  311. package/src/system/timeout-with-predicate.ts +48 -7
  312. package/src/system/unicode.ts +42 -6
  313. package/src/system/vector2.ts +240 -36
  314. package/src/system/vector3.ts +197 -31
  315. package/src/system/version.ts +43 -7
  316. package/src/window/clipboard.ts +12 -2
  317. package/src/window/context-settings.ts +78 -13
  318. package/src/window/context.ts +70 -10
  319. package/src/window/cursor.ts +44 -6
  320. package/src/window/event.ts +423 -70
  321. package/src/window/gen/constants.ts +1890 -314
  322. package/src/window/joystick.ts +67 -11
  323. package/src/window/keyboard.ts +42 -6
  324. package/src/window/mouse.ts +24 -3
  325. package/src/window/sensor.ts +20 -3
  326. package/src/window/touch.ts +19 -4
  327. package/src/window/video-mode.ts +61 -10
  328. package/src/window/vulkan.ts +26 -3
  329. package/src/window/window.ts +314 -46
  330. package/tools/constant-docs.cjs +109 -0
  331. package/tools/constant-docs.json +1318 -0
  332. package/tools/generate-network-constants.cjs +21 -9
  333. package/tools/generate-window-constants.cjs +26 -12
package/README.ja.md ADDED
@@ -0,0 +1,173 @@
1
+ <p align="center">
2
+ <img src="./assets/branding/sfml-js-symbol-pentagon.svg" width="80" height="80" align="middle" alt="" />
3
+ <picture>
4
+ <source media="(prefers-color-scheme: dark)" srcset="./assets/branding/sfml-js-wordmark-dark.svg" />
5
+ <img src="./assets/branding/sfml-js-wordmark.svg" width="246" height="68" align="middle" alt="sfml.js" />
6
+ </picture>
7
+ </p>
8
+
9
+ <p align="center">
10
+ <a href="https://www.sfml-dev.org/documentation/3.1.0/">SFML 3.1.0</a> を基盤とする、Node.js 向けのネイティブウィンドウ、2D グラフィックス、オーディオ。
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://www.npmjs.org/package/sfml.js">
15
+ <img src="https://img.shields.io/npm/v/sfml.js.svg?style=for-the-badge&colorA=FF7800&colorB=CC5600&label=NPM" alt="npm バージョン" />
16
+ </a>
17
+ <a href="https://www.npmjs.org/package/sfml.js">
18
+ <img src="https://img.shields.io/npm/dm/sfml.js.svg?style=for-the-badge&colorA=5DDB61&colorB=4BC74F&label=DOWNLOADS" alt="npm ダウンロード数" />
19
+ </a>
20
+ <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
21
+ <a href="#contributors-"><img src="https://img.shields.io/badge/3-ALL%20CONTRIBUTORS?style=for-the-badge&colorA=FF69b4&colorB=cc47a4&label=ALL%20CONTRIBUTORS" alt="3 contributors" /></a>
22
+ <!-- ALL-CONTRIBUTORS-BADGE:END -->
23
+ <a href="https://github.com/XadillaX/node-sfml">
24
+ <img src="https://img.shields.io/github/stars/XadillaX/node-sfml.svg?style=for-the-badge&colorA=FBBD30&colorB=F2AA08&label=STAR" alt="GitHub スター数" />
25
+ </a>
26
+ </p>
27
+
28
+ [English](README.md) / [简体中文](README.zh-CN.md) / **日本語** / [한국어](README.ko.md)
29
+
30
+ JavaScript や TypeScript でデスクトップ向けマルチメディアアプリケーションを開発できます。スプライト、図形、テキストの描画、ウィンドウイベントの処理、音声の再生と録音、SFML スタイルのネットワーク API によるデータ交換に対応しています。
31
+
32
+ [公式サイト](https://sfml.js.org/ja/) · [クイックスタート](docs/getting-started.ja.md) · [ガイド](docs/README.ja.md) · [型リファレンス](https://sfml.js.org/ja/reference/) · [サンプル](examples/README.ja.md)
33
+
34
+ ## 提供する機能
35
+
36
+ | モジュール | 機能 |
37
+ | --- | --- |
38
+ | System | 型付きベクトル、角度、時間、クロック、Unicode の変換境界、シーク可能な入力ストリーム |
39
+ | Window | ネイティブウィンドウ、型付きイベント、キーボード、マウス、ジョイスティック、クリップボード、OpenGL コンテキスト |
40
+ | Graphics | スプライト、図形、Unicode テキスト、カメラ、シェーダー、頂点バッファ、オフスクリーン描画 |
41
+ | Audio | 効果音、音楽のストリーミング再生、録音、空間オーディオ、Worker による処理 |
42
+ | Network | Node.js のトランスポートを利用した TCP、UDP、パケット、DNS、TLS、HTTP、FTP、SFTP |
43
+
44
+ TypeScript の型宣言を同梱しています。数値とリソースのビューには型付き配列を使い、描画時には状態のスナップショットを記録してコマンドをまとめて送信します。所有権、非同期読み込み、描画の挙動については[基本概念](docs/concepts.ja.md)を参照してください。
45
+
46
+ ## インストール
47
+
48
+ ```bash
49
+ npm install sfml.js
50
+ ```
51
+
52
+ インストール時にネイティブアドオンをコンパイルし、対応する SFML ライブラリをダウンロードします。事前に **Python と C++20 ツールチェーン**を用意してください。
53
+
54
+ | プラットフォーム | ダウンロード対象 | ビルドツール |
55
+ | --- | --- | --- |
56
+ | macOS 13+ | x64、arm64 | Xcode Command Line Tools |
57
+ | Linux | x64 | GCC または Clang、make、X11、OpenGL とオーディオの開発用ライブラリ |
58
+ | Windows | x64、ia32 | Visual Studio 2022 C++ Build Tools |
59
+
60
+ パッケージが宣言する Node.js の対応範囲は `^18.19.0 || >=20.5.0` です。CI は Linux、macOS、Windows の Node.js 20 と 22 向けに設定されています。ダウンロード対象であることは、すべてのアーキテクチャやデバイスでテスト済みであることを意味しません。プラットフォーム別のコマンドは[インストール手順](docs/getting-started.ja.md#requirements)を参照してください。
61
+
62
+ ## 最初のウィンドウ
63
+
64
+ 以下を `hello.cjs` として保存し、`node hello.cjs` で実行します。
65
+
66
+ ```javascript
67
+ const sf = require('sfml.js');
68
+
69
+ const window = new sf.RenderWindow(
70
+ new sf.VideoMode(new sf.Vector2u(800, 600)),
71
+ 'Hello, sfml.js',
72
+ );
73
+ const circle = new sf.CircleShape({ radius: 80 });
74
+ circle.setPosition(new sf.Vector2f(320, 220));
75
+ circle.setFillColor(new sf.Color(76, 190, 110));
76
+ window.setFramerateLimit(60);
77
+
78
+ function frame() {
79
+ window.handleEvents({
80
+ Closed: () => window.close(),
81
+ KeyPressed: event => {
82
+ if (event.code === sf.Keyboard.Key.Escape) window.close();
83
+ },
84
+ });
85
+ if (!window.isOpen()) return;
86
+
87
+ window.clear(new sf.Color(24, 28, 32));
88
+ window.draw(circle);
89
+ window.display();
90
+ setImmediate(frame);
91
+ }
92
+
93
+ frame();
94
+ ```
95
+
96
+ このサンプルはネイティブのデスクトップウィンドウを作成します。グラフィカルセッション内で実行してください。`setImmediate()` によって、フレーム間で Node.js が I/O を処理できます。`display()` は同期メソッドであり、フレームレート制限や垂直同期のために待機する場合があります。
97
+
98
+ TypeScript では `import { RenderWindow, Vector2u } from 'sfml.js'` のように名前付きインポートを使います。ファイルの読み込みには Promise を使用します。
99
+
100
+ ```javascript
101
+ async function loadSprite(filename) {
102
+ const texture = new sf.Texture();
103
+ if (!await texture.loadFromFile(filename)) {
104
+ throw new Error(`Cannot load texture: ${filename}`);
105
+ }
106
+ return new sf.Sprite(texture);
107
+ }
108
+ ```
109
+
110
+ ## ドキュメント
111
+
112
+ README とガイドは英語、簡体字中国語、日本語、韓国語で提供しています。既定の言語は英語です。
113
+
114
+ | 入口 | 内容 |
115
+ | --- | --- |
116
+ | [クイックスタート](docs/getting-started.ja.md) | インストール、インポート、最初のウィンドウ |
117
+ | [基本概念](docs/concepts.ja.md) | 値、リソースの寿命、Promise、描画スナップショット |
118
+ | [API ガイド](docs/api.ja.md) | System、Window、Graphics、Audio、Network への案内 |
119
+ | [サンプル](examples/README.ja.md) | 実行可能なプログラムと操作方法 |
120
+ | [開発ガイド](docs/development.ja.md) | ビルド、テスト、コントリビュート |
121
+
122
+ [TypeDoc](https://sfml.js.org/ja/reference/) では、生成されたシグネチャとソースコードのコメントを参照できます。[SFML の C++ ドキュメント](https://www.sfml-dev.org/documentation/3.1.0/)は上流 API を説明しており、このリポジトリのガイドは JavaScript 固有の挙動を説明しています。
123
+
124
+ ## サンプルの実行
125
+
126
+ ![sfml.js のネイティブウィンドウで動くブロック崩し](assets/breakout.png)
127
+
128
+ [breakout.cjs](examples/breakout.cjs) の実行画面です。図形、キーボード入力、ゲームループを JavaScript で実装しています。左右キーまたは A/D で移動、Space で発射、Esc で終了します。
129
+
130
+ ```bash
131
+ git clone https://github.com/XadillaX/node-sfml.git
132
+ cd node-sfml
133
+ npm ci
134
+ node examples/breakout.cjs
135
+ node examples/all-types.cjs --frames=120
136
+ node examples/network.cjs
137
+ ```
138
+
139
+ [移植済みサンプル](examples/ported/README.ja.md)は、従来のデモを SFML 3 API に適合させたものです。`drawAsync()` または `displayAsync()` を必要とする 2 つのサンプルは `UNSUPPORTED` を報告します。このバインディングでは、これらのメソッドを公開していません。
140
+
141
+ [node-sfml-demos](https://github.com/XadillaX/node-sfml-demos) と [play-nes](https://github.com/XadillaX/play-nes) は旧 API で開発されたプロジェクトであり、移行が必要です。
142
+
143
+ ## コントリビュート
144
+
145
+ [開発ガイド](docs/development.ja.md)に従って環境を用意してください。不具合修正、ドキュメント、サンプルのプルリクエストを歓迎します。不具合の報告には、実行可能な再現例と、Node.js のバージョン、OS、アーキテクチャを添えてください。
146
+
147
+ <a id="contributors-"></a>
148
+ <a id="maintenance-XadillaX"></a>
149
+
150
+ ## コントリビューター ✨
151
+
152
+ 以下の皆さんに感謝します([絵文字の凡例](https://allcontributors.org/docs/en/emoji-key))。
153
+
154
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
155
+ <!-- prettier-ignore-start -->
156
+ <!-- markdownlint-disable -->
157
+ <table>
158
+ <tr>
159
+ <td align="center"><a href="https://xcoder.in/"><img src="https://avatars.githubusercontent.com/u/2842176?v=4&amp;s=100" width="100px;" alt="Khaidi Chu"/><br /><sub><b>Khaidi Chu</b></sub></a><br /><a href="#maintenance-XadillaX" title="Maintenance">🚧</a> <a href="https://github.com/XadillaX/node-sfml/commits?author=XadillaX" title="Code">💻</a></td>
160
+ <td align="center"><a href="https://pokemonworkshop.com/forum"><img src="https://avatars.githubusercontent.com/u/7335788?v=4&amp;s=100" width="100px;" alt="NuriYuri"/><br /><sub><b>NuriYuri</b></sub></a><br /><a href="https://github.com/XadillaX/node-sfml/commits?author=NuriYuri" title="Code">💻</a></td>
161
+ <td align="center"><a href="https://godot.id"><img src="https://avatars.githubusercontent.com/u/40712686?v=4&amp;s=100" width="100px;" alt="Hanz"/><br /><sub><b>Hanz</b></sub></a><br /><a href="https://github.com/XadillaX/node-sfml/commits?author=HanzCEO" title="Code">💻</a></td>
162
+ </tr>
163
+ </table>
164
+
165
+ <!-- markdownlint-restore -->
166
+ <!-- prettier-ignore-end -->
167
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
168
+
169
+ このプロジェクトは [all-contributors](https://github.com/all-contributors/all-contributors) の仕様に従っています。どのような形での貢献も歓迎します。
170
+
171
+ ## ライセンス
172
+
173
+ [MIT](LICENSE)。
package/README.ko.md ADDED
@@ -0,0 +1,173 @@
1
+ <p align="center">
2
+ <img src="./assets/branding/sfml-js-symbol-pentagon.svg" width="80" height="80" align="middle" alt="" />
3
+ <picture>
4
+ <source media="(prefers-color-scheme: dark)" srcset="./assets/branding/sfml-js-wordmark-dark.svg" />
5
+ <img src="./assets/branding/sfml-js-wordmark.svg" width="246" height="68" align="middle" alt="sfml.js" />
6
+ </picture>
7
+ </p>
8
+
9
+ <p align="center">
10
+ <a href="https://www.sfml-dev.org/documentation/3.1.0/">SFML 3.1.0</a>을 기반으로 Node.js에 네이티브 창, 2D 그래픽, 오디오 기능을 제공합니다.
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://www.npmjs.org/package/sfml.js">
15
+ <img src="https://img.shields.io/npm/v/sfml.js.svg?style=for-the-badge&colorA=FF7800&colorB=CC5600&label=NPM" alt="npm 버전" />
16
+ </a>
17
+ <a href="https://www.npmjs.org/package/sfml.js">
18
+ <img src="https://img.shields.io/npm/dm/sfml.js.svg?style=for-the-badge&colorA=5DDB61&colorB=4BC74F&label=DOWNLOADS" alt="npm 다운로드 수" />
19
+ </a>
20
+ <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
21
+ <a href="#contributors-"><img src="https://img.shields.io/badge/3-ALL%20CONTRIBUTORS?style=for-the-badge&colorA=FF69b4&colorB=cc47a4&label=ALL%20CONTRIBUTORS" alt="3 contributors" /></a>
22
+ <!-- ALL-CONTRIBUTORS-BADGE:END -->
23
+ <a href="https://github.com/XadillaX/node-sfml">
24
+ <img src="https://img.shields.io/github/stars/XadillaX/node-sfml.svg?style=for-the-badge&colorA=FBBD30&colorB=F2AA08&label=STAR" alt="GitHub 스타 수" />
25
+ </a>
26
+ </p>
27
+
28
+ [English](README.md) / [简体中文](README.zh-CN.md) / [日本語](README.ja.md) / **한국어**
29
+
30
+ JavaScript나 TypeScript로 데스크톱 멀티미디어 애플리케이션을 만드세요. 스프라이트, 도형, 텍스트를 그리고, 창 이벤트를 처리하며, 오디오를 재생하고 녹음하고, SFML 스타일의 네트워크 API로 데이터를 주고받을 수 있습니다.
31
+
32
+ [웹사이트](https://sfml.js.org/ko/) · [빠른 시작](docs/getting-started.ko.md) · [가이드](docs/README.ko.md) · [타입 레퍼런스](https://sfml.js.org/ko/reference/) · [예제](examples/README.ko.md)
33
+
34
+ ## 제공 기능
35
+
36
+ | 모듈 | 기능 |
37
+ | --- | --- |
38
+ | System | 타입이 지정된 벡터, 각도, 시간, 시계, Unicode 경계, 탐색 가능한 입력 스트림 |
39
+ | Window | 네이티브 창, 타입이 지정된 이벤트, 키보드, 마우스, 조이스틱, 클립보드, OpenGL 컨텍스트 |
40
+ | Graphics | 스프라이트, 도형, Unicode 텍스트, 카메라, 셰이더, 정점 버퍼, 오프스크린 렌더링 |
41
+ | Audio | 효과음, 스트리밍 음악, 녹음, 공간 오디오, Worker 기반 처리 |
42
+ | Network | Node.js 전송 계층을 통한 TCP, UDP, 패킷, DNS, TLS, HTTP, FTP, SFTP |
43
+
44
+ TypeScript 선언이 포함되어 있습니다. 수치 값과 리소스 뷰에는 타입 배열을 사용하며, 렌더링은 상태 스냅샷을 기록한 뒤 명령을 일괄 제출합니다. 소유권, 비동기 로딩, 렌더링 동작은 [핵심 개념](docs/concepts.ko.md)을 참고하세요.
45
+
46
+ ## 설치
47
+
48
+ ```bash
49
+ npm install sfml.js
50
+ ```
51
+
52
+ 설치 과정에서 네이티브 애드온을 컴파일하고 호환되는 SFML 라이브러리를 다운로드합니다. 설치 전에 **Python과 C++20 도구 체인**을 준비하세요.
53
+
54
+ | 플랫폼 | 다운로드 대상 | 빌드 도구 |
55
+ | --- | --- | --- |
56
+ | macOS 13+ | x64, arm64 | Xcode Command Line Tools |
57
+ | Linux | x64 | GCC 또는 Clang, make, X11, OpenGL 및 오디오 개발 라이브러리 |
58
+ | Windows | x64, ia32 | Visual Studio 2022 C++ Build Tools |
59
+
60
+ 패키지에 선언된 Node.js 지원 범위는 `^18.19.0 || >=20.5.0`이며, CI는 Linux, macOS, Windows에서 Node.js 20과 22를 사용하도록 구성되어 있습니다. 다운로드 대상으로 제공된다고 해서 모든 아키텍처와 장치를 테스트했다는 뜻은 아닙니다. 플랫폼별 명령은 [설치 안내](docs/getting-started.ko.md#requirements)를 참고하세요.
61
+
62
+ ## 첫 번째 창
63
+
64
+ 다음 코드를 `hello.cjs`로 저장하고 `node hello.cjs`를 실행하세요.
65
+
66
+ ```javascript
67
+ const sf = require('sfml.js');
68
+
69
+ const window = new sf.RenderWindow(
70
+ new sf.VideoMode(new sf.Vector2u(800, 600)),
71
+ 'Hello, sfml.js',
72
+ );
73
+ const circle = new sf.CircleShape({ radius: 80 });
74
+ circle.setPosition(new sf.Vector2f(320, 220));
75
+ circle.setFillColor(new sf.Color(76, 190, 110));
76
+ window.setFramerateLimit(60);
77
+
78
+ function frame() {
79
+ window.handleEvents({
80
+ Closed: () => window.close(),
81
+ KeyPressed: event => {
82
+ if (event.code === sf.Keyboard.Key.Escape) window.close();
83
+ },
84
+ });
85
+ if (!window.isOpen()) return;
86
+
87
+ window.clear(new sf.Color(24, 28, 32));
88
+ window.draw(circle);
89
+ window.display();
90
+ setImmediate(frame);
91
+ }
92
+
93
+ frame();
94
+ ```
95
+
96
+ 이 예제는 네이티브 데스크톱 창을 생성합니다. 그래픽 세션에서 실행하세요. `setImmediate()`는 프레임 사이에 Node.js가 I/O를 처리할 수 있게 합니다. `display()`는 동기식이며, 프레임 제한이나 수직 동기화를 위해 대기할 수 있습니다.
97
+
98
+ TypeScript에서는 `import { RenderWindow, Vector2u } from 'sfml.js'`와 같은 이름 있는 가져오기를 사용합니다. 파일 로딩은 Promise를 사용합니다.
99
+
100
+ ```javascript
101
+ async function loadSprite(filename) {
102
+ const texture = new sf.Texture();
103
+ if (!await texture.loadFromFile(filename)) {
104
+ throw new Error(`Cannot load texture: ${filename}`);
105
+ }
106
+ return new sf.Sprite(texture);
107
+ }
108
+ ```
109
+
110
+ ## 문서
111
+
112
+ README와 가이드는 영어, 중국어 간체, 일본어, 한국어로 제공됩니다. 기본 언어는 영어입니다.
113
+
114
+ | 시작 문서 | 다루는 내용 |
115
+ | --- | --- |
116
+ | [빠른 시작](docs/getting-started.ko.md) | 설치, 가져오기, 첫 번째 창 |
117
+ | [핵심 개념](docs/concepts.ko.md) | 값, 리소스 수명, Promise, 그리기 스냅샷 |
118
+ | [API 가이드](docs/api.ko.md) | System, Window, Graphics, Audio, Network 안내 |
119
+ | [예제](examples/README.ko.md) | 실행 가능한 프로그램과 조작 방법 |
120
+ | [개발](docs/development.ko.md) | 빌드, 테스트, 기여 |
121
+
122
+ [TypeDoc](https://sfml.js.org/ko/reference/)은 자동 생성된 시그니처와 소스 주석을 제공합니다. [SFML C++ 문서](https://www.sfml-dev.org/documentation/3.1.0/)는 업스트림 API를 설명하며, 이 저장소의 가이드는 JavaScript 고유의 동작을 설명합니다.
123
+
124
+ ## 예제 실행
125
+
126
+ ![sfml.js 네이티브 창에서 실행되는 벽돌 깨기 게임](assets/breakout.png)
127
+
128
+ [breakout.cjs](examples/breakout.cjs)의 실행 화면입니다. 도형, 키보드 입력, 게임 루프를 JavaScript로 구현했습니다. 왼쪽/오른쪽 방향키 또는 A/D로 이동하고, Space로 발사하며, Esc로 종료합니다.
129
+
130
+ ```bash
131
+ git clone https://github.com/XadillaX/node-sfml.git
132
+ cd node-sfml
133
+ npm ci
134
+ node examples/breakout.cjs
135
+ node examples/all-types.cjs --frames=120
136
+ node examples/network.cjs
137
+ ```
138
+
139
+ [포팅된 예제](examples/ported/README.ko.md)는 기존 데모를 유지하면서 SFML 3 API에 맞게 조정한 것입니다. `drawAsync()` 또는 `displayAsync()`가 필요한 두 예제는 `UNSUPPORTED`를 출력합니다. 이 바인딩에서는 해당 메서드를 제공하지 않습니다.
140
+
141
+ [node-sfml-demos](https://github.com/XadillaX/node-sfml-demos)와 [play-nes](https://github.com/XadillaX/play-nes)는 이전 API로 제작된 프로젝트이므로 마이그레이션이 필요합니다.
142
+
143
+ ## 기여하기
144
+
145
+ [개발 가이드](docs/development.ko.md)에 따라 환경을 준비하세요. 수정, 문서, 예제에 관한 풀 리퀘스트를 환영합니다. 버그를 보고할 때는 실행 가능한 재현 코드와 함께 Node.js 버전, 운영체제, 아키텍처를 포함해 주세요.
146
+
147
+ <a id="contributors-"></a>
148
+ <a id="maintenance-XadillaX"></a>
149
+
150
+ ## 기여자 ✨
151
+
152
+ 다음 분들께 감사드립니다([이모지 설명](https://allcontributors.org/docs/en/emoji-key)).
153
+
154
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
155
+ <!-- prettier-ignore-start -->
156
+ <!-- markdownlint-disable -->
157
+ <table>
158
+ <tr>
159
+ <td align="center"><a href="https://xcoder.in/"><img src="https://avatars.githubusercontent.com/u/2842176?v=4&amp;s=100" width="100px;" alt="Khaidi Chu"/><br /><sub><b>Khaidi Chu</b></sub></a><br /><a href="#maintenance-XadillaX" title="Maintenance">🚧</a> <a href="https://github.com/XadillaX/node-sfml/commits?author=XadillaX" title="Code">💻</a></td>
160
+ <td align="center"><a href="https://pokemonworkshop.com/forum"><img src="https://avatars.githubusercontent.com/u/7335788?v=4&amp;s=100" width="100px;" alt="NuriYuri"/><br /><sub><b>NuriYuri</b></sub></a><br /><a href="https://github.com/XadillaX/node-sfml/commits?author=NuriYuri" title="Code">💻</a></td>
161
+ <td align="center"><a href="https://godot.id"><img src="https://avatars.githubusercontent.com/u/40712686?v=4&amp;s=100" width="100px;" alt="Hanz"/><br /><sub><b>Hanz</b></sub></a><br /><a href="https://github.com/XadillaX/node-sfml/commits?author=HanzCEO" title="Code">💻</a></td>
162
+ </tr>
163
+ </table>
164
+
165
+ <!-- markdownlint-restore -->
166
+ <!-- prettier-ignore-end -->
167
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
168
+
169
+ 이 프로젝트는 [all-contributors](https://github.com/all-contributors/all-contributors) 명세를 따릅니다. 어떤 형태의 기여든 환영합니다!
170
+
171
+ ## 라이선스
172
+
173
+ [MIT](LICENSE).
package/README.md CHANGED
@@ -1,9 +1,13 @@
1
1
  <p align="center">
2
- <img src="https://github.com/XadillaX/node-sfml/blob/main/assets/sfml.js.png?raw=true" alt="sfml.js" />
2
+ <img src="./assets/branding/sfml-js-symbol-pentagon.svg" width="80" height="80" align="middle" alt="" />
3
+ <picture>
4
+ <source media="(prefers-color-scheme: dark)" srcset="./assets/branding/sfml-js-wordmark-dark.svg" />
5
+ <img src="./assets/branding/sfml-js-wordmark.svg" width="246" height="68" align="middle" alt="sfml.js" />
6
+ </picture>
3
7
  </p>
4
8
 
5
9
  <p align="center">
6
- Node.js binding for <a href="https://www.sfml-dev.org/">SFML</a> - a Simple and Fast cross-platform Multimedia Library.
10
+ Native windows, 2D graphics and audio for Node.js, built on <a href="https://www.sfml-dev.org/documentation/3.1.0/">SFML 3.1.0</a>.
7
11
  </p>
8
12
 
9
13
  <p align="center">
@@ -21,30 +25,127 @@ Node.js binding for <a href="https://www.sfml-dev.org/">SFML</a> - a Simple and
21
25
  </a>
22
26
  </p>
23
27
 
28
+ **English** · [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [한국어](README.ko.md)
29
+
30
+ Build desktop multimedia applications in JavaScript or TypeScript: draw sprites, shapes and text, handle window events, play and record audio, and exchange data through SFML-style networking APIs.
31
+
32
+ [Website](https://sfml.js.org/) · [Quick start](docs/getting-started.md) · [Guides](docs/README.md) · [Type reference](https://sfml.js.org/reference/) · [Examples](examples/README.md)
33
+
34
+ ## What is included
35
+
36
+ | Module | Capabilities |
37
+ | --- | --- |
38
+ | System | Typed vectors, angles, time, clocks, Unicode boundaries and seekable input streams |
39
+ | Window | Native windows, typed events, keyboard, mouse, joystick, clipboard and OpenGL contexts |
40
+ | Graphics | Sprites, shapes, Unicode text, cameras, shaders, vertex buffers and off-screen rendering |
41
+ | Audio | Sound effects, streaming music, recording, spatial audio and Worker-based processing |
42
+ | Network | TCP, UDP, packets, DNS, TLS, HTTP, FTP and SFTP through Node.js transports |
43
+
44
+ TypeScript declarations are included. Numeric values and resource views use typed arrays; rendering records state snapshots and submits commands in batches. See [core concepts](docs/concepts.md) for ownership, asynchronous loading and rendering behavior.
45
+
24
46
  ## Installation
25
47
 
26
48
  ```bash
27
49
  npm install sfml.js
28
50
  ```
29
51
 
30
- Requires Node.js `^18.19.0 || >=20.5.0`. Installation builds a native addon; see the [build prerequisites](docs/development.md#准备环境).
52
+ Installation compiles a native addon and downloads the matching SFML libraries. Prepare **Python and a C++20 toolchain** before installing:
53
+
54
+ | Platform | Download targets | Build tools |
55
+ | --- | --- | --- |
56
+ | macOS 13+ | x64, arm64 | Xcode Command Line Tools |
57
+ | Linux | x64 | GCC or Clang, make, X11, OpenGL and audio development libraries |
58
+ | Windows | x64, ia32 | Visual Studio 2022 C++ Build Tools |
59
+
60
+ The package declares Node.js `^18.19.0 || >=20.5.0`; CI is configured for Node.js 20 and 22 on Linux, macOS and Windows. Download targets are not a claim that every architecture and device is tested. See [installation instructions](docs/getting-started.md#requirements) for platform commands.
31
61
 
32
- ## Usage
62
+ ## Your first window
63
+
64
+ Save this as `hello.cjs` and run `node hello.cjs`:
65
+
66
+ ```javascript
67
+ const sf = require('sfml.js');
68
+
69
+ const window = new sf.RenderWindow(
70
+ new sf.VideoMode(new sf.Vector2u(800, 600)),
71
+ 'Hello, sfml.js',
72
+ );
73
+ const circle = new sf.CircleShape({ radius: 80 });
74
+ circle.setPosition(new sf.Vector2f(320, 220));
75
+ circle.setFillColor(new sf.Color(76, 190, 110));
76
+ window.setFramerateLimit(60);
77
+
78
+ function frame() {
79
+ window.handleEvents({
80
+ Closed: () => window.close(),
81
+ KeyPressed: event => {
82
+ if (event.code === sf.Keyboard.Key.Escape) window.close();
83
+ },
84
+ });
85
+ if (!window.isOpen()) return;
86
+
87
+ window.clear(new sf.Color(24, 28, 32));
88
+ window.draw(circle);
89
+ window.display();
90
+ setImmediate(frame);
91
+ }
92
+
93
+ frame();
94
+ ```
95
+
96
+ The example creates a native desktop window. Run it in a graphical session. `setImmediate()` lets Node.js process I/O between frames; `display()` is synchronous and can wait for the frame limit or vertical sync.
97
+
98
+ For TypeScript, use named imports such as `import { RenderWindow, Vector2u } from 'sfml.js'`. File loading uses promises:
99
+
100
+ ```javascript
101
+ async function loadSprite(filename) {
102
+ const texture = new sf.Texture();
103
+ if (!await texture.loadFromFile(filename)) {
104
+ throw new Error(`Cannot load texture: ${filename}`);
105
+ }
106
+ return new sf.Sprite(texture);
107
+ }
108
+ ```
109
+
110
+ ## Documentation
111
+
112
+ The README and guides are available in English, Simplified Chinese, Japanese and Korean. English is the default.
113
+
114
+ | Start here | Continue with |
115
+ | --- | --- |
116
+ | [Quick start](docs/getting-started.md) | Installation, imports and your first window |
117
+ | [Core concepts](docs/concepts.md) | Values, resource lifetime, promises and draw snapshots |
118
+ | [API guide](docs/api.md) | System, Window, Graphics, Audio and Network navigation |
119
+ | [Examples](examples/README.md) | Runnable programs and their controls |
120
+ | [Development](docs/development.md) | Building, testing and contributing |
121
+
122
+ [TypeDoc](https://sfml.js.org/reference/) provides generated signatures and source comments. [SFML's C++ documentation](https://www.sfml-dev.org/documentation/3.1.0/) explains the upstream API; the guides here document JavaScript-specific behavior.
123
+
124
+ ## Run the examples
125
+
126
+ ![Breakout running in a native sfml.js window](assets/breakout.png)
127
+
128
+ Captured from [breakout.cjs](examples/breakout.cjs), a playable game using shapes, keyboard input and a JavaScript game loop. Move with Left/Right or A/D, launch with Space, and exit with Esc.
129
+
130
+ ```bash
131
+ git clone https://github.com/XadillaX/node-sfml.git
132
+ cd node-sfml
133
+ npm ci
134
+ node examples/breakout.cjs
135
+ node examples/all-types.cjs --frames=120
136
+ node examples/network.cjs
137
+ ```
33
138
 
34
- - TypeDoc: [https://sfml.js.org/](https://sfml.js.org/);
35
- - API reference: [System, Window & Graphics](docs/api.md), [Audio](docs/audio.md), [Network](docs/network.md);
36
- - TypeScript declarations are included in the package. See the [API exports](src/index.ts);
37
- - SFML's official documentation: [SFML 3.1.0](https://www.sfml-dev.org/documentation/3.1.0/).
139
+ The [ported examples](examples/ported/README.md) retain the legacy demonstrations with SFML 3 API adaptations. The two examples requiring `drawAsync()` or `displayAsync()` report `UNSUPPORTED`; those methods are not exposed by this binding.
38
140
 
39
- ## Examples
141
+ [node-sfml-demos](https://github.com/XadillaX/node-sfml-demos) and [play-nes](https://github.com/XadillaX/play-nes) are projects built with the legacy API and require migration.
40
142
 
41
- - [Examples in this repository](examples/): Graphics, audio, window events and networking;
42
- - [node-sfml-demos](https://github.com/XadillaX/node-sfml-demos): Several small example games built with the legacy API;
43
- - [play-nes](https://github.com/XadillaX/play-nes): A cross-platform desktop NES emulator powered by OpenGL in Node.js, built with the legacy API.
143
+ ## Contributing
44
144
 
45
- > PR is welcomed. You can add your own sfml.js example.
145
+ Use the [development guide](docs/development.md) to prepare your environment. Pull requests for fixes, documentation and examples are welcome. Include a runnable reproduction with bug reports, together with the Node.js version, operating system and architecture.
46
146
 
47
- For running repository examples or contributing, see the [development guide](docs/development.md).
147
+ <a id="contributors-"></a>
148
+ <a id="maintenance-XadillaX"></a>
48
149
 
49
150
  ## Contributors ✨
50
151