@axion-engine/core 0.0.1

package/README.md

@@ -0,0 +1,81 @@
+# @axion-engine/core 🚀
+
+> **Experimental:** A web-native 3D engine currently focused on running **React Three Fiber** entirely inside a Web Worker.
+
+**Axion Engine** is a specialized, experimental alternative to `@react-three/offscreen`. It is designed for developers who need to move their entire rendering loop, React hooks, and scene logic off the main thread to ensure the UI remains responsive even during heavy 3D computations.
+
+## ✨ Current State
+
+* **Multi-threaded R3F:** Execute your React Three Fiber components, state, and Three.js objects inside a dedicated Web Worker.
+* **Vite Native:** Optimized for modern Vite projects; handles worker bundling automatically via standard URL patterns.
+* **Offscreen Handshake:** Simplified canvas transfer logic between the Main thread UI and the Worker thread engine.
+* **Performance-First:** Decouples the rendering loop from the browser's main thread to prevent frame drops in complex apps.
+
+## 📦 Installation
+
+```bash
+npm install @axion-engine/core three @react-three/fiber react react-dom
+
+```
+## 🚀 Usage
+Axion consists of a Bridge (Main Thread) and an Engine (Worker Thread). Below is the standard setup for a Vite-based project.
+
+1. Main Thread Setup (App.tsx)
+   Initialize your worker and wrap your application in the AxionEngine provider.
+
+```tsc
+TypeScript
+
+import { useMemo } from 'react';
+import { AxionCanvas, AxionEngine } from "@axion-engine/core";
+
+function App() {
+// Vite automatically bundles the worker using this syntax
+const engineWorker = useMemo(() => {
+return new Worker(
+new URL('@axion-engine/core/worker', import.meta.url),
+{ type: 'classic' } // Axion worker is bundled as an IIFE
+);
+}, []);
+
+    return (
+        <div className="app-container">
+            {/* 1. The Engine Provider manages the worker instance */}
+            <AxionEngine worker={engineWorker}>
+
+                <div className="engine-viewport">
+                    {/* 2. The Canvas Component handles the Offscreen Handshake */}
+                    <AxionCanvas shadows>
+                        {/* Your scene content is managed within the worker */}
+                    </AxionCanvas>
+                </div>
+
+            </AxionEngine>
+        </div>
+    );
+}
+
+export default App;
+```
+
+## 🛠 Local Development & Testing
+You can test the engine locally using the built-in test environment.
+
+Install dependencies:
+
+```Bash
+npm install
+```
+Run the test suite:
+
+```Bash
+npm run test
+```
+Open the test page: 
+Navigate to http://localhost:3000/test/ to see the worker-side React scene rendering in action.
+
+## 🏗 Why Axion?
+Axion Engine is currently an experiment in creating a more "monolithic" and self-contained worker architecture for 3D web applications. While @react-three/offscreen provides a versatile bridge, Axion is being built as a dedicated foundation for large-scale simulations (such as Orion Realms) where worker-thread stability and high-performance threading are the primary requirements.
+
+## 📄 License
+MIT © Vikas

package/dist/axion-platform/index.d.ts

@@ -0,0 +1,4 @@
+export { AxionContext } from "./src";
+export { AxionCanvas } from "./src";
+export { AxionEngine } from "./src";
+//# sourceMappingURL=index.d.ts.map

package/dist/axion-platform/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../packages/axion-platform/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,OAAO,CAAA;AAClC,OAAO,EAAC,WAAW,EAAC,MAAM,OAAO,CAAA;AACjC,OAAO,EAAC,WAAW,EAAC,MAAM,OAAO,CAAA"}

package/dist/axion-platform/src/components/AxionCanvas.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+export declare const AxionCanvas: ({ shadows }: {
+    shadows?: boolean;
+}) => React.JSX.Element;
+//# sourceMappingURL=AxionCanvas.d.ts.map

package/dist/axion-platform/src/components/AxionCanvas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxionCanvas.d.ts","sourceRoot":"","sources":["../../../../packages/axion-platform/src/components/AxionCanvas.tsx"],"names":[],"mappings":"AACA,OAAO,KAAwC,MAAM,OAAO,CAAC;AAO7D,eAAO,MAAM,WAAW,GAAI,aAAa;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,KAAG,KAAK,CAAC,GAAG,CAAC,OAuD1E,CAAC"}

package/dist/axion-platform/src/context/AxionContext.d.ts

@@ -0,0 +1,7 @@
+import React, { Context, ReactNode } from "react";
+export declare const AxionContext: Context<Worker | null>;
+export declare const AxionEngine: ({ worker, children }: {
+    worker: Worker;
+    children: ReactNode;
+}) => React.JSX.Element;
+//# sourceMappingURL=AxionContext.d.ts.map

package/dist/axion-platform/src/context/AxionContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxionContext.d.ts","sourceRoot":"","sources":["../../../../packages/axion-platform/src/context/AxionContext.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,EAAE,OAAO,EAAiB,SAAS,EAAE,MAAM,OAAO,CAAC;AACjE,eAAO,MAAM,YAAY,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAsC,CAAC;AAGvF,eAAO,MAAM,WAAW,GAAI,sBAAsB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,SAAS,CAAA;CAAE,KAAG,KAAK,CAAC,GAAG,CAAC,OAMrG,CAAC"}

package/dist/axion-platform/src/index.d.ts

@@ -0,0 +1,4 @@
+export { AxionContext } from './context/AxionContext';
+export { AxionCanvas } from './components/AxionCanvas';
+export { AxionEngine } from './context/AxionContext';
+//# sourceMappingURL=index.d.ts.map

package/dist/axion-platform/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../packages/axion-platform/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAC,WAAW,EAAC,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAC,WAAW,EAAC,MAAM,wBAAwB,CAAA"}