2017-06-29 19:01:10 +00:00
|
|
|
OBS Studio <https://obsproject.com>
|
|
|
|
|
===================================
|
|
|
|
|
|
2019-07-27 12:47:10 +00:00
|
|
|
.. image:: https://travis-ci.org/obsproject/obs-studio.svg?branch=master
|
|
|
|
|
:alt: OBS Studio Build Status - Travis CI
|
|
|
|
|
:target: https://travis-ci.org/obsproject/obs-studio
|
|
|
|
|
|
|
|
|
|
.. image:: https://ci.appveyor.com/api/projects/status/github/obsproject/obs-studio?branch=master&svg=true
|
|
|
|
|
:alt: OBS Studio Build Status - AppVeyor CI
|
|
|
|
|
:target: https://ci.appveyor.com/project/jp9000/obs-studio/branch/master
|
|
|
|
|
|
|
|
|
|
.. image:: https://dev.azure.com/obsjim/obsjim/_apis/build/status/obsproject.obs-studio?branchName=master
|
|
|
|
|
:alt: OBS Studio Build Status - Azure Pipelines
|
|
|
|
|
:target: https://dev.azure.com/obsjim/obsjim/_build/latest?definitionId=1&branchName=master
|
|
|
|
|
|
|
|
|
|
.. image:: https://discordapp.com/api/guilds/348973006581923840/widget.png?style=shield
|
|
|
|
|
:alt: OBS Studio Discord Server
|
|
|
|
|
:target: https://obsproject.com/discord
|
|
|
|
|
|
2017-06-29 19:01:10 +00:00
|
|
|
What is OBS Studio?
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
OBS Studio is software designed for capturing, compositing, encoding,
|
|
|
|
|
recording, and streaming video content, efficiently.
|
|
|
|
|
|
2019-07-27 12:47:10 +00:00
|
|
|
It's distributed under the GNU General Public License v2 (or any later
|
|
|
|
|
version) - see the accompanying COPYING file for more details.
|
2017-06-29 19:01:10 +00:00
|
|
|
|
|
|
|
|
Quick Links
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
- Website: https://obsproject.com
|
|
|
|
|
|
2018-05-29 19:13:02 +00:00
|
|
|
- Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki
|
2017-06-29 19:01:10 +00:00
|
|
|
|
|
|
|
|
- Forums: https://obsproject.com/forum/
|
|
|
|
|
|
2018-05-29 19:13:02 +00:00
|
|
|
- Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions
|
2017-06-29 19:01:10 +00:00
|
|
|
|
2018-02-19 19:54:37 +00:00
|
|
|
- Developer/API Documentation: https://obsproject.com/docs
|
|
|
|
|
|
2019-07-27 12:47:10 +00:00
|
|
|
- Donating/backing/sponsoring: https://obsproject.com/contribute
|
|
|
|
|
|
2017-06-29 19:01:10 +00:00
|
|
|
- Bug Tracker: https://obsproject.com/mantis/
|
|
|
|
|
|
|
|
|
|
(Note: The bug tracker is linked to forum accounts. To use the bug
|
|
|
|
|
tracker, log in to a forum account)
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
------------
|
|
|
|
|
|
2019-07-27 12:47:10 +00:00
|
|
|
- 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.
|
|
|
|
|
|
2018-02-19 19:54:37 +00:00
|
|
|
- If you wish to contribute code to the project, please make sure to
|
|
|
|
|
read the coding and commit guidelines:
|
2018-05-29 19:13:02 +00:00
|
|
|
https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
|
2017-06-29 19:01:10 +00:00
|
|
|
|
2018-02-19 19:54:37 +00:00
|
|
|
- Developer/API documentation can be found here:
|
|
|
|
|
https://obsproject.com/docs
|
|
|
|
|
|
2017-06-29 19:01:10 +00:00
|
|
|
- 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
|
2018-02-19 19:54:37 +00:00
|
|
|
defer to the official help or official channels.
|
