DoomPDF 项目使用教程

DoomPDF 项目使用教程

doompdf A port of Doom (1993) that runs inside a PDF file 项目地址: https://gitcode.com/gh_mirrors/do/doompdf

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

DoomPDF 是一个将经典游戏 Doom (1993) 运行在 PDF 文件中的项目。项目的目录结构如下：

• .github/: 存放 GitHub 工作流程文件。
• .vscode/: 存放 Visual Studio Code 的配置文件。
• doomgeneric/: 存放 Doom 通用代码。
• web/: 存放网页相关的文件。
• .gitignore: 定义 Git 忽略的文件列表。
• LICENSE: 项目许可证文件，本项目采用 GNU GPL v2 许可。
• README.md: 项目说明文件。
• build.sh: 编译项目所需的脚本文件。
• embed_file.py: 用于嵌入文件的 Python 脚本。
• file_template.js: JavaScript 文件模板。
• generate.py: 用于生成 PDF 文件的 Python 脚本。
• pre.js: 预处理 JavaScript 文件。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的启动主要是通过 build.sh 脚本完成的。以下是启动项目的步骤：

1. 克隆项目到本地：

   git clone https://github.com/ading2210/doompdf.git
   

2. 创建虚拟环境并激活：

   python3 -m venv .venv
   source .venv/bin/activate
   

3. 安装项目依赖：

   pip3 install -r requirements.txt
   

4. 编译项目：

   env CFLAGS=-O3 ./build.sh
   

编译完成后，生成的文件将会在 out/ 目录下。

3. 项目的配置文件介绍

项目的主要配置是通过 requirements.txt 文件进行的，它列出了项目依赖的 Python 包。以下是一个基本的配置文件内容示例：

PyMuPDF==1.19.2
requests==2.25.1

确保在虚拟环境中安装了这些依赖项，以便项目能够正常运行。

此外，项目可能还涉及到其他配置，例如在 build.sh 脚本中设置的编译参数。根据项目的需要，可能还需要调整 JavaScript 文件 pre.js 中的代码来实现特定的功能。

doompdf A port of Doom (1993) that runs inside a PDF file 项目地址: https://gitcode.com/gh_mirrors/do/doompdf