@bornengine/engine 0.4.16 → 0.5.1

package/README.md

@@ -1,5 +1,9 @@
 # BornEngine
 
+<p align="center">
+  <img src="webpage/public/brand/bornengine-mark.png" alt="BornEngine mark" width="96">
+</p>
+
 **Native games from TypeScript.**
 
 Write TypeScript. Ship native games — and now the web too.
@@ -71,13 +75,15 @@ drawText("Hello, BornEngine!", 190, 200, 20, Colors.DARKGRAY);
 Build for web:
 
 ```bash
-./native/web/build.sh main.ts
+./native/web/build.sh --dev main.ts
 cd dist/web && python3 -m http.server 8080
 ```
 
+Use `--release` (the default) for optimized builds.
+
 ## Features
 
-- **Simple API** — Functions, not classes. The entire API fits on a cheatsheet. ([design rationale](docs/design-api.md))
+- **Two gameplay styles** — Use the flat function-and-handle API directly, or build with the optional class-based GameObject runtime. ([design rationale](docs/design-api.md), [game objects](docs/game-objects.md))
 - **True native** — Compiles to Metal, DirectX 12, Vulkan, OpenGL, and WebGPU via wgpu.
 - **Ship everywhere** — macOS, Windows, Linux, iOS, tvOS, Android, and Web from one codebase.
 - **Unified 2D/3D** — Shapes, textures, text, 3D models, and audio in one engine.
@@ -85,10 +91,11 @@ cd dist/web && python3 -m http.server 8080
 
 ## How BornEngine relates to raylib
 
-BornEngine's public API is heavily inspired by [raylib](https://github.com/raysan5/raylib).
+BornEngine's low-level modules are heavily inspired by [raylib](https://github.com/raysan5/raylib).
 raylib's API is, in our opinion, one of the best in the gamedev space — a flat library
-of plain functions, no classes, small enough to learn from a cheatsheet — so we model
-ours on it. You'll recognize the shape immediately: `initWindow`, `beginDrawing`,
+of plain functions, small enough to learn from a cheatsheet — so those modules follow
+that shape. The optional game module adds class-based gameplay objects. You'll recognize
+the low-level API immediately: `initWindow`, `beginDrawing`,
 `clearBackground`, `drawText`, and modules named core / shapes / textures / text /
 audio / models.
 
@@ -105,6 +112,7 @@ setting the bar. ([full design rationale](docs/design-api.md))
 | Module | Import | Description |
 |--------|--------|-------------|
 | **Core** | `@bornengine/engine/core` | Window, game loop, input, timing |
+| **Game** | `@bornengine/engine/game` | GameObjects, components, transforms, scenes, and native-handle adapters ([docs](docs/game-objects.md)) |
 | **Shapes** | `@bornengine/engine/shapes` | 2D drawing + collision detection |
 | **Textures** | `@bornengine/engine/textures` | Image loading, sprite batching |
 | **Text** | `@bornengine/engine/text` | TTF/OTF font loading and rendering |
@@ -135,6 +143,7 @@ setting the bar. ([full design rationale](docs/design-api.md))
 ```
 src/                  TypeScript API
   core/               Window, input, game loop
+  game/               GameObjects, components, transforms, adapters
   shapes/             2D shapes + collision
   textures/           Image loading, sprites
   text/               Font rendering
@@ -156,9 +165,9 @@ examples/
   pong/               Complete working example (~170 lines)
 ```
 
-## Types
+## Core data types
 
-Plain interfaces, no classes:
+The native function modules use plain data interfaces and numeric resource handles:
 
 ```typescript
 interface Vec2 { x: number; y: number }
@@ -215,17 +224,18 @@ Key functions:
 
 For the full pipeline (Blender export, pitfalls, architecture), see [docs/skeletal-animation.md](docs/skeletal-animation.md).
 
-## Made with Bloom
+## Built with the original Bloom Engine
 
-**[Bloom Jump](https://apps.apple.com/us/app/bloom-jump/id6761447092)** — our first shipped game and a proof point for the engine. A free retro pixel platformer with five hand-crafted levels, 60 FPS, and an original chiptune soundtrack, built entirely with Bloom from one TypeScript codebase running natively on every target.
+**[Bloom Jump](https://apps.apple.com/us/app/bloom-jump/id6761447092)** was released under the original Bloom Engine name before this fork continued as BornEngine. It remains a historical Bloom-branded release, not a BornEngine-branded game. It's a free retro pixel platformer with five hand-crafted levels, 60 FPS, and an original chiptune soundtrack, built from one TypeScript codebase.
 
 - [App Store](https://apps.apple.com/us/app/bloom-jump/id6761447092) — iOS, macOS, tvOS, and visionOS
 - [App Store (watchOS)](https://apps.apple.com/us/app/bloom-jump-watch/id6779528549) — Apple Watch
 - [Google Play](https://play.google.com/store/apps/details?id=com.bloom.jump) — Android
 
-## Links
+## BornEngine links
 
-- [bloomengine.dev](https://bloomengine.dev)
-- [Docs](https://bloomengine.dev/docs)
-- [Showcase](https://bloomengine.dev/showcase)
-- [Brand Guidelines](https://github.com/Bloom-Engine/brand)
+- [Source repository](https://github.com/RuanFernandes/BornEngine)
+- [npm package](https://www.npmjs.com/package/@bornengine/engine)
+- [Documentation](docs/)
+- [Website and guides](https://ruanfernandes.github.io/BornEngine/)
+- [BornEngine CLI](https://github.com/RuanFernandes/bornengine-cli)