hytopia 0.12.0-prerelease-1 → 0.12.0-prerelease-3

package/bin/scripts.js

@@ -41,6 +41,7 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
     'init-mcp': initMcp,
     'package': packageProject,
     'start': start,
+    'upgrade-assets-library': () => upgradeAssetsLibrary(process.argv[3] || 'latest'),
     'upgrade-cli': () => upgradeCli(process.argv[3] || 'latest'),
     'upgrade-project': () => upgradeProject(process.argv[3] || 'latest'),
     'version': displayVersion,
@@ -142,9 +143,6 @@ function init() {
   // Update SDK to latest (sets package.json requirement)
   upgradeProject();
 
-  // Copy assets into project, not overwriting existing files
-  copyAssets(destDir);
-
   // Display success message
   displayInitSuccessMessage();
 
@@ -175,7 +173,8 @@ function installProjectDependencies() {
   }, null, 2))
 
   // install hytopia sdk and hytopia assets
-  execSync('npm install --force hytopia@latest @hytopia.com/assets@latest', { stdio: 'inherit' });
+  execSync('npm install --force hytopia@latest', { stdio: 'inherit' });
+  execSync('npm install --save-optional --force @hytopia.com/assets@latest', { stdio: 'inherit' });
 }
 
 /**
@@ -210,18 +209,6 @@ function initFromBoilerplate(destDir) {
   }
 }
 
-/**
- * Copies assets to the project directory
- */
-function copyAssets(destDir) {
-  const assetsSource = path.join(destDir, 'node_modules', '@hytopia.com', 'assets');
-  const assetsDest = path.join(destDir, 'assets');
-  
-  if (!copyDirectoryContents(assetsSource, assetsDest, { recursive: true, force: false })) {
-    console.error('❌ Error: Could not copy assets from @hytopia.com/assets package');
-  }
-}
-
 /**
  * Displays success message after project initialization
  */
@@ -579,6 +566,13 @@ async function fetchLatestVersion(signal) {
   }
 }
 
+function upgradeAssetsLibrary(versionArg = 'latest') {
+  const version = versionArg.trim();
+  console.log(`🔄 Upgrading @hytopia.com/assets package to: ${version} ...`);
+  execSync(`npm install --save-optional --force @hytopia.com/assets@${version}`, { stdio: 'inherit' });
+  console.log('✅ Upgrade complete.');
+}
+
 function upgradeCli(versionArg = 'latest') {
   const version = versionArg.trim();
   console.log(`🔄 Upgrading HYTOPIA CLI to: hytopia@${version} ...`);
@@ -613,8 +607,9 @@ function displayHelp() {
   console.log('  init [--template NAME]      Initialize a new project');
   console.log('  init-mcp                    Setup MCP integrations');
   console.log('  package                     Create a zip of the project for uploading to the HYTOPIA create portal.');
-  console.log('  upgrade-cli                 Upgrade the HYTOPIA CLI');
-  console.log('  upgrade-project [VERSION]   Upgrade project SDK dep (default: latest)');
+  console.log('  upgrade-assets-library [VERSION]    Upgrade the @hytopia.com/assets package (default: latest)');
+  console.log('  upgrade-cli [VERSION]       Upgrade the HYTOPIA CLI (default: latest)');
+  console.log('  upgrade-project [VERSION]   Upgrade project SDK dependency (default: latest)');
   console.log('');
   console.log('Examples:');
   console.log('  hytopia init --template zombies-fps');

package/docs/server.assetslibrary.assetslibrarypath.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [AssetsLibrary](./server.assetslibrary.md) &gt; [assetsLibraryPath](./server.assetslibrary.assetslibrarypath.md)
+
+## AssetsLibrary.assetsLibraryPath property
+
+The path to the assets library package. Null if assets library is not available.
+
+**Signature:**
+
+```typescript
+readonly assetsLibraryPath: string | null;
+```

package/docs/server.assetslibrary.instance.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [AssetsLibrary](./server.assetslibrary.md) &gt; [instance](./server.assetslibrary.instance.md)
+
+## AssetsLibrary.instance property
+
+The global AssetsLibrary instance as a singleton.
+
+**Signature:**
+
+```typescript
+static readonly instance: AssetsLibrary;
+```

package/docs/server.assetslibrary.md

@@ -0,0 +1,133 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [AssetsLibrary](./server.assetslibrary.md)
+
+## AssetsLibrary class
+
+Manages the assets library and synchronization of assets to the local assets directory in development.
+
+**Signature:**
+
+```typescript
+export default class AssetsLibrary 
+```
+
+## Remarks
+
+The AssetsLibrary is created internally as a global singletone accessible with the static property `AssetsLibrary.instance`<!-- -->.
+
+Please note: Assets will automatically sync to local assets in development mode the first time an asset in the library is requested by the client. This means you do not need to explicitly handle calling syncAsset() yourself unless you have a specific reason to.
+
+## Example
+
+
+```typescript
+import { AssetsLibrary } from 'hytopia';
+
+const assetsLibrary = AssetsLibrary.instance;
+assetsLibrary.syncAsset('assets/models/player.gltf');
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[assetsLibraryPath](./server.assetslibrary.assetslibrarypath.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| null
+
+
+</td><td>
+
+The path to the assets library package. Null if assets library is not available.
+
+
+</td></tr>
+<tr><td>
+
+[instance](./server.assetslibrary.instance.md)
+
+
+</td><td>
+
+`static`
+
+`readonly`
+
+
+</td><td>
+
+[AssetsLibrary](./server.assetslibrary.md)
+
+
+</td><td>
+
+The global AssetsLibrary instance as a singleton.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[syncAsset(assetPath)](./server.assetslibrary.syncasset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Synchronizes an asset from the assets library to the local assets directory.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/server.assetslibrary.syncasset.md

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [AssetsLibrary](./server.assetslibrary.md) &gt; [syncAsset](./server.assetslibrary.syncasset.md)
+
+## AssetsLibrary.syncAsset() method
+
+Synchronizes an asset from the assets library to the local assets directory.
+
+**Signature:**
+
+```typescript
+syncAsset(assetPath: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+assetPath
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The path of the asset to copy to local assets.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+
+## Remarks
+
+Syncs an asset from the assets library to local assets in development. The assets library is unavailable in production, so assets must be local to the project.
+

package/docs/server.blocktextureregistry.generate.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTextureRegistry](./server.blocktextureregistry.md) &gt; [generate](./server.blocktextureregistry.generate.md)
+
+## BlockTextureRegistry.generate property
+
+Whether to generate the atlas if needed. Defaults to `true` in development, `false` in production.
+
+**Signature:**
+
+```typescript
+generate: boolean;
+```

package/docs/server.blocktextureregistry.md

@@ -53,7 +53,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[generateEveryStart](./server.blocktextureregistry.generateeverystart.md)
+[generate](./server.blocktextureregistry.generate.md)
 
 
 </td><td>
@@ -66,7 +66,7 @@ boolean
 
 </td><td>
 
-Whether to always generate the atlas on server start.
+Whether to generate the atlas if needed. Defaults to `true` in development, `false` in production.
 
 
 </td></tr>

package/docs/server.md

@@ -19,6 +19,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[AssetsLibrary](./server.assetslibrary.md)
+
+
+</td><td>
+
+Manages the assets library and synchronization of assets to the local assets directory in development.
+
+
+</td></tr>
+<tr><td>
+
 [Audio](./server.audio.md)
 
 

package/docs/server.modelregistry.hasmodel.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelRegistry](./server.modelregistry.md) &gt; [hasModel](./server.modelregistry.hasmodel.md)
+
+## ModelRegistry.hasModel() method
+
+Checks if a model is registered in the model registry.
+
+**Signature:**
+
+```typescript
+hasModel(modelUri: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the model to check.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+boolean
+
+Whether the model is registered.
+

package/docs/server.modelregistry.md

@@ -89,26 +89,7 @@ boolean
 
 </td><td>
 
-Whether to use optimized models when they are loaded.
-
-
-</td></tr>
-<tr><td>
-
-[optimizeEveryStart](./server.modelregistry.optimizeeverystart.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether to always run model optimization on server start.
+Whether to generate optimized models if needed. Defaults to `true` in development, `false` in production.
 
 
 </td></tr>
@@ -229,6 +210,20 @@ Retrieves the trimesh of a model.
 Retrieves the X-axis width of a model for a scale of 1.
 
 
+</td></tr>
+<tr><td>
+
+[hasModel(modelUri)](./server.modelregistry.hasmodel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Checks if a model is registered in the model registry.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modelregistry.optimize.md

@@ -4,7 +4,7 @@
 
 ## ModelRegistry.optimize property
 
-Whether to use optimized models when they are loaded.
+Whether to generate optimized models if needed. Defaults to `true` in development, `false` in production.
 
 **Signature:**
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.12.0-prerelease-1",
+  "version": "0.12.0-prerelease-3",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "type": "module",
   "main": "./server.mjs",