Unblock

Steam清单获取工具部署文档

本文档详细说明如何部署和启动Steam清单获取工具，包括环境要求、安装步骤和注意事项。

一、环境要求

1. 系统要求

  • 操作系统：Windows 10/11、macOS或Linux
  • 磁盘空间：至少500MB可用空间
  • 内存：至少4GB RAM

2. 软件依赖

  • Python：版本3.8或更高（推荐3.11+）
  • Node.js：版本16或更高（推荐20+）
  • npm：版本7或更高

二、部署步骤

1. 准备工作

  1. 确保已安装所需的Python和Node.js版本

    1
    2
    3
    4
    5
    6
    7
    8
    # 检查Python版本
    python --version

    # 检查Node.js版本
    node --version

    # 检查npm版本
    npm --version

  2. 确保项目目录结构完整，应包含以下关键文件和目录：

    • api.py：后端API服务
    • requirements.txt：Python依赖列表
    • package.json：Node.js依赖配置
    • src/：前端源代码
    • dist/：构建后的前端文件
    • config：GitHub Token配置文件

2. 安装依赖

  1. 安装Python依赖

    1
    2
    # 在项目根目录下执行
    pip install -r requirements.txt

  2. 安装Node.js依赖（如需重新构建前端）

    1
    2
    # 在项目根目录下执行
    npm install

3. 配置GitHub Token

  1. 确保项目根目录下存在config文件，包含有效的GitHub Token
  2. 如果没有，请创建此文件并添加Token（不含任何其他字符或换行符）

4. 启动项目

方式一：直接启动（使用已构建的前端）

  1. 启动后端API服务

    1
    2
    # 在项目根目录下执行
    python api.py

  2. 访问应用

方式二：开发模式启动（适用于开发调试）

  1. 启动后端API服务

    1
    2
    # 在项目根目录下执行
    python api.py

  2. 启动前端开发服务器

    1
    2
    # 在项目根目录下执行
    npm run dev

  3. 访问应用

方式三：重新构建前端（如有修改）

  1. 构建前端

    1
    2
    # 在项目根目录下执行
    npm run build

  2. 启动后端API服务

    1
    2
    # 在项目根目录下执行
    python api.py

  3. 访问应用

三、使用说明

1. 获取Steam游戏清单

  1. 在”游戏搜索”页面，输入游戏名称进行搜索
  2. 从搜索结果中选择目标游戏
  3. 输入AppID，点击”获取清单”按钮
  4. 系统将自动获取清单和密钥信息
  5. 获取成功后，可以复制或下载生成的Lua文件

2. 单机游戏下载

  1. 在”单机游戏”页面，输入游戏名称进行搜索
  2. 从搜索结果中选择目标游戏
  3. 点击游戏卡片，查看下载信息
  4. 使用提供的百度网盘链接下载游戏

四、注意事项

1. 安全与配置

  • GitHub Token安全：请妥善保管GitHub Token，不要泄露给他人
  • 数据存储：所有清单文件数据统一存储在date文件夹下，请定期备份
  • 网络要求：确保能够正常访问GitHub和Steam相关API
  • 端口占用：确保5001端口未被其他应用占用

2. 常见问题

  • 启动失败：检查配置文件是否存在，GitHub Token是否有效
  • 获取清单失败：可能是网络问题，或者仓库中没有相关游戏的数据
  • 前端无法访问API：检查后端服务是否正常运行，端口是否正确

3. 性能考虑

  • 处理大型游戏清单可能需要较长时间，请耐心等待
  • 同时处理多个请求可能会影响系统性能
  • 建议定期清理date文件夹中不再需要的数据，以节省磁盘空间

4. 免责声明

  • 本工具仅用于学习和研究目的
  • 使用本工具产生的所有结果均由用户承担，与开发者无关
  • 请遵守相关法律法规，不要用于非法用途

五、维护与更新

1. 日志管理

  • 运行日志会在控制台输出，建议重定向到文件以便查看
    1
    python api.py > log.txt 2>&1

2. 更新方式

  • 获取最新代码后，重新安装依赖并重启服务
  • 如有前端更新，需要重新构建前端

3. 备份建议

  • 定期备份date文件夹和config文件
  • 在进行重大更新前，建议先备份整个项目

六、说明

依旧是ai写的，很详细了，端口只要改api.py和vite.config.js中的就行了，改完重新构建静态文件。