Simple Video Framework

A simple resource for modders to play on screen videos from redscript or lua. 1 line of code!

Defines 1000 bink2 video resources (keys) that you override in your mod and then play on screen from your lua or redscript mod when needed. You just bring your videos and not worry about the extra code.

Methods are defined on the player object so can be invoked from any context, in lua or redscript.

CREDITS: Big shout out to Dedra for testing, and code improvements!

From mod manager or unzip into game directory.

Install your bink2 videos in these paths inside your mod. But to avoid overlapping with other modders, choose your path keys from 0 to 1000 somewhere. For example, rather than choosing the top paths like 0-5 where other modders might do the same, choose a safer range that would be unique to your mod (e.g. 50-55).

IMPORTANT! See the sticky post in the comments section for the registry of used keys for mods so you can avoid those.

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

Invoke using these methods on player object. Full API in the documentation section at the bottom of this page.

public func PlayVideo(label: String, movie: Int32, w: Float, h: Float, delay: Float)

public func PlayFullScreenVideo(label: String, movie[co