VVVV.js 技术文档

2024-12-24 23:12:47作者：冯爽妲Honey

vvvv.js

项目地址：https://gitcode.com/gh_mirrors/vv/vvvv.js

1. 安装指南

环境准备

在开始安装 VVVV.js 前，您需要确保您的系统中已经安装了 Node.js 6.x。您可以从 Node.js 官网下载并安装。

获取 VVVV.js

下载或克隆 VVVV.js 到您的项目目录中，例如 /your/project/directory/vvvv_js。

初始化项目

在命令行中进入到 VVVV.js 的目录下，执行以下命令来安装依赖：

npm install

创建模板项目

您可以选择下载或克隆 VVVV.js 模板项目到 /your/project/directory/vvvvjs-template。如果选择使用模板，可以跳过以下步骤。

创建 VVVV.js 补丁

在您的项目目录中创建一个空的 VVVV 补丁文件，例如 /your/project/directory/main.v4p。

配置前端 HTML

确保您的 HTML 文件包含并加载了 VVVV.js，如下所示：

<head>
  ...
  <script language="JavaScript" src="/vvvvjs/lib/require.js"></script>
  <script language="JavaScript" src="/vvvvjs/vvvv.js"></script>
  <link rel="VVVV" href="main.v4p"/>
  <script language="JavaScript">
    VVVVContext.init("/vvvv_js/", 'full', function() {
      console.log('VVVV.js initialized');
    });
  </script>
  ...
</head>

启动 VVVV.js 服务器

在您的项目目录中运行以下命令来启动 VVVV.js 的 Web 服务器：

$ node vvvv_js/server.js . -e

这将启动 Web 服务器并服务于当前目录。使用 -e 选项将启用补丁编辑。

访问 http://localhost:5000，您将看到 index.html。

2. 使用说明

运行补丁

如上所述，您可以通过 HTML 中的 <link> 标签或 JavaScript 代码来加载和运行 VVVV.js 补丁。

启动补丁编辑器

要启动编辑器，请将 URL 的地址栏中添加 #edit/main.v4p。这将启动编辑器在一个弹出窗口中，请确保您的浏览器允许弹出窗口。

按下 CTRL+S 可以在编辑器中保存您的更改。

手动加载补丁

如果不使用 <link> 标签的方法（例如，您不希望立即运行补丁），您可以自己创建 VVVV.Core.Patch 对象：

<head>
  ...
  <script language="JavaScript" src="/vvvv_js/lib/require.js"></script>
  <script language="JavaScript" src="/vvvv_js/vvvv.js"></script>
  <script language="JavaScript">
    VVVVContext.init("javascripts/vvvv_js/", 'full', function(VVVV) {
      console.log('VVVV.js initialized');

      var patch = new VVVV.Core.Patch("mypatch.v4p", function() {
        var mainloop = new VVVV.MainLoop(p);
        console.log('patch loaded and started');
      });
    });
  </script>
  ...
</head>

使用 VVVViewer 渲染补丁

您可以通过创建一个 Patch 对象，然后将其传递给一个新的 VVVViewer 对象来加载和渲染嵌入在网站中的补丁：

var myvvvviewer;
var mypatch = new VVVV.Core.Patch("mypatch.v4p", function() {
  myvvvviewer = new VVVV.VVVViewer(this, '#patch');
});

对应的 HTML 代码为：

<div id='patch'>Your browser does not support the VVVViewer</div>

3. API 使用文档

关于 VVVV.js API 的详细信息，您可以访问其官方网站 www.vvvvjs.com 获取更多的指导和文档。

4. 项目安装方式

如上所述，项目的安装方式包括下载或克隆 VVVV.js 到您的项目目录，初始化项目依赖，配置前端 HTML 文件以及启动 VVVV.js 的 Web 服务器。按照这些步骤，您可以成功安装并运行 VVVV.js。