{"id":15015473,"url":"https://github.com/andrey1994/game_inspector","last_synced_at":"2025-04-12T09:15:01.822Z","repository":{"id":49355025,"uuid":"192812662","full_name":"Andrey1994/game_inspector","owner":"Andrey1994","description":"Tool to measure FPS, take screenshots, record video and draw overlay","archived":false,"fork":false,"pushed_at":"2019-06-30T17:17:57.000Z","size":159,"stargazers_count":45,"open_issues_count":1,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T09:14:51.810Z","etag":null,"topics":["fps","fps-counter","fpsdisplay","game-development","game-engine","game-overlay","kivy","kivy-application","kivy-framework","python","screen-capture","screenshot","video-recording"],"latest_commit_sha":null,"homepage":"https://andrey1994.github.io/game_inspector/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Andrey1994.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-19T22:32:29.000Z","updated_at":"2025-04-10T11:46:12.000Z","dependencies_parsed_at":"2022-09-24T00:00:17.058Z","dependency_job_id":null,"html_url":"https://github.com/Andrey1994/game_inspector","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Andrey1994%2Fgame_inspector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Andrey1994%2Fgame_inspector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Andrey1994%2Fgame_inspector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Andrey1994%2Fgame_inspector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Andrey1994","download_url":"https://codeload.github.com/Andrey1994/game_inspector/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248543839,"owners_count":21121838,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fps","fps-counter","fpsdisplay","game-development","game-engine","game-overlay","kivy","kivy-application","kivy-framework","python","screen-capture","screenshot","video-recording"],"created_at":"2024-09-24T19:47:31.104Z","updated_at":"2025-04-12T09:15:01.796Z","avatar_url":"https://github.com/Andrey1994.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Game Inspector\nIt's a tool to measure FPS, FlipRate and other metrics, take screenshots, record video and draw overlay\n\nThis applications is based on:\n* [fps_inspector_sdk](https://github.com/Andrey1994/fps_inspector_sdk)\n* [screen_recorder_sdk](https://github.com/Andrey1994/screen_recorder_sdk)\n* [game_overlay_sdk](https://github.com/Andrey1994/game_overlay_sdk)\n\n**These python libraries could be used for automation and to develop other applications**\n\nfps_inspector_sdk and screen_recorder_sdk are API agnostic and dont hook inside game process and can be used without game_overlay_sdk which hooks inside game process, so without overlay **it works with all games on all hardware**. To use them without overlay you need to choose PID mode in configuration window.\n\nGame overlay is an experimental feature, for now it should work with x32 and x64 games which are based on:\n* DX11\n* DX12\n* Vulkan\n\nTo use Game Overlay you need to choose Process Path or Process Name option, also for Steam Games you need to enter Game Id and make sure that Steam Client App is running, more information about these options can be found in [game_overlay_sdk readme](https://github.com/Andrey1994/game_overlay_sdk). If Steam game chashes during start try to run it first manually, close and rerun via game_inspector\n\n## Installation(exe)\nJust download a standalone executable file from [release page](https://github.com/Andrey1994/game_inspector/releases)\n\n## Installation(Python)\nFirst of all you need to install Python 3 x64\n\nTo install all dependencies please run:\n```\ngit submodule update --init --recursive\npython fps_inspector_sdk\\python\\setup.py install\npython screen_recorder_sdk\\python\\setup.py install\npython game_overlay_sdk\\python\\setup.py install\npython -m pip install -r requirements.txt\ngarden.bat install filebrowser --kivy\ngarden.bat install matplotlib --kivy\n```\nfps_inspector_sdk, screen_recorder_sdk and game_overlay_sdk could be installed from PYPI but in this case pyintaller will fail to find DLLs which are required for these packages, so I've attached them as submodules.\n\nAfter that you will be able to run it using:\n```\npython game_inspector.py\n```\nTo create a standalone executable please run:\n```\npyinstaller game_inspector.spec\n```\ngame_inspector.exe will be in dist folder\n\n## Usage Sample\n**You need to run it with administrator priviligies and I recommend to start it from cmd, in this case you will see logs**\n### Welcome Screen\n![welcome](https://live.staticflickr.com/65535/48117105993_fed148044b_b.jpg)\nJust press *Configure Session*\n### Configuration\nHere you have to specify one of the following options:\n* PID(no overlay) - Process Id from running process, you can set 0 here, the application will taks screenshot of entire screen and record all events for FPS calculation. \n* Process Path(Overlay, works with SteamApp Id) - Path to an executable, application will run it. You can use filebrowser and click *Ok*\n* Process Name(Overlay, doesnt works with SteamApp Id) - process name with extension, you will need to run it manually\n\nOptional Inputs:\n* SteamApp Id -  required for Steam Games, can be found [here](https://steamdb.info/search)\n* Hotkeys which you are able to override(default are shift+i, shift+o, shift+p)\n![configuration](https://live.staticflickr.com/65535/48117073956_4074e6d06b_b.jpg)\n\n### Run\nIf you choosed overlay capable mode you will see game overlay in the left bottom corner, to start messaging you need to trigger hotkeys or press buttons, in PID mode you will not see an overlay but everything else will be the same.\n**UI:**\n* left upper corner - buttons to control\n* left bottom corner - video, you will need to press play after recording\n* right upper corner - fps/fliprate plot(in stored csv files there are much more useful metrics!)\n* right bottom corner - screenshot\n![run](https://live.staticflickr.com/65535/48117073881_37c41695a9_b.jpg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrey1994%2Fgame_inspector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrey1994%2Fgame_inspector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrey1994%2Fgame_inspector/lists"}