Skip to content

partouf/OBSInfoWriter

Repository files navigation

OBSInfoWriter

Multiplatform version of ObsInfoPlugin to write timestamps to a file.

Plugin thread on the OBS forums: https://obsproject.com/forum/resources/infowriter.345/

For the original OBS-classic version, go to https://github.com/partouf/ObsInfoPlugin


Installation

Just use the installer...

Windows

  • Place the 64bit OBSInfoWriter.dll in your \obs-studio\obs-plugins\64bit folder
  • Place the 32bit dll file in your \obs-studio\obs-plugins\32bit folder

Linux

  • Place the libOBSInfoWriter.so file into the /usr/lib/x86_64-linux-gnu/obs-plugins folder
    • Note: the section "~/" indicates your home folder
    • If you have an older OBS version, the install folder is ~/.config/obs-studio/plugins/OBSInfoWriter/bin/64bit/

MacOSX

  • Right-click on OBS in Applications and choose "Show package contents"
  • Place the libOBSInfoWriter.so file (from the libOBSInfoWriter.OSX.zip file) in the plugins folder

Configuration

  • Add the InfoWriter Source to 1 scene (the scene doesn't have to be always active).
  • Configure the Source and select the text file where you want the timestamps to be written to. configure the source Alternatively, you may sync both name and path with the video and specify automatic text file extension. sync both name and path with the video
  • Set the hotkeys you want to use in File -> Settings -> Hotkeys set the hotkeys

Filename formatting options

You can name a Logfile to be saved with variables that may change every time you start a recording or stream. You can name your logfile for example: "C:\temp\recording %Y%m%d.txt" to tell InfoWriter to name your file "recording 20180204.txt" when it's the 4th of February 2018. More variables can be found at http://www.cplusplus.com/reference/ctime/strftime/

Format options

The format option is very limited in it's use, the variables in the formatting are translated to hours:minutes:seconds from when the recording or stream was started, %02d is only to indicate that there is a preceding 0 for the numbers 0 to 9. It is recommended the default value is not changed.

What is possible that might improve logging is that you can put spaces or a \t tab character in front of the format, so your log times are indented in between the start and stop of the recording or stream.

More hotkeys

Contributed by https://github.com/RetroGamer74 Hotkeys List Sample

NEW CHANGES (TheTawnyFool)

Contributed by https://github.com/TheTawnyFool

Changed the output to log seperate timers for recording and streaming. Allows for indepedent timestamps of streaming and recordings at the same time. 

Updated to fix problems with OBS newer update to allow pausing in recordings.  Now when you pause a recording, the recording timer used by the hotkeys will pause until you resume the recording.  This way the record timer offsets of the hotkey events to be synced correctly with the video. The streaming timer will not pause if you are tracking both.

Checkbox to log streaming events

  Allows turning on and off logging relating to streaming. Recommend to leave off if not streaming, and or not wanting to log timers relating to streaming.

Building

You can quickly start working on this project by building it locally.

First, you need to ensure to have necessary dependencies. OBSInfoWriter is dependent on OBS Studio project that can be found at https://github.com/obsproject/obs-studio You should have OBS Studio available locally. Necessary instruction is available at https://github.com/obsproject/obs-studio/wiki/Building-OBS-Studio but keep in mind that platform specific instructions are available on separate wiki pages. Other dependencies are downloaded automatically when generating the project using CMake.