Skip to content

Davidj361/OBS-ChapterMarker

Repository files navigation

Chapter Marker

https://obsproject.com/forum/resources/chapter-marker.1323/

Table of Contents

Description

This is a plugin for OBS that lets you add chapters to the video file you are recording which are marked via a hotkey. A great alternative to using InfoWriter. Useful for video highlights when recording lengthy videos. Can be used for gameplay analysis like analyzing deaths, or marking parts of a recording for editing purposes, or even just for gameplay highlights that you want in your killmontage.

Disclaimer

  • Only operates when recording MKV files. Reason being that MKV containers end up being the least corruptable in my opinion, but I might change that if people request it and test for me.
  • 2x the space of a recorded video is REQUIRED. Meaning if your finished recording is 1 GB, you'll need at least 2 GB of free space on your drive. Reason being is that I cannot intercept the recording/encoding of OBS. Instead the recorded video is duplicated (remuxed) but with added on metadata and where the older recording is deleted and the newer one is renamed to the older one. If you don't have enough space on the drive you're recording onto then no duplication or deletion is made but OBS may bug out.

Build Instructions for Windows

Note: The project uses C++17 and the project was forked off https://github.com/obsproject/obs-plugintemplate.

Prequisites

  • Building OBS Studio
  • obs-deps
  • obs-deps Qt6
  • CMake
  1. Build OBS Studio, follow the instructions in the link.
  2. Download obs-deps and obs-deps qt6
  3. Open CMake GUI
  4. Press Configure where you'll get errors
  5. Set CMAKE_PREFIX_PATH as needed for all the requested dependencies, e.g.
    F:/code/Visual Studio/Visual Studio Community 2019/obs-studio/build/libobs;F:/code/Visual Studio/Visual Studio Community 2019/obs-studio/build/deps/w32-pthreads;F:/code/Visual Studio/Visual Studio Community 2019/obs-studio/build/UI/obs-frontend-api;F:/code/Visual Studio/Visual Studio Community 2019/obs-deps/lib;F:/code/Visual Studio/Visual Studio Community 2019/obs-deps/include;F:/code/Visual Studio/Visual Studio Community 2019/obs-deps
  6. Click Generate
  7. Click Open Project, should open the project in Visual Studio 2022
  8. Build the solution in Release Mode
  9. Paste the dll to your OBS plugins directory

Basic Usage

  • After install this plugin, a new option "Create chapter marker" will be available (File > Preferences > Hotkeys). Map it to something meaningful to you:
    • OBS option
  • Do some recording, invoking this hotkey.
  • Open the mkv file created, and search the chapters marks, e.g.:
    • Each chapter will have a number as identification (starting with 1)
    • list of chapters in VLC-player
  • Markers are displayed differently according to the video player, so, an alternative is to list chapters using ffprobe -show_chapters <your_video_name.mkv>.
  • obs-websocket users: To push the hotkey "ChapterMarker"