create-dreamer-app 1.0.1 → 1.0.2

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026 Glorbicon
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,99 @@
+# create-dreamer-app
+
+Start building with **Disco Dreamer** in a few commands.
+
+Scaffold a starter app with TypeScript, TSX components, and Vite already configured. The CLI creates your project and installs its dependencies so you can get straight to your first scene.
+
+## Quick start
+
+```sh
+npx create-dreamer-app@latest my-dreamer-app
+cd my-dreamer-app
+npm run dev
+```
+
+Open the local URL printed by Vite. The development server uses port `3000` by default.
+
+**Requirements:** Node.js `20.19+` within the Node 20 release line, or `22.12+`, and npm.
+
+## What's included
+
+- **Disco Dreamer** with a starter scene and text component.
+- **TypeScript and TSX** with strict type checking.
+- **Vite** for local development and production builds.
+- **Source aliases** so you can import from `@/` instead of navigating relative paths.
+- A full-page canvas with basic styles.
+
+## Make it yours
+
+Start in `src/components/Message/index.tsx` to change the greeting:
+
+```tsx
+import { Text } from "discodreamer";
+
+export function Message() {
+  return <Text value="Hello, Dreamer!" />;
+}
+```
+
+Add components to `src/components/GameScreen/index.tsx` to build out your scene. Use the `@/` alias anywhere in your TypeScript source:
+
+```tsx
+import { Message } from "@/components/Message";
+```
+
+## Project structure
+
+```text
+my-dreamer-app/
+├── src/
+│   ├── assets/
+│   │   └── disco-dreamer.svg
+│   ├── components/
+│   │   ├── GameScreen/index.tsx
+│   │   └── Message/index.tsx
+│   ├── index.html       # HTML page and canvas
+│   ├── index.tsx        # Root scene component
+│   ├── main.ts          # App registration
+│   └── main.css         # Canvas and page styles
+├── package.json
+├── tsconfig.json
+└── vite.config.js
+```
+
+## Commands
+
+Run these inside your generated project:
+
+| Command | Description |
+| --- | --- |
+| `npm run dev` | Start the development server. |
+| `npm run typecheck` | Check TypeScript without emitting files. |
+| `npm run build` | Check types and build the app into `dist/`. |
+| `npm run preview` | Preview the production build locally after building. |
+
+## CLI options
+
+```sh
+npx create-dreamer-app@latest [directory] [--skip-install]
+```
+
+Omit the directory to choose a name interactively. The destination must be a new or empty directory.
+
+| Option | Description |
+| --- | --- |
+| `--skip-install` | Create the project without installing dependencies. |
+| `-h`, `--help` | Show usage information. |
+
+To install dependencies yourself:
+
+```sh
+npx create-dreamer-app@latest my-dreamer-app --skip-install
+cd my-dreamer-app
+npm install
+npm run dev
+```
+
+## License
+
+ISC

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "create-dreamer-app",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "The scaffolding application for using Disco Dreamer.",
   "main": "index.js",
   "bin": {
-    "create-dreamer-app": "./index.js"
+    "create-dreamer-app": "index.js"
   },
   "engines": {
     "node": "^20.19.0 || >=22.12.0"

package/template/src/assets/disco-dreamer.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="280" height="64" viewBox="0 0 280 64" role="img" aria-labelledby="title">
+  <title id="title">Disco Dreamer</title>
+  <text x="140" y="32" dominant-baseline="middle" text-anchor="middle" fill="#a78bfa" font-family="system-ui, sans-serif" font-size="32" font-weight="700">Disco Dreamer</text>
+</svg>

package/template/tsconfig.json

@@ -1,37 +1,14 @@
 {
-  // Visit https://aka.ms/tsconfig to read more about this file
   "compilerOptions": {
-    // File Layout
     "rootDir": "./src",
-    "outDir": "./dist",
-
-    // Environment Settings
-    // See also https://aka.ms/tsconfig/module
     "module": "esnext",
     "moduleResolution": "bundler",
     "noEmit": true,
     "target": "esnext",
-    
-    // Browser environment and Vite asset imports:
     "lib": ["esnext", "DOM"],
     "types": ["vite/client"],
-
-    // Other Outputs
-    "sourceMap": true,
-
-    // Stricter Typechecking Options
     "noUncheckedIndexedAccess": true,
     "exactOptionalPropertyTypes": false,
-
-    // Style Options
-    // "noImplicitReturns": true,
-    // "noImplicitOverride": true,
-    // "noUnusedLocals": true,
-    // "noUnusedParameters": true,
-    // "noFallthroughCasesInSwitch": true,
-    // "noPropertyAccessFromIndexSignature": true,
-
-    // Recommended Options
     "strict": true,
     "jsx": "preserve",
     "verbatimModuleSyntax": true,
@@ -39,6 +16,9 @@
     "noUncheckedSideEffectImports": true,
     "moduleDetection": "force",
     "skipLibCheck": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
   },
   "include": ["src"]
 }

package/template/vite.config.js

@@ -1,8 +1,14 @@
 import { defineConfig } from "vite";
+import { fileURLToPath } from "node:url";
 
 export default defineConfig({
     root: "src",
     base: "./",
+    resolve: {
+        alias: {
+            "@": fileURLToPath(new URL("./src", import.meta.url)),
+        },
+    },
     oxc: {
         jsxInject: 'import { DreamFactory as __DreamFactory } from "discodreamer"',
         jsx: {