简单视频框架

简单视频框架

为模组作者提供的一个简单资源,可在红脚本或 lua 中播放带有声音的屏幕视频。

[img]https://i.ibb.co/whgd38FY/overview.png[/img]

一个简单的资源,供 mod 作者通过 redscript 或 lua 在屏幕上播放视频。只需 1 行代码!

定义了 1000 个 bink2 视频资源(键),你可以在你的 mod 中覆盖它们,然后在需要时从你的 lua 或 redscript mod 中在屏幕上播放。你只需带上你的视频,无需担心额外的代码。

方法定义在 player 对象上,因此可以从任何上下文(lua 或 redscript)中调用。

[credits]致谢[/credits]:特别感谢 Dedra 的测试和代码改进!

[img]https://i.ibb.co/JwWK1pP9/install.png[/img]

通过 mod 管理器安装,或解压到游戏目录。

[img]https://i.ibb.co/9H1g3rG8/usage.png[/img]

在你的 mod 中将 bink2 视频安装到以下路径。但为了避免与其他 mod 作者冲突,请在 0 到 1000 之间选择你的路径键。例如,与其选择 0-5 这样的顶部路径(其他 mod 作者可能也会这样做),不如选择一个对你 mod 而言独一无二、更安全的范围(例如 50-55)。

重要! 请查看评论区置顶帖,了解已使用的 mod 键注册表,以便避开这些键。

base\VideoFramework\movies\0.bk2 base\VideoFramework\movies\1.bk2 base\VideoFramework\movies\2.bk2 base\VideoFramework\movies\3.bk2 base\VideoFramework\movies\4.bk2 base\VideoFramework\movies\5.bk2 base\VideoFramework\movies\6.bk2 base\VideoFramework\movies\7.bk2 base\VideoFramework\movies\8.bk2 base\VideoFramework\movies\9.bk2 base\VideoFramework\movies\10.bk2 ... ...

base\VideoFramework\movies\1000.bk2

使用 player 对象上的这些方法来调用。完整 API 见本页底部文档部分。

public func PlayVideo(label: String, movie: Int32, w: Float, h: Float, delay: Float)
public func PlayFullScreenVideo(label: String, movie: Int32, delay: Float)
public func PlayVideoWithSound(label: String, movie: Int32, w: Float, h: Float, sound: String, delay: Float)
public func PlayFullScreenVideoWithSound (label: String, movie: Int32, sound: String, delay: Float)
public func StopVideo()
public func RemoveVideo(label: String)

delay 延迟时间(秒)。使用 0.0 可立即播放,否则将在延迟时间后播放。 movie 一个整数,表示要播放哪个视频。对应一个资源键(见下文)。 sound 一个 Audioware 音效片段标签。 label 是特定视频的唯一标签。例如 "movie0"。在需要时用于 RemoveVideo。 w 是宽度。 h 是高度。

注意:视频锚定在屏幕左上角(未来更新将允许不同的锚点)。

[img]https://i.ibb.co/5hGm8LZz/examples.png[/img]

LUA

Game.GetPlayer():PlayFullScreenVideo("video1",1,0.0)

REDSCRIPT

let player: ref<PlayerPuppet> = GetPlayer(GetGameInstance());
player.PlayFullScreenVideo("video1",1,0.0) 

SERVICE

let system: ref<VideoFramework> = GameInstance.GetScriptableSystemsContainer(this.GetGame()).Get(n"VideoFramework.System.VideoFramework") as VideoFramework;

system.PlayVideo(delay: Float, label: CName, size: Vector2, movie: Int32, player: ref<PlayerPuppet>)
system.PlayFullScreenVideoWithSound(label: String, movie: Int32, sound: String, delay: Float)
system.PlayFullScreenVideo(label: String, movie: Int32, delay: Float)

[img]https://i.ibb.co/fdkcLbCr/bink.png[/img]

要创建 bink 视频,你需要从这里下载 Rad Tools。

[img]https://i.ibb.co/mVP7jMph/Screenshot-2026-05-25-200702.png[/img]

另外,为了让一切正常工作,我不得不做了一些奇怪的事情。我在 Bink 中将格式设置为 Bink 1。然后在它创建文件后,我将文件后缀从 .bik 改为 .bk2。可能是因为 redengine 内部的驱动是旧版本的 bink。

第一步(如果你是视频制作新手)是创建(或使用现有视频).mp4 或 .mov 视频文件。我使用 OpenShot 视频编辑器。其他工具如 Adobe Premiere 或 After Effects 也可以。一旦你有了视频文件,参考上方的 Bink 应用将其转换为 bink .bk2 文件。你就完成了!

创建带透明度的视频

这是一个多步骤的过程。以下是步骤。

  1. 为你的前景对象视频添加绿色背景(也许使用像 OpenShot 这样的视频编辑器)。或者使用 AI(例如 Seedance 2.0 或 Veo)生成视频,并提示它制作纯绿色背景。你也可以给它一个现有视频,让它将背景替换为纯绿色。
  2. 使用 Adobe After Effects,将你的视频添加到时间轴。然后在效果选项卡中搜索 "KeyLight"。将其拖放到时间轴上的视频上。在该效果的属性中,你会看到一个吸管和一个颜色色板(可能是黑色)。点击吸管,然后点击视频预览中的绿色背景。
  3. 将你的视频添加到渲染队列,并将渲染属性输出格式设置为 "Quicktime"(你可能需要在计算机上安装 Apple Quicktime)。然后在该对话框的下拉菜单中选择 "RGB+Alpha" 作为输出格式类型。点击渲染。
  4. 使用 RAD Tools(创建 bink 视频),选择你新的 .mov quicktime 影片。确保勾选 "Use Alpha Plane" 复选框(见上方对话框图片)。确保你的输出格式为 "BINK 1",但将输出文件后缀名改为 .bk2。不确定为什么需要这一步,但确实需要。然后创建你的 bink!

你就完成了。

[img]https://i.ibb.co/CKS754fF/videos.png[/img]

此框架不会播放内置声音的视频。相反,你需要将你的声音添加到 mod 中的 Audioware 配置中,然后调用视频声音方法(见下文),传入 Audioware 片段标签。相关细节请参阅 Audioware 文档。

[img]https://i.ibb.co/fz26vRmw/gallery.png[/img]

以下是我 Knuckle Sandwich mod 中的一个示例,我在其中使用此框架在屏幕上播放微型视频动画。

[img]https://i.ibb.co/PZLG1KwP/ezgif-8ce3c516a0037235.gif[/img] [img]https://staticdelivery.nexusmods.com/mods/3333/images/29418/29418-1778027504-560010292.gif[/img]

[img]https://i.ibb.co/n8wJsTPM/docs.png[/img]


VideoFramework API 文档

VideoFramework mod 提供了一套精简的 API,用于在玩家的 HUD 上播放预渲染的 .bk2 视频。为便于使用,API 通过注入到 PlayerPuppet 类上的方法进行公开。

PlayerPuppet 扩展

你可以直接在任何 PlayerPuppet 实例(例如本地玩家)上调用这些方法。

PlayFullScreenVideo(label: String, movie: Int32, delay: Float) -> Void 播放一个缩放至填满整个用户屏幕的视频。

  • label:视频画布的唯一字符串标识符。如果具有此标签的画布已存在,则在创建新画布之前会将其移除。
  • movie:要播放的视频索引(有效范围:0 到 100)。这直接映射到位于 base\VideoFramework\movies\{index}.bk2 的文件。
  • delay:视频开始播放前等待的时间(秒)。使用 0.0 立即播放。

PlayVideo(label: String, movie: Int32, w: Float, h: Float, delay: Float) -> Void 以指定的宽度和高度播放视频,锚定在屏幕左上角。

  • label:视频画布的唯一字符串标识符。
  • movie:要播放的视频索引(0 到 100)。
  • w:视频画布的宽度(像素)。
  • h:视频画布的高度(像素)。
  • delay:视频开始播放前等待的时间(秒)。

PlayFullScreenVideoWithSound(label: String, movie: Int32, sound: String, delay: Float) -> Void 播放一个缩放至填满整个用户屏幕的视频,同时播放一个 AudioSystem 事件。

  • label:视频画布的唯一字符串标识符。
  • movie:要播放的视频索引(0 到 100)。
  • sound:要播放的音频事件的字符串名称。
  • delay:视频开始播放前等待的时间(秒)。

PlayVideoWithSound(label: String, movie: Int32, w: Float, h: Float, sound: String, delay: Float) -> Void 以指定的宽度和高度播放视频,同时播放一个 AudioSystem 事件。

  • label:视频画布的唯一字符串标识符。
  • movie:要播放的视频索引(0 到 100)。
  • w:视频画布的宽度(像素)。
  • h:视频画布的高度(像素)。
  • sound:要播放的音频事件的字符串名称。
  • delay:视频开始播放前等待的时间(秒)。

StopVideo() -> Void 停止当前跟踪的视频的播放。

RemoveVideo(label: String) -> Void 从屏幕上完全移除具有指定标签的视频画布。


VideoFramework 服务类

如需更低级别的访问,你可以直接与 VideoFramework 可脚本化系统交互。

获取实例

let videoFramework = VideoFramework.GetInstance(player);

方法

  • PlayVideoOnCanvas(...):将视频直接附加到指定的 inkCompoundWidget 根节点。如果你希望视频成为自定义 UI 层的一部分,而不是默认的 inkHUDLayer,这将很有用。
  • PlaySound(label: CName) -> Void:通过扩展音频系统触发声音事件。
  • GetMoviePath(index: Int32) -> ResRef:返回对应整数索引的 .bk2 文件的 ResRef 路径。

示例用法

redscript

// 立即全屏播放索引为 5 的视频
player.PlayFullScreenVideo("my_fullscreen_vid", 5, 0.0);

// 延迟 2.5 秒后以 1920x1080 播放索引为 10 的视频
player.PlayVideo("my_custom_vid", 10, 1920.0, 1080.0, 2.5);

// 延迟 2.5 秒后以 1920x1080 播放索引为 10 的视频并带声音
player.PlayVideoWithSound("my_custom_vid", 10, 1920.0, 1080.0, "SoundEvent", 2.5);

// 立即全屏播放索引为 2 的视频并带自定义音频
player.PlayFullScreenVideoWithSound("my_sound_vid", 2, "my_custom_audio_event", 0.0);

// 停止当前正在播放的视频
player.StopVideo();

// 从屏幕上移除视频画布
player:RemoveVideo("my_custom_vid");