Skip to content

A script for OBS that shows lagged/skipped/dropped frames and other data on your stream and/or in chat.

License

Notifications You must be signed in to change notification settings

GreenComfyTea/OBS-Stats-on-Stream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

OBS Stats on Stream

Shows obs stats on stream and/or in Twitch chat. Supported data: encoder, output mode, canvas resolution, output resolution, missed frames, skipped frames, dropped frames, congestion, average frame time, fps, memory usage, cpu core count, cpu usage, audio bitrate, video bitrate, streaming duration, recording duration, streaming status and recording status.

Text Formatting Variables Bot Commands

Contributors Issues Issues Closed Pull Requests Pull Requests Closed
License Release Version Release Date Platform Maintenance

Commits Last Commit Commits Since
Commit Activity (Year) Commit Activity (Month) Commit Activity (Week)

Repo Size Line Count Goto Counter
Sponsors Watchers Forks Stars Hits

Website Followers Twitter Twitch
Author Open Source Written in

How to use

  1. Download the script from the release page. Unzip the archive.
  2. Add a text source to your scene. This source will be used to display the data.
  3. Open Tools -> Scripts. Add the OBS-Stats-on-Stream.lua script.
  4. Configure the script.
    • If you don't need Twitch Bot functionality, uncheck Enable Bot mark.

    • Update Delay determines how often the data will be updated. 1000 ms means once a second. 100 ms means 10 times a second.

    • Bot Delay determines how often the bot will read chat and write to it.

    • Enter bot's (or your own) nickname in Bot Nickname field.

    • Enter Bot OAuth Password for the bot's (or your own) twitch account. You can get it here: click.

    • Enter Channel Nickname your bot gonna join (it gonna accept commands from this chat and print there). PLEASE, ONLY JOIN YOUR OWN CHANNEL. DO NOT TRY TO JOIN OTHER CHANNELS.

    • Link your created text source.

    • Modify Text Formatting if needed. all $name are variables and are replaced with actual values.

  5. You are ready to go!

πŸ“Œ NOTE: If you don't need Text Source functionality, you don't need to add a text source and link it in the script.

πŸ“Œ NOTE: If you don't need Twitch Bot functionality, you can use Enable Bot checkbox to disable it. You also don't need to type Bot Nickname, Bot OAuth Password and Channel Nickname in that case.

πŸ“Œ NOTE: Bot only works on Twitch. I have no knowledge nor intentions to make it work on YT or any other platform.

πŸ“Œ NOTE: If you use source code instead of the release page, the script will not come precompiled into one file, but instead will be composed of many files. OBS-Stats-on-Stream.lua file and a bunch of files in modules folder. The file and the folder must be located in the same place and in OBS you only need to add OBS-Stats-on-Stream.lua as a script.

Contribution

Big thanks to jammehcow for helping me with figuring out Socket functionality in Lua!

OBS Docs are very confusing. If you want to contribute feel free to message me, make a pull request or open an issue!

Donate

Another way to support me is donating! Thank you for using this script!

Qries Qries