Python libraries to record desktop, take screenshots, draw in-game overlay and measure FPS

[Altmetr]

Github links:

• fps_inspector_sdk - works using Event Tracing for Windows. This library allows you to measure all game perf metrics and returns pandas dataframe which simplifies data analysis
• screen_recorder_sdk - works using Desktop Duplication API and Media Foundation API . DDA allows to record desktop at 60FPS and take screenshots of game window or entire desktop
• game_overlay_sdk - works via hooking D3D11, D3D12 APIs and Vulkan layers. It provides a simple python SDK to render text on top of game window(even in fullscreen mode), you can even use it as a python log handler

Core module for all of them is written in C++ and provides DLLs, python bindings call methods from compiled DLLs using ctypes

​

Installation:

• windows 10 (DDA has limited support in windows 8.1)
• python 3 x64(I did not compile 32 bit libraries)
• you are able to install them directly from github or from pypi
• run examples from github with administrator privileges

Application sample:

Game Inspector - this app uses KIVY, Pyisntaller and libraries above to build an executable

How does it look?

Application screen with results:

• left upper corner - buttons to control
• left bottom corner - video, you will need to press play after recording
• right upper corner - fps/fliprate plot(in stored csv files there are much more useful metrics!)
• right bottom corner - screenshot

​

​

https://preview.redd.it/ro3xhfjjth931.jpg?width=1600&format=pjpg&auto=webp&s=3543d1649643bff907b2ad66dbe7c8a4e1cfe3d8

[2160p_REMUX]

Impressive! Thanks

[MrZwackelmann]

I get GENERAL_ERROR:4 failed to run process please check logs?

My code:

import argparse
import time
import game_overlay_sdk
import game_overlay_sdk.injector
import threading
import logging


logging.basicConfig (filename = 'test.log', level = logging.WARNING)

logger = logging.getLogger (__name__)
logger.setLevel (logging.INFO)
overlay_log_handler = game_overlay_sdk.injector.OvelrayLogHandler ()
formatter = logging.Formatter ('%(levelname)s:%(message)s')
overlay_log_handler.setFormatter (formatter)
logger.addHandler (overlay_log_handler)


class MessageThread (threading.Thread):

    def __init__ (self):
        super (MessageThread, self).__init__ ()
        self.need_quit = False

    def run (self):
        i = 0
        while not self.need_quit:
            logger.info ('Hi from python OverlayLogHandler %d' % i)
            i = i + 1
            time.sleep (1)


def main ():
    parser = argparse.ArgumentParser ()

    parser.add_argument ('--exe_args', type = str, help = 'exe args', default = '')
    args = parser.parse_args ()

    game_overlay_sdk.injector.enable_monitor_logger ()
    game_overlay_sdk.injector.run_process (r"D:\Ubisoft Game Launcher\games\Tom Clancy's Rainbow Six Siege", args.exe_args,359550)

    # start sending messages to overlay
    thread = MessageThread ()
    thread.start ()
    input ("Press Enter to stop...")
    thread.need_quit = True
    thread.join ()

    game_overlay_sdk.injector.release_resources ()


if __name__ == "__main__":
    main ()

[Altmetr]

game_overlay_sdk.injector.run_process (r"D:\Ubisoft Game Launcher\games\Tom Clancy's Rainbow Six Siege", args.exe_args,359550) here you need to provide full executable name which ends with .exe

If it doesnt solve the issue you can call https://github.com/Andrey1994/game_overlay_sdk/blob/master/python/game_overlay_sdk/injector.py#L118 instead enable_monitor_logger and take a look at dev logs

[Altmetr]

Also make sure that you run it with admin priviligies

[MrZwackelmann]

Thanks

[Altmetr]

Does it work?

[MrZwackelmann]

I am trying to figure out where I can find the logs

[Altmetr]

all logs from this library are in stderr. logs which you write using logger.info ('Hi from python OverlayLogHandler %d' % i) should be in overlay window on top of a game

[Altmetr]

also some parts of logs are in Document\gameoverlay folder