@certe/atmos-editor 0.4.0 → 0.5.0

package/README.md

@@ -6,52 +6,47 @@ Unity-style editor for the Atmos Engine, built with React. Provides scene hierar
 
 ## Getting Started
 
-### 1. Create a new project
-
 ```bash
 mkdir my-game && cd my-game
-npm init -y
-```
-
-### 2. Install dependencies
-
-```bash
-npm install @certe/atmos-editor @certe/atmos-core @certe/atmos-math @certe/atmos-renderer @certe/atmos-physics
-npm install -D vite @vitejs/plugin-react
+npm install @certe/atmos-editor
+npx atmos-init
+npm run dev
 ```
 
-### 3. Configure Vite
-
-Create `vite.config.ts`:
+That's it. `atmos-init` creates `vite.config.ts`, `src/main.ts`, `tsconfig.json`, installs dev dependencies, and adds npm scripts. The editor opens at `http://localhost:5173`.
 
-```ts
-import { defineConfig } from 'vite';
-import react from '@vitejs/plugin-react';
-import { atmosPlugin } from '@certe/atmos-editor/vite';
+### Manual setup
 
-export default defineConfig({
-  plugins: [react(), atmosPlugin()],
-});
-```
+If you prefer to set things up yourself:
 
-### 4. Create the entry point
+1. Install dependencies:
+   ```bash
+   npm install @certe/atmos-editor
+   npm install -D vite @vitejs/plugin-react typescript
+   ```
 
-Create `src/main.ts`:
+2. Create `vite.config.ts`:
+   ```ts
+   import { defineConfig } from 'vite';
+   import react from '@vitejs/plugin-react';
+   import { atmosPlugin } from '@certe/atmos-editor/vite';
 
-```ts
-import { startEditor, createEditorPhysics } from '@certe/atmos-editor';
+   export default defineConfig({
+     plugins: [react(), atmosPlugin()],
+   });
+   ```
 
-await startEditor({
-  physics: await createEditorPhysics(),
-  scriptModules: import.meta.glob('./scripts/*.ts', { eager: true }),
-});
-```
+3. Create `src/main.ts`:
+   ```ts
+   import { startEditor, createEditorPhysics } from '@certe/atmos-editor';
 
-### 5. Run the editor
+   await startEditor({
+     physics: await createEditorPhysics(),
+     scriptModules: import.meta.glob('./scripts/*.ts', { eager: true }),
+   });
+   ```
 
-```bash
-npx vite
-```
+4. Run: `npx vite`
 
 The editor opens with a WebGPU viewport, scene hierarchy, inspector, and gizmo tools. Place game scripts in `src/scripts/` and they'll be automatically discovered.
 

package/bin/atmos-init.mjs

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+import fs from 'node:fs';
+import path from 'node:path';
+import { execSync } from 'node:child_process';
+
+const root = process.cwd();
+
+console.log('Initializing Atmos project...\n');
+
+// 1. Ensure package.json exists
+if (!fs.existsSync(path.join(root, 'package.json'))) {
+  console.log('Creating package.json...');
+  execSync('npm init -y', { stdio: 'inherit', cwd: root });
+}
+
+// Ensure "type": "module" in package.json
+const pkgPath = path.join(root, 'package.json');
+const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+if (pkg.type !== 'module') {
+  pkg.type = 'module';
+  fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
+  console.log('Set "type": "module" in package.json');
+}
+
+// 2. vite.config.ts
+const viteConfig = `import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+import { atmosPlugin } from '@certe/atmos-editor/vite';
+
+export default defineConfig({
+  plugins: [react(), atmosPlugin()],
+});
+`;
+
+if (!fs.existsSync(path.join(root, 'vite.config.ts'))) {
+  fs.writeFileSync(path.join(root, 'vite.config.ts'), viteConfig);
+  console.log('Created vite.config.ts');
+} else {
+  console.log('vite.config.ts already exists, skipping');
+}
+
+// 3. src/main.ts
+const mainTs = `import { startEditor, createEditorPhysics } from '@certe/atmos-editor';
+
+await startEditor({
+  physics: await createEditorPhysics(),
+  scriptModules: import.meta.glob('./scripts/*.ts', { eager: true }),
+});
+`;
+
+fs.mkdirSync(path.join(root, 'src', 'scripts'), { recursive: true });
+
+if (!fs.existsSync(path.join(root, 'src', 'main.ts'))) {
+  fs.writeFileSync(path.join(root, 'src', 'main.ts'), mainTs);
+  console.log('Created src/main.ts');
+} else {
+  console.log('src/main.ts already exists, skipping');
+}
+
+// 4. tsconfig.json
+const tsconfig = {
+  compilerOptions: {
+    target: 'ESNext',
+    module: 'ESNext',
+    moduleResolution: 'bundler',
+    strict: true,
+    esModuleInterop: true,
+    skipLibCheck: true,
+    types: ['vite/client'],
+  },
+  include: ['src'],
+};
+
+if (!fs.existsSync(path.join(root, 'tsconfig.json'))) {
+  fs.writeFileSync(path.join(root, 'tsconfig.json'), JSON.stringify(tsconfig, null, 2) + '\n');
+  console.log('Created tsconfig.json');
+} else {
+  console.log('tsconfig.json already exists, skipping');
+}
+
+// 5. Install dev dependencies
+console.log('\nInstalling dependencies...');
+execSync('npm install -D vite @vitejs/plugin-react typescript', { stdio: 'inherit', cwd: root });
+
+// 6. Add scripts to package.json if missing
+const updatedPkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+updatedPkg.scripts = updatedPkg.scripts || {};
+if (!updatedPkg.scripts.dev) updatedPkg.scripts.dev = 'vite';
+if (!updatedPkg.scripts.build) updatedPkg.scripts.build = 'vite build';
+if (!updatedPkg.scripts.preview) updatedPkg.scripts.preview = 'vite preview';
+fs.writeFileSync(pkgPath, JSON.stringify(updatedPkg, null, 2) + '\n');
+
+console.log('\nDone! Run "npm run dev" to start the editor.');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@certe/atmos-editor",
   "description": "Browser-based Unity-style editor for the Atmos Engine — hierarchy, inspector, gizmos",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/certesolutions-cyber/atmos.git",
@@ -42,6 +42,7 @@
     "vite-plugin.mjs",
     "vite-plugin.cjs",
     "vite-plugin.d.ts",
+    "bin",
     "package.json",
     "README.md",
     "LICENCE"
@@ -55,11 +56,11 @@
     }
   },
   "dependencies": {
-    "@certe/atmos-animation": "^0.4.0",
-    "@certe/atmos-assets": "^0.4.0",
-    "@certe/atmos-core": "^0.4.0",
-    "@certe/atmos-math": "^0.4.0",
-    "@certe/atmos-renderer": "^0.4.0",
+    "@certe/atmos-animation": "^0.5.0",
+    "@certe/atmos-assets": "^0.5.0",
+    "@certe/atmos-core": "^0.5.0",
+    "@certe/atmos-math": "^0.5.0",
+    "@certe/atmos-renderer": "^0.5.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },
@@ -67,6 +68,9 @@
     "@types/react": "^19.0.0",
     "@types/react-dom": "^19.0.0"
   },
+  "bin": {
+    "atmos-init": "./bin/atmos-init.mjs"
+  },
   "scripts": {
     "test": "vitest run"
   }