@viji-dev/sdk 1.0.0 → 1.0.2

package/README.md

@@ -1,103 +1,110 @@
 # Viji SDK
 
-Professional toolkit for creating interactive Viji scenes. Includes a CLI, workspace management, local development UI (Vite-based), and a production build pipeline that outputs a single deployable `scene.js`. Uses `@viji-dev/core` under the hood.
+Development environment for [Viji Creative](https://viji.art) scenes. Write scene code in your IDE, preview it live in the browser with real-time parameter controls, audio analysis, video input, and interaction handling — the same execution environment as the Viji platform. Supports Canvas 2D, WebGL, P5.js, and GLSL shaders.
 
 ## Installation
 
+Requires [Node.js](https://nodejs.org/) v18 or later.
+
 ```bash
 npm install -g @viji-dev/sdk
 ```
 
+To update to the latest version:
+
+```bash
+npm update -g @viji-dev/sdk
+```
+
 ## Quick Start
 
 ```bash
-# Create a new workspace
-mkdir my-viji-workspace
-cd my-viji-workspace
-viji init .
+# Create a workspace folder (any name works)
+mkdir my-viji-scenes && cd my-viji-scenes
 
-# Create your first scene
-viji create my-scene --lang=ts
+# Create your first scene (native renderer is the default)
+viji create my-scene
 
-# Start development server
+# Start the development server
 viji dev
 ```
 
-## CLI Commands
+Open `http://localhost:3000` in your browser to see the SDK UI. Edit `scenes/my-scene/main.js` in your IDE — changes appear in real time.
 
-### `viji init [workspace-name]`
-Initialize a new Viji workspace with complete development environment.
-- Use `viji init .` to initialize in current directory
-- Use `viji init my-workspace` to create new directory
+## CLI Commands
 
-### `viji create <scene-name> [--lang=js|ts]`
-Create a new scene in the current workspace.
-- Must be run inside a Viji workspace
-- Creates scene in `scenes/<scene-name>/` folder
+### `viji create <scene-name> [--renderer <type>]`
 
-### `viji dev [--port=5173] [--host=localhost] [--open]`
-Start development server with hot reload.
-- Must be run inside a Viji workspace
-- Opens browser-based development UI
+Create a new scene in the `scenes/` folder.
 
-### `viji build <scene-name> [--output=dist/scene.js]`
-Build a scene for platform deployment.
-- Compiles multi-file project to single JS file
-- Ready for copy-paste to Viji platform
+- `viji create my-scene` — native renderer (Canvas 2D / WebGL), the default
+- `viji create my-scene --renderer p5` — P5.js renderer
+- `viji create my-scene --renderer shader` — GLSL fragment shader
 
-## Workspace Structure
+Creates the following structure:
 
 ```
-my-workspace/
-├── src/                    # Development UI (React + Vite)
-├── scenes/                 # Your scenes
-│   ├── my-scene/          
-│   │   └── main.ts        # Scene entry point
-│   └── another-scene/
-├── vite.config.ts         # Vite configuration
-├── package.json           # Dependencies
-└── ...                    # TypeScript configs, etc.
+scenes/
+└── my-scene/
+    └── main.js        # or main.glsl for shader scenes
+global.d.ts            # generated once for IDE type support
 ```
 
-## Scene Development
+### `viji dev [--port <port>] [--host <host>] [--open]`
+
+Start the development server with live reload.
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--port` | `3000` | Server port |
+| `--host` | `localhost` | Server host |
+| `--open` | `false` | Open browser automatically |
 
-Each scene is a folder in `scenes/` with a `main.js` or `main.ts` entry point:
+The server watches the `scenes/` directory for changes and pushes updates to the browser UI in real time via WebSocket.
 
-```typescript
-// scenes/my-scene/main.ts
-export const parameters = [
-  // Parameter definitions
-];
+### `viji build <scene-name> [-o <file>]`
 
-export function init(canvas: HTMLCanvasElement, audioContext: AudioContext) {
-  // Initialization code
-}
+Bundle a scene into a single file for deployment to the Viji platform.
 
-export function render(state: any, inputs: any, params: any) {
-  // Main render loop
-}
+```bash
+viji build my-scene                       # outputs dist/my-scene.js
+viji build my-scene -o bundle/output.js   # custom output path
 ```
 
-## Features
+Multi-file scenes (with local imports) are resolved and concatenated automatically.
+
+## Writing Scenes
+
+The SDK includes built-in documentation for the Viji scene API, parameter system, renderers, audio/video analysis, and interaction handling.
+
+Start the development server and open the docs panel from the toolbar, or navigate directly to `http://localhost:3000/docs`.
 
-- **🎨 Complete Development Environment**: Full React UI for scene development
-- **🔥 Hot Reload**: Instant updates when you save scene files
-- **📁 Workspace Management**: Organize multiple scenes in one project
-- **🛠️ TypeScript Support**: Full type safety and IDE integration
-- **📦 Single-File Build**: Compile to platform-ready scene.js
-- **🎯 Platform Compatible**: Uses same Core runtime as Viji platform
+The documentation includes live code playgrounds where you can experiment with the API directly in the browser.
 
-## Documentation
+## Project Structure
+
+After creating a few scenes, your workspace looks like this:
+
+```
+my-viji-scenes/
+├── scenes/
+│   ├── my-scene/
+│   │   └── main.js
+│   ├── shader-demo/
+│   │   └── main.glsl
+│   └── p5-sketch/
+│       └── main.js
+└── global.d.ts          # IDE type support (auto-generated)
+```
 
-- SDK package: `docs/02-sdk-package.md`
-- Implementation guide: `docs/06-cursor-implementation-guide.md`
+No configuration files, no `node_modules`, no build tools in your workspace. Everything is handled by the globally installed SDK.
 
-## 📄 License
+## License
 
-Copyright (c) 2025 Artem Verkhovskiy and Dmitry Manoilenko.  
-All rights reserved - see the LICENSE file for details.
+Copyright (c) 2025 Artem Verkhovskiy and Dmitry Manoilenko.
+All rights reserved — see the LICENSE file for details.
 
 ## Contributor License Agreement
 
-By contributing, you agree to the [CLA](./CLA.md).  
-Please also confirm your agreement by filling out this short [form](https://forms.gle/A49WTz8nj5b99Yev7).
+By contributing, you agree to the [CLA](./CLA.md).
+Please also confirm your agreement by filling out this short [form](https://forms.gle/A49WTz8nj5b99Yev7).

package/bin/viji.js

@@ -1,22 +1,15 @@
 #!/usr/bin/env node
 
-/**
- * Viji SDK Command Line Interface
- * Professional toolkit for creating interactive Viji scenes
- */
-
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
 const { program } = require('commander');
 import { createCommand } from '../src/cli/commands/create.js';
 import { devCommand } from '../src/cli/commands/dev.js';
 import { buildCommand } from '../src/cli/commands/build.js';
-import { initCommand } from '../src/cli/commands/init.js';
 import { fileURLToPath } from 'url';
 import { dirname, join } from 'path';
 import { readFileSync } from 'fs';
 
-// Get package.json version
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 const packagePath = join(__dirname, '..', 'package.json');
@@ -24,52 +17,39 @@ const packageJson = JSON.parse(readFileSync(packagePath, 'utf8'));
 
 program
   .name('viji')
-  .description('🎨 Viji SDK - Professional toolkit for creating interactive scenes')
+  .description('Viji SDK - Professional toolkit for creating interactive scenes')
   .version(packageJson.version);
 
-// Command: Initialize new workspace
-program
-  .command('init')
-  .argument('[workspace-name]', 'Name of the workspace (use "." for current directory)', '.')
-  .description('Initialize a new Viji workspace')
-  .action(initCommand);
-
-// Command: Create new scene
 program
   .command('create')
   .argument('<scene-name>', 'Name of the new scene')
-  .option('--lang <lang>', 'Scene language (js|ts)', 'js')
+  .option('--renderer <type>', 'Renderer type (native|p5|shader)', 'native')
   .description('Create a new scene in the current workspace')
   .action(createCommand);
 
-// Command: Start development server
 program
   .command('dev')
-  .option('-p, --port <port>', 'Development server port', '5173')
-  .option('-h, --host <host>', 'Development server host', 'localhost')
+  .option('-p, --port <port>', 'Development server port', '3000')
+  .option('--host <host>', 'Development server host', 'localhost')
   .option('--open', 'Open browser automatically', false)
-  .description('Start development server with hot reload')
+  .description('Start development server with live reload')
   .action(devCommand);
 
-// Command: Build for production
 program
   .command('build')
   .argument('<scene-name>', 'Name of the scene to build')
-  .option('-o, --output <file>', 'Output file path', 'dist/scene.js')
-  .description('Build scene: bundle multi-file projects into one, no minify')
+  .option('-o, --output <file>', 'Output file path')
+  .description('Build scene: bundle multi-file projects into one')
   .action(buildCommand);
 
-
-// Global error handling
 process.on('uncaughtException', (error) => {
-  console.error('💥 Unexpected error:', error.message);
+  console.error('Unexpected error:', error.message);
   process.exit(1);
 });
 
 process.on('unhandledRejection', (reason) => {
-  console.error('💥 Unhandled promise rejection:', reason);
+  console.error('Unhandled promise rejection:', reason);
   process.exit(1);
 });
 
-// Parse and execute
 program.parse();