@felbrasil/dreamy 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Felipe Bravo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,70 @@
-# Temporary Holding Version
+# Dreamy
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A voxel creature sculpting studio for React: stamp and smear sculpts, paint them, rig them with premade
+skeletons and decals, and render them as normal 3D or pixel art. Meshing runs in Rust/WASM inside a Web Worker;
+the 3D view is Three.js. Creations save in the browser (IndexedDB) and can sync to a GitHub or GitLab repository.
+
+**Live demo:** https://dreamy-poc-c89175.gitlab.io
+
+## Install
+
+```bash
+npm install @felbrasil/dreamy react react-dom three
+```
+
+`react`, `react-dom` (19) and `three` are peer dependencies. There is nothing else to configure: the Worker and
+its WASM are inlined in the package, so Vite, Next.js (webpack or Turbopack) and other bundlers work as they are.
+
+## Use the whole studio
+
+```tsx
+import { DreamyStudio } from "@felbrasil/dreamy";
+import "@felbrasil/dreamy/styles.css";
+
+export function App() {
+  return <DreamyStudio onReady={() => console.log("studio ready")} />;
+}
+```
+
+The studio fills the page (fixed, full viewport), so render one per page. `styles.css` also loads the studio's
+icons (Font Awesome) and font (Nunito) from their CDNs.
+
+In **Next.js** you can render it straight from a server component: the package entry is a client module.
+Import `styles.css` in your root layout.
+
+### Props
+
+| Prop | Default | |
+|---|---|---|
+| `database` | this browser's IndexedDB | Where the library of creations lives (`LibraryDatabase`: list / read / write / delete / current). |
+| `storage` | `localStorage` | Key-value storage for view preferences and git settings. |
+| `gitSync` | `true` | Offer Scenes → Git: sync the library with one GitHub or GitLab repository (token kept in `storage`). |
+| `onReady` | | Called once the mesher is loaded, the creation is open and the studio has painted. |
+
+## Use the pieces
+
+| Import | What |
+|---|---|
+| `@felbrasil/dreamy` | `DreamyStudio`, the IndexedDB library, persistence, git sync, preferences |
+| `@felbrasil/dreamy/core` | `createCreationApi`: the event-sourced creation model, commands, undo, premades |
+| `@felbrasil/dreamy/viewport` | `createViewport({ evaluator })`: the Three.js renderer and interaction |
+| `@felbrasil/dreamy/evaluator` | `createEvaluator()`: the WASM mesher in a Worker (TypeScript fallback) |
+| `@felbrasil/dreamy/api` | Types: the model, commands, events and ports |
+
+```ts
+import { createCreationApi } from "@felbrasil/dreamy/core";
+import { createEvaluator } from "@felbrasil/dreamy/evaluator";
+import { createViewport } from "@felbrasil/dreamy/viewport";
+
+const api = createCreationApi({ ids, clock, log });
+const viewport = createViewport({ evaluator: createEvaluator() });
+viewport.mount(hostElement, callbacks);
+```
+
+## Requirements
+
+A browser with WebGL 2, Web Workers and WebAssembly. Client-side only (no server rendering of the studio).
+
+## License
+
+MIT

package/dist/api.d.ts

@@ -0,0 +1 @@
+export type * from "./types/api/src/index.js";

package/dist/api.js

@@ -0,0 +1,2 @@
+"use client";
+//# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}