chorama 0.0.0

package/.configs/tsconfig.lib.json

@@ -0,0 +1,43 @@
+{
+  "include": [
+    "../env.d.ts",
+    "../src",
+    "../examples",
+    "../libs/color.js"
+  ],
+  "compilerOptions": {
+    "strict": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictBuiltinIteratorReturn": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitOverride": true,
+    "noImplicitAny": true,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "module": "es2022",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "target": "es2022",
+    "preserveSymlinks": true,
+    "baseUrl": "..",
+    "checkJs": true,
+    "skipLibCheck": true,
+    "paths": {
+      "chorama": [
+        "./src/index.js"
+      ]
+    },
+    "composite": true,
+    "noEmit": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "rootDir": "..",
+  }
+}

package/.configs/tsconfig.website.json

@@ -0,0 +1,34 @@
+{
+  "extends": "astro/tsconfigs/strict",
+  "include": [
+    "../env.d.ts",
+    "../website/**/*",
+    "../astro.config.mjs"
+  ],
+  "compilerOptions": {
+    "baseUrl": "..",
+    "paths": {
+      "@configs": [
+        "./website/config/index.ts"
+      ],
+      "@configs/*": [
+        "./website/config/*"
+      ],
+      "@layouts/*": [
+        "./website/layouts/*"
+      ],
+      "@components/*": [
+        "./website/components/*"
+      ]
+    },
+    "types": [
+      "astro/client",
+      "node"
+    ],
+    "composite": true,
+    "noEmit": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "rootDir": ".."
+  }
+}

package/.github/workflows/static.yml

@@ -0,0 +1,88 @@
+name: Deploy site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+env:
+  BUILD_PATH: "."
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Detect package manager
+        id: detect-package-manager
+        run: |
+          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
+            echo "manager=yarn" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=yarn" >> $GITHUB_OUTPUT
+            echo "lockfile=yarn.lock" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "${{ github.workspace }}/package.json" ]; then
+            echo "manager=npm" >> $GITHUB_OUTPUT
+            echo "command=ci" >> $GITHUB_OUTPUT
+            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
+            echo "lockfile=package-lock.json" >> $GITHUB_OUTPUT
+            exit 0
+          else
+            echo "Unable to determine package manager"
+            exit 1
+          fi
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: ${{ steps.detect-package-manager.outputs.manager }}
+          cache-dependency-path: ${{ env.BUILD_PATH }}/${{ steps.detect-package-manager.outputs.lockfile }}
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Install dependencies
+        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
+        working-directory: ${{ env.BUILD_PATH }}
+      - name: Build site and stage library
+        run: |
+          ${{ steps.detect-package-manager.outputs.runner }} rollup --config rollup.config.js
+          BASE="${{ steps.pages.outputs.base_path }}" \
+          ${{ steps.detect-package-manager.outputs.runner }} astro build \
+            --site "${{ steps.pages.outputs.origin }}" \
+            --base "${{ steps.pages.outputs.base_path }}"
+          node scripts/stage-chorama.mjs
+        working-directory: ${{ env.BUILD_PATH }}
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ${{ env.BUILD_PATH }}/dist/website
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "firefox",
+      "request": "launch",
+      "reAttach": true,
+      "name": "Launch iFirefox",
+      "url": "http://127.0.0.1:4321/examples/index.html",
+      "webRoot": "${workspaceFolder}",
+      "pathMappings": [
+        {
+          "url": "http://127.0.0.1:4321",
+          "path": "${workspaceFolder}"
+        }
+      ]
+    },
+    {
+      "type": "chrome",
+      "request": "launch",
+      "name": "Launch Chrome=",
+      "url": "http://127.0.0.1:4321/examples/index.html",
+      "webRoot": "${workspaceFolder}"
+    }
+  ]
+}

package/.vscode/tasks.json

@@ -0,0 +1,19 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "typescript",
+			"tsconfig": "tsconfig.json",
+			"label": "tsc-scan",
+			"option": "watch",
+			"problemMatcher":"$tsc-watch",
+			"group": "build",
+			"runOptions": {
+				"runOn": "folderOpen"
+			},
+			"presentation": {
+				"reveal": "never",
+			}
+		}
+	]
+}

package/README.md

@@ -0,0 +1,127 @@
+# Chorama
+
+A modular WebGL2 rendering library built in JavaScript.
+
+## Features
+
+- Rendering architecture
+  - Modular, plugin-driven rendering pipeline
+  - Multi-pass/view rendering support
+  - Render-time resource and state caching to reduce redundant GPU work
+  - Extensible shader include/define system
+
+- Scene and transforms
+  - Hierarchical scene graph for parent-child object relationships
+  - Local/world transform propagation
+  - Traversal utilities for update and render preparation flows
+  - Support for static and skinned scene objects
+
+- Geometry and mesh creation
+  - Ready-to-use procedural geometry builders:
+    - Plane
+    - Circle
+    - Cylinder
+    - Cuboid
+    - UV sphere
+    - Wireframe conversion
+  - Attribute-based mesh data model (positions, normals, UVs, tangents, skinning data)
+  - Flexible vertex/index data handling for custom mesh pipelines
+
+- Materials and shading
+  - Multiple built-in shading styles:
+    - Unlit/basic shading
+    - Lambert diffuse shading
+    - Phong shading
+    - Standard physically based shading
+    - Normal/depth debug shading
+    - Raw/custom shader paths
+  - Material properties for color, texture mapping, emissive, metallic and roughness workflows
+  - Shared shader code modules for common math, color and lighting logic
+
+- Lighting and shadows
+  - Supported light types:
+    - Ambient
+    - Directional
+    - Point
+    - Spot
+  - Shadow rendering support integrated into the render pipeline
+  - Lighting/material integration for lit and physically based workflows
+
+- Textures and sampling
+  - Multiple texture formats and usage patterns
+  - Sampler controls for filtering and wrapping behavior
+
+- Render targets and offscreen rendering
+  - Direct rendering to canvas
+  - Offscreen/image render target support
+  - Framebuffer-based workflows for multi-step rendering
+  - Foundations for post-process and texture-to-texture pipelines
+
+- Asset loading
+  - Built-in loaders for:
+    - Image textures
+    - OBJ models
+    - glTF scenes/assets
+  - Async loading with default placeholders while assets stream in
+  - Asset reuse and clone/copy loading strategies
+  - glTF material/texture/skeleton parsing paths
+
+- Camera and interaction
+  - Perspective and orthographic camera projections
+  - Orbit-style interaction controls for inspection/navigation
+  - Camera-aware rendering integration through the plugin system
+
+- Math and low-level utilities
+  - Core math types and operations for:
+    - Vectors
+    - Quaternions
+    - Matrices/affine transforms
+  - Buffer/type conversion helpers for GPU upload workflows
+  - WebGL mapping helpers for vertex formats, attachments and texture formats
+
+## Who This Is For
+
+Use this library if you want lower-level control than full game engines, but still want reusable rendering building blocks for WebGL2 projects.
+
+## Getting Started
+
+### Requirements
+
+- Node.js 18+
+- npm
+- A browser with WebGL2 support
+
+### Install dependencies
+
+```bash
+npm install
+```
+
+### Build library bundles
+
+```bash
+npm run build
+```
+
+Build output:
+
+- `dist/index.umd.js`
+- `dist/index.module.js`
+
+### Run demos
+
+```bash
+npx vite .
+```
+
+Then open:
+
+- `http://localhost:5173/examples/index.html`
+
+## Core Usage Flow
+
+1. Create a `WebGLRenderDevice` from a canvas.
+2. Create a render target (`CanvasTarget` or `ImageTarget`).
+3. Create a `WebGLRenderer` with the plugins needed by your scene.
+4. Build scene objects (meshes, lights, camera).
+5. Call `renderer.render(objects, renderDevice)` each frame.