Sparkly FX

A video recording tool for Team Fortress 2, developed using xsdk-base.

Features:

• Record various image and video formats with/without FFmpeg
• Faster-than-realtime recording with multi-threading and hardware-acceleration
• Output multiple streams/layers
• Highly customizeable streams (Multiple mattes, visibility filters, color adjustment, unlimited FOV)

Usage:

• From the releases page, download sparkly-fx.zip and extract it.
• Using a DLL-loader/DLL-injector, load the extracted DLL file into Team Fortress 2.
• In-game, press the F11 or Insert key to open and use the Sparkly FX menu. (A console message from Sparkly FX will appear if it loaded correctly.)
• Alternatively, you may use HLAE's loader.

Console commands: Read console-commands.md.

Please read known-bugs.md. This software is in early development.

You can chat with fellow TF2 video editors (including me) in the Castellum Discord server:

Below are the original README contents for xsdk-base.

xsdk-base

An SDK compatible with multiple Windows versions of Source Engine.

Downloading / cloning:

git clone <repo> --recursive If files / submodules appear to be missing after pulling new commits, update with git submodule update --init --recursive

Building

CMake

1. Open your build directory

mkdir build
cd build

2. Configure a 32-bit or 64-bit build (depending on the game)

# This will use the default architecture
cmake <xsdk-base-folder> -D XSDK_BUILD_EXAMPLES=1
# This will use 32-bit, specifically
cmake <xsdk-base-folder> -D XSDK_BUILD_EXAMPLES=1 -A Win32

3. Build a debug or release binary

# This builds the default config (Debug)
cmake --build .
# This builds a release binary with debug info. This improves the symbols in stack traces.
cmake --build . --config RelWithDebInfo

Visual Studio

There are a couple options.

• A: Open the CMake project with VS, or
• B: Perform the CMake steps 1 & 2 to generate the VS project files
  • This should use Visual Studio's CMake Generator by default. If not, you will have to add a commandline argument to set VS as the CMake Generator.