框架、打包器、HTML

打包和 Web 前端

Needle Engine 构建为 Web Component。 这意味着只需在你的项目中安装 @needle-tools/engine，并在你的 Web 项目的任何位置包含 <needle-engine src="path/to/your.glb">。

  • 使用 npm 安装：npm i @needle-tools/engine

使用我们基于默认 Vite 的项目模板，Needle Engine 在部署时会被打包成一个 Web 应用。这确保了更小的文件、Tree-shaking（类似于 Unity 中的代码剥离）并优化了加载时间。与其下载大量小型脚本和组件，不如只下载包含所需最少代码的一两个文件。

Vite（我们的默认打包器）很好地解释了为什么 Web 应用应该打包：Why Bundle for Production

Vite, Vue, React, Svelte, React Three Fiber...

Needle Engine 对框架的选择持开放态度。我们的默认模板使用流行的 vite 作为打包器。在此基础上，你可以添加 vue、svelte、nuxt、react、react-three-fiber 或其他框架，我们提供了许多示例。你还可以集成其他打包器，或者完全不使用——只使用纯粹的 HTML 和 Javascript。

以下是一些可能的、我们用于 Needle Engine 的技术栈示例：

  • Vite + HTML — 这是我们的默认模板所使用的！

  • Vite + Vue — 这是 Needle Tools 网站所使用的！可以在 这里 找到示例下载。

  • Vite + Svelte

  • Vite + SvelteKit

  • Vite + React — Unity 集成中包含了一个实验性模板，你可以在生成项目时选择它！

  • react-three-fiber — Unity 集成中包含了一个实验性模板，你可以在生成项目时选择它！

  • Vercel & Nextjs — 在这里找到一个 nextjs 项目示例

  • 不使用任何打包器的 CDN — 在这里找到代码示例

简而言之：我们目前提供一个最小化的 vite 模板，但你可以扩展它或切换到其他框架—— 请告诉我们你构建了什么以及如何构建，以及我们如何改进你的使用体验或提供示例！

:::tip 一些框架需要在 needle.config.json 中进行自定义设置。更多信息请参见此处。通常需要设置 baseUrl。 :::

:::details 如何在 Unity 中创建自定义项目模板？

你可以创建和分享你自己的 Web 项目模板，以使用其他打包器、构建系统，或完全不使用。

创建新模板

  1. 选择 Create/Needle Engine/Project Template 将 ProjectTemplate 添加到你想用作模板的文件夹中

  2. 完成！就是这么简单。

当项目中有 NpmDef 时（即当你的项目使用本地引用时），依赖项来自 unity。 你也可以将你的包发布到 npm 并通过版本号引用它们。 :::

Tree-shaking 以减小打包大小

Tree shaking 是 Web 应用打包中的一种常见实践（参见 MSDN 文档）。这意味着代码中未使用的代码路径和功能将从最终打包的 javascript 文件中移除，以减小文件大小。请参见下文，了解 Needle Engine 包含的功能以及如何移除它们：

:::details 如何移除 Rapier 物理引擎？(通过移除约 2MB (gzip 后约 600KB) 来减小总体打包大小)

  • 选项 1：通过 needlePlugins 配置： Set useRapier to false in your vite.config: needlePlugins(command, needleConfig, { useRapier: false }),

  • 选项 2：通过 vite.define 配置： Declare the NEEDLE_USE_RAPIER define with false

    define: {
  NEEDLE_USE_RAPIER: false
},

  • 选项 3：通过 .env Create a .env file in your web project and add VITE_NEEDLE_USE_RAPIER=false

  • 选项 4：通过 Unity 组件 Add the Needle Engine Modules component to your scene and set Physics Engine to None

:::

创建 PWA

我们支持直接从我们的 vite 模板轻松创建渐进式 Web 应用（PWA）。 PWA 是一种 Web 应用，加载方式与普通网页或网站相同，但可以提供用户功能，如离线工作、推送通知以及通常只有原生移动应用才能访问的设备硬件。

默认情况下，使用 Needle 创建的 PWA 支持离线功能，并且在你发布新版本的应用时，可以选择自动刷新。

  1. 在你的 Web 项目中安装 Vite PWA plugin：npm install vite-plugin-pwa --save-dev

  2. 如下所示修改 vite.config.js。确保将相同的 pwaOptions 对象传递给 needlePlugins 和 VitePWA。

import { VitePWA } from 'vite-plugin-pwa';

export default defineConfig(async ({ command }) => {

    // 创建 pwaOptions 对象。
    // 你可以在这里编辑或输入 PWA 设置（例如更改 PWA 名称或添加图标）。
    /** @type {import("vite-plugin-pwa").VitePWAOptions} */
    const pwaOptions = {};

    const { needlePlugins } = await import("@needle-tools/engine/plugins/vite/index.js");

    return {
        plugins: [
            // 将 pwaOptions 对象传递给 needlePlugins 和 VitePWA 函数
            needlePlugins(command, needleConfig, { pwa: pwaOptions }),
            VitePWA(pwaOptions),
        ],
        // vite 配置的其余部分...

:::tip 所有资源默认会被缓存 请注意，默认情况下，你的构建文件夹中的所有资源都会添加到 PWA 预缓存中——对于包含大量动态资产的大型应用程序，这可能不是你想要的（想象一下用户打开应用后，YouTube PWA 缓存所有视频！）。有关如何自定义此行为，请参见更多 PWA 选项。 :::

测试 PWA

要测试你的 PWA，部署页面，例如使用 DeployToFTP 组件。 然后，在浏览器中打开已部署的页面，检查 PWA 功能是否按预期工作：

  • 应用显示为可安装

  • 应用可以离线工作

  • 应用被 pwabuilder.com 检测为具备离线能力的 PWA

PWA 使用 Service Workers 缓存资源并提供离线支持。Service Workers 在开发过程中使用起来有些困难，通常只在构建时启用（例如，当你使用 DeployTo... 组件时）。

你可以通过在你的 vite.config.js 中的 options 对象中添加以下内容来启用开发时的 PWA 支持。

const pwaOptions = {
  // 注意：PWA 在开发模式下的行为不同。
  // 请确保在生产构建中验证其行为！
  devOptions: {
    enabled: true,
  }
};

请注意，开发模式下的 PWA 不支持离线使用——尝试这样做可能会导致意外的行为。

自动更新正在运行的应用

网站通常在页面刷新时显示新的或更新的内容。

在某些情况下，你可能希望在发布新版本时页面自动刷新和重新加载—— 例如在博物馆、贸易展览、公共显示器或其他长期运行的场景中。

要启用自动更新，请在 pwaOptions 对象中设置 updateInterval 属性，其值为应用应检查更新的时间间隔（以毫秒为单位）。如果检测到更新，页面将自动重新加载。

const pwaOptions = {
  updateInterval: 15 * 60 * 1000, // 15 分钟，单位毫秒
};

:::tip 周期性重新加载与用户数据 在用户与表单或其他可能因重新加载而丢失的数据进行交互的应用程序中，不建议使用自动重新加载。对于这些应用程序，建议显示重新加载提示。 有关如何实现重新加载提示而非自动重新加载的更多信息，请参见 Vite PWA plugin 文档。 :::

更多 PWA 选项

由于 Needle 在底层使用了 Vite PWA plugin，你可以使用其提供的所有选项和钩子。 例如，你可以提供一个带有自定义应用标题或主题颜色的部分 manifest：

const pwaOptions = {
  // 此处提供的 manifest 选项将覆盖默认值
  manifest: {
    name: "My App",
    short_name: "My App",
    theme_color: "#B2D464",
  }
};

对于部分缓存、自定义 Service Workers 或不同的更新策略等复杂需求，你可以从 needlePlugins 中移除 { pwa: pwaOptions } 选项，并直接通过 Vite PWA plugin 添加 PWA 功能。

从外部 javascript 访问 Needle Engine 和组件

你暴露的代码在打包后可以从 JavaScript 中访问。这允许构建查看器和其他应用程序，其中编辑时已知的数据与仅在运行时已知的数据（例如，动态加载的文件、用户生成的内容）是分开的。 要从引擎外部的普通 javascript 访问组件，请参阅与普通 javascript 互操作部分

自定义加载外观

参见 needle engine 组件参考 中的 加载显示 部分

内置样式

needle-engine 加载外观可以使用浅色或深色皮肤。 要更改外观，请在 <needle-engine> Web 组件上使用 loading-style 属性。 选项包括 light 和 dark（默认）：

<needle-engine loading-style="light"></needle-engine>

自定义加载样式 — 专业版功能

请参见 needle engine 组件参考 中的 加载显示 部分

自定义加载

页面由 AI 自动翻译

Previousgetting-startedNextindex

Last updated