TurboWarp 打包器技术文档

TurboWarp 打包器技术文档

packager Converts Scratch projects into HTML files, zip archives, or executable programs for Windows, macOS, and Linux. 项目地址: https://gitcode.com/gh_mirrors/pack/packager

本文档旨在为您提供详尽的指导，以帮助您了解、安装并有效地使用TurboWarp打包器。该工具能够将Scratch项目转换为HTML文件、ZIP归档或适用于Windows、macOS和Linux的可执行程序。

安装指南

确保您的计算机上已安装Node.js环境。接下来，遵循以下步骤来安装TurboWarp Packager：

1. 克隆仓库: 使用Git从GitHub克隆项目到本地:

   git clone https://github.com/TurboWarp/packager.git
   

2. 安装依赖: 进入项目目录，并通过npm安装所有必需的依赖项:

   cd packager
   npm ci
   

项目使用说明

开发模式启动

要开始开发或测试改动，运行以下命令在开发模式下启动项目:

npm start

之后，访问http://localhost:8947，手动刷新页面可看到实时更新。

创建生产构建

为了准备发布或分发，需要生成一个生产版本的构建:

npm run build-prod

生产构建会显著减小网站和打包器的文件大小，构建结果位于dist文件夹。

使用预构建的独立版本

若要使用预构建的独立版本，可从GitHub Releases下载。这些文件适合于网站被屏蔽或网络连接不稳定的情况。

项目API使用文档

对于开发者希望集成至Node.js应用的场景，详细API文档可在node-api-docs/README.md中找到。要构建Node.js模块的生产版本，请执行：

npm run build-node-prod

独立构建生成

如果您想创建一个包含完整打包器功能的单一HTML文件（独立构建），可以使用此命令：

npm run build-standalone-prod

独立构建文件将会保存在dist/standalone.html。

部署与自定义

• 部署: 将dist文件夹的内容复制到任何静态托管服务即可部署。
• 品牌自定义: 修改src/packager/brand.js以适应自己的应用名、链接等信息。
• 大型文件: 注意，如需处理Electron等大型二进制文件的下载，请参考src/packager/large-assets.js进行服务器配置。

许可证

本项目遵循Mozilla Public License 2.0许可协议。欲了解更多细节，请查看项目中关于许可证的文件或访问https://mozilla.org/MPL/2.0/。

以上是TurboWarp打包器的主要使用和技术细节概览。遵循上述步骤，您应该能够顺利地安装、配置并利用这个强大的工具来处理您的Scratch项目。

packager Converts Scratch projects into HTML files, zip archives, or executable programs for Windows, macOS, and Linux. 项目地址: https://gitcode.com/gh_mirrors/pack/packager