Go to file
PatTheMav 6d5dd75e4a CI: Update editorconfig to match CMake-format configuration 2022-03-18 05:46:21 -07:00
.github CI: Add 'flatpak' to Flatpak bundle name 2022-03-18 07:45:19 -03:00
CI CI: Fix CMake definition of streaming service options 2022-03-17 23:21:02 +01:00
UI UI: Update CMakeLists.txt for main OBS app 2022-03-16 23:11:58 +01:00
additional_install_files Improve additional_install_files for debug/release 2014-07-18 22:41:11 -07:00
cmake CI: Add necessary build system changes for universal and M1 builds 2022-03-16 23:23:40 +01:00
deps obs-scripting: Update CMakeLists.txt for scripting modules 2022-03-16 23:11:08 +01:00
docs/sphinx obs-frontend-api: Add function to get frontend translated string 2022-03-10 06:27:18 -08:00
libobs libobs: Update CMakeLists.txt for libobs and associated libraries 2022-03-16 23:11:08 +01:00
libobs-d3d11 libobs: Update CMakeLists.txt for libobs and associated libraries 2022-03-16 23:11:08 +01:00
libobs-opengl libobs: Update CMakeLists.txt for libobs and associated libraries 2022-03-16 23:11:08 +01:00
libobs-winrt libobs: Update CMakeLists.txt for libobs and associated libraries 2022-03-16 23:11:08 +01:00
plugins obs-vst: Update submodule to pull in CMake changes 2022-03-17 14:28:59 +01:00
test CI: Update build scripts and Github actions workflow 2022-03-16 23:13:26 +01:00
.cirrus.yml CI: Fix swig dependency on FreeBSD 2020-10-03 05:38:46 -07:00
.clang-format Apply clang-format to objective c code 2019-07-09 13:39:13 -05:00
.cmake-format.json CI: Update build scripts and Github actions workflow 2022-03-16 23:13:26 +01:00
.editorconfig CI: Update editorconfig to match CMake-format configuration 2022-03-18 05:46:21 -07:00
.git-blame-ignore-revs .git-blame-ignore-revs: Add file to handle mass reformatting 2019-06-27 01:09:31 +09:00
.gitattributes CI: Add Crowdin Synchronization 2021-11-25 20:59:11 +11:00
.gitignore CI: Update build scripts and Github actions workflow 2022-03-16 23:13:26 +01:00
.gitmodules enc-amf: Update to 2.5.0.1 and update repository address 2018-09-28 10:54:19 +02:00
.mailmap .mailmap: Disambiguate many more authors 2021-01-11 17:45:01 -08:00
AUTHORS Update translations from Crowdin 2022-02-11 00:34:08 +00:00
CMakeLists.txt CI: Update build scripts and Github actions workflow 2022-03-16 23:13:26 +01: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: Add service submission guidelines (#5562) 2021-11-22 08:29:39 -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 docs: Remove block quotes (#4621) 2021-05-01 19:46:54 -05:00

README.rst

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

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

.. image:: https://d322cqt584bo4o.cloudfront.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 thread:
  https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/

- 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.