OBS Studio - Free and open source software for live streaming and screen recording
Go to file
Aleks Todorov 80ad63a6da cmake: Provide a clear error on version check fail
Currently, when git describe fails to get a git tag for the OBS Version,
a non-fatal message is printed, and the generator is left to continue,
usually ending up with a more cryptic error message down the line.

Instead, print the git output together with a short description of what
actually happened, and exit fatally so the problematic line of code is
clear. An added advantage is that the git output is printed in red
instead of (say) white on color-enabled terminals.
2024-04-04 15:13:43 -04:00
.github CI: Update formatting actions to use git diff filter before formatting 2024-04-02 19:38:09 -04:00
additional_install_files Improve additional_install_files for debug/release 2014-07-18 22:41:11 -07:00
build-aux CI: Update clang-format version to 17.0.3 2024-03-11 15:55:30 -04:00
CI CI: Delete legacy build and formatting check scripts 2023-07-17 20:10:12 +02:00
cmake cmake: Provide a clear error on version check fail 2024-04-04 15:13:43 -04:00
deps deps/media-playback: Detect+handle video res changes with hwaccel 2024-03-19 16:58:20 -07:00
docs/sphinx docs: Document the audio_active functions and signals 2024-03-27 16:29:20 -04:00
libobs libobs: Update version to 30.1.1 2024-03-21 17:58:44 -04:00
libobs-d3d11 libobs-d3d11: Use OS D3DCompiler_47.dll in legacy CMake 2024-04-03 14:44:39 -04:00
libobs-opengl libobs-opengl: Specify display attributes 2024-02-03 17:23:01 -06:00
libobs-winrt cmake: Add changes for CMake build framework 3.0 2023-06-29 10:11:32 -04:00
plugins win-wasapi: Fix legacy CMake 2024-04-03 14:44:39 -04:00
test test: Update CMake target source lists with alphabetic sorting 2023-12-19 17:59:44 -05:00
UI UI: Use spacers instead of widgets in macOS Permissions UI 2024-04-04 14:42:19 -04:00
.cirrus.yml CI: Bump FreeBSD version to supported release: 13.2 2023-08-18 13:14:58 -04:00
.clang-format Update .clang-format rules for ObjC files for version 16 2023-08-10 17:12:30 -04:00
.cmake-format.json cmake: Add changes for CMake build framework 3.0 2023-03-26 18:20:38 -04:00
.editorconfig .editorconfig: Add win-capture json 2023-10-09 14:50:05 -04:00
.git-blame-ignore-revs .git-blame-ignore-revs: Add clang-format 17 update 2024-03-11 16:27:44 -04:00
.gitattributes CI: Add Crowdin Synchronization 2021-11-25 20:59:11 +11:00
.gitignore test: Update CMake target source lists with alphabetic sorting 2023-12-19 17:59:44 -05:00
.gitmodules cmake,plugins,build-aux: Remove enc-amf 2023-07-22 18:06:26 -07:00
.mailmap Update copyrights/names 2023-05-20 01:31:18 -07:00
.swift-format cmake: Add Xcode component to CMake build framework 3.0 2023-03-26 18:20:38 -04:00
AUTHORS Update translations from Crowdin 2024-03-12 18:11:06 +00:00
buildspec.json CI: Update deps to 2024-03-19 release 2024-03-20 17:31:15 -04:00
CMakeLists.txt cmake: Update CMake minimum to 3.22 2023-08-05 16:45:46 -07:00
CMakePresets.json cmake: Remove Qt version selection and Qt 5 support 2023-07-19 11:56:54 -04:00
COC.rst Revert "docs: Rename Code of Conduct to fix GitHub detection" 2021-08-07 20:40:29 +10:00
COMMITMENT Add GPL Cooperation Commitment to base directory 2019-01-24 02:02:49 -05:00
CONTRIBUTING.rst CONTRIBUTING.rst: Mention formatting scripts 2023-12-16 18:10:51 -06:00
COPYING COPYING: Use license file from gnu.org 2021-10-24 00:35:27 -07:00
INSTALL Update INSTALL 2018-07-14 08:21:00 +01:00
README.rst README.rst: Fix GitHub Actions status badge target link 2023-07-18 11:38:17 -04:00

OBS Studio <https://obsproject.com>
===================================

.. image:: https://github.com/obsproject/obs-studio/actions/workflows/push.yaml/badge.svg?branch=master
   :alt: OBS Studio Build Status - GitHub Actions
   :target: https://github.com/obsproject/obs-studio/actions/workflows/push.yaml?query=branch%3Amaster

.. image:: https://badges.crowdin.net/obs-studio/localized.svg
   :alt: OBS Studio Translation Project Progress
   :target: https://crowdin.com/project/obs-studio

.. image:: https://img.shields.io/discord/348973006581923840.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2
   :alt: OBS Studio Discord Server
   :target: https://obsproject.com/discord

What is OBS Studio?
-------------------

OBS Studio is software designed for capturing, compositing, encoding,
recording, and streaming video content, efficiently.

It's distributed under the GNU General Public License v2 (or any later
version) - see the accompanying COPYING file for more details.

Quick Links
-----------

- Website: https://obsproject.com

- Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki

- Forums: https://obsproject.com/forum/

- Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions

- Developer/API Documentation: https://obsproject.com/docs

- Donating/backing/sponsoring: https://obsproject.com/contribute

- Bug Tracker: https://github.com/obsproject/obs-studio/issues

Contributing
------------

- If you would like to help fund or sponsor the project, you can do so
  via `Patreon <https://www.patreon.com/obsproject>`_, `OpenCollective
  <https://opencollective.com/obsproject>`_, or `PayPal
  <https://www.paypal.me/obsproject>`_.  See our `contribute page
  <https://obsproject.com/contribute>`_ for more information.

- If you wish to contribute code to the project, please make sure to
  read the coding and commit guidelines:
  https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst

- Developer/API documentation can be found here:
  https://obsproject.com/docs

- If you wish to contribute translations, do not submit pull requests.
  Instead, please use Crowdin.  For more information read this page:
  https://obsproject.com/wiki/How-To-Contribute-Translations-For-OBS

- Other ways to contribute are by helping people out with support on
  our forums or in our community chat.  Please limit support to topics
  you fully understand -- bad advice is worse than no advice.  When it
  comes to something that you don't fully know or understand, please
  defer to the official help or official channels.