Chicago Brick 项目教程

Chicago Brick 项目教程

chicago-brick Software that displays content on a multi-node video wall. 项目地址: https://gitcode.com/gh_mirrors/ch/chicago-brick

1. 项目的目录结构及介绍

Chicago Brick 项目的目录结构如下：

chicago-brick/
├── AUTHORS
├── CONTRIBUTING
├── CONTRIBUTORS
├── LICENSE
├── README.md
├── deno.json
├── getting-started.md
├── package-lock.json
├── package.json
├── bin/
│   ├── run_1x1.sh
│   ├── run_2x2.sh
│   └── start_2x2_clients.sh
├── client/
├── config/
│   └── demo-playlist.json
├── demo_assets/
├── demo_modules/
├── extras/
├── lib/
├── server/
└── status/

目录介绍：

• AUTHORS: 项目作者列表。
• CONTRIBUTING: 贡献指南。
• CONTRIBUTORS: 贡献者列表。
• LICENSE: 项目许可证（Apache-2.0）。
• README.md: 项目介绍和基本使用说明。
• deno.json: Deno 配置文件。
• getting-started.md: 快速入门指南。
• package-lock.json: npm 锁定文件。
• package.json: npm 配置文件。
• bin/: 包含项目的启动脚本，如 run_1x1.sh 和 run_2x2.sh。
• client/: 客户端代码目录。
• config/: 配置文件目录，包含 demo-playlist.json。
• demo_assets/: 演示资源目录。
• demo_modules/: 演示模块目录。
• extras/: 额外资源目录。
• lib/: 库文件目录。
• server/: 服务器代码目录。
• status/: 状态文件目录。

2. 项目的启动文件介绍

项目的主要启动文件位于 bin/ 目录下，包括：

• run_1x1.sh: 用于在 1x1 模式下启动服务器，并加载指定的模块。例如：

  ./bin/run_1x1.sh -m gears
  

  这将启动服务器并在 1x1 模式下显示 gears 模块。

• run_2x2.sh: 用于在 2x2 模式下启动服务器，并加载指定的模块。例如：

  ./bin/run_2x2.sh -m gears
  

  这将启动服务器并在 2x2 模式下显示 gears 模块。

• start_2x2_clients.sh: 用于启动 2x2 模式下的客户端窗口。例如：

  ./bin/start_2x2_clients.sh
  

  这将启动四个浏览器窗口，分别显示不同的内容。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，包括：

• demo-playlist.json: 定义了播放列表的配置，包括模块的顺序、持续时间等。例如：

  {
    "playlist": [
      {
        "modules": ["gears", "slither"],
        "duration": 600,
        "moduleDuration": 60
      },
      {
        "modules": ["matrix"],
        "duration": 600,
        "moduleDuration": 600
      }
    ]
  }
  

  该配置文件定义了两个播放列表项，每个项包含一组模块及其播放时间。

此外，项目中的模块配置文件位于 demo_modules/ 目录下，每个模块包含一个 brick.json 文件，定义了模块的元数据和执行部分。例如：

{
  "name": "gears",
  "description": "A module that displays rotating gears on the wall."
}

这些配置文件共同决定了 Chicago Brick 项目的运行方式和显示内容。

chicago-brick Software that displays content on a multi-node video wall. 项目地址: https://gitcode.com/gh_mirrors/ch/chicago-brick