DanmuGame 项目使用教程

DanmuGame 项目使用教程

1. 项目目录结构及介绍

DanmuGame/
├── DanmuGame/
│   ├── DanmuGame.exe
│   ├── GameScript.lua
│   ├── config.json
│   └── ...
├── DanmuUtil/
│   ├── DanmuUtil.exe
│   └── ...
├── doc/
│   └── image/
│       └── ...
├── LICENSE
├── README.md
└── ...

目录结构说明

• DanmuGame/: 包含游戏框架的主要文件，包括可执行文件 DanmuGame.exe、游戏脚本 GameScript.lua 和配置文件 config.json。
• DanmuUtil/: 包含直播间监听程序的主要文件，包括可执行文件 DanmuUtil.exe。
• doc/: 包含项目文档和相关图片资源。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。

2. 项目启动文件介绍

DanmuUtil.exe

DanmuUtil.exe 是直播间监听程序的可执行文件。启动此程序后，它会连接到指定的 Bilibili 直播间，监听弹幕消息，并将这些消息传递给游戏框架。

DanmuGame.exe

DanmuGame.exe 是游戏框架的可执行文件。启动此程序后，它会加载 GameScript.lua 中的游戏逻辑，并根据 config.json 中的配置启动游戏窗口。

3. 项目配置文件介绍

config.json

config.json 是项目的配置文件，用于配置直播间信息和游戏设置。以下是配置文件的详细说明：

{
  "room": "需要监听的直播间房间号（完整房间号，非短房间号）",
  "port": "DanmuUtil 程序和 DanmuGame 游戏框架在本地通信的端口号",
  "window-title": "游戏窗口标题文本",
  "window-size": {
    "width": "游戏窗口宽度（单位：像素）",
    "height": "游戏窗口高度（单位：像素）"
  },
  "full-screen": "游戏窗口全屏（将覆盖游戏窗口尺寸设置）",
  "max-fps": "游戏最高帧率，设置过大的最高帧率可能导致实际帧率不稳定（建议区间：60 ~ 144）",
  "linear-filtering": "对游戏画面开启线性过滤抗锯齿（某些需要对图片素材缩放的像素风游戏可能不适合开启）"
}

配置项说明

• room: 需要监听的直播间房间号，必须是完整的房间号，而非短房间号。
• port: DanmuUtil 程序和 DanmuGame 游戏框架在本地通信的端口号。
• window-title: 游戏窗口的标题文本。
• window-size: 游戏窗口的尺寸，包括宽度和高度，单位为像素。
• full-screen: 是否全屏显示游戏窗口，设置为 true 或 false。
• max-fps: 游戏最高帧率，建议设置在 60 到 144 之间。
• linear-filtering: 是否开启线性过滤抗锯齿，设置为 true 或 false。

通过以上配置，可以灵活调整游戏的行为和显示效果。