mirror of https://github.com/Xaymar/obs-StreamFX
project: Update README.md and CONTRIBUTING.md
This commit is contained in:
Michael Fabian 'Xaymar' Dirks
parent
1285e7efd3
commit
59e26c1ee9
|
|
@ -1,34 +1,3 @@
|
|||
# Build Instructions
|
||||
The project is compatible with being included directly in an obs-studio build, but can be built standalone. Depending on which you chose, the instructions differ greatly.
|
||||
|
||||
## Building with OBS Studio
|
||||
1. Prepare OBS Studio for building on your platform.
|
||||
2. Navigate to <obs-studio-clone>/plugins in a git-enabled shell.
|
||||
3. Run `git submodule add https://github.com/Xaymar/obs-stream-effects.git obs-stream-effects` and wait for it to complete.
|
||||
4. Edit the CMakeLists.txt in the same directory and append `add_subdirectory(obs-stream-effects)`.
|
||||
5. Use CMake to reconfigure OBS Studio, at which point it should detect the new plugin and allow you to build it.
|
||||
6. Done.
|
||||
|
||||
## Building Standalone
|
||||
This mode of building is used by CI providers and offers the fastest compile time, but does not allow quick testing as it requires a working OBS Studio installation to test.
|
||||
|
||||
1. Install CMake (3.1 or newer) and if you aren't using Windows, build the PACKAGE target in OBS Studio, which will generate a CPack archive in the build folder.
|
||||
2. Clone the obs-stream-effects repository using git or a comparable tool.
|
||||
3. Configure obs-stream-effects using CMake to build a subdirectory or any other location that is not the same as the source directory, and adjust the following options to suit your needs:
|
||||
- OBS_STUDIO_DIR: Path to a normal or CPack OBS Studio build.
|
||||
- OBS_DOWNLOAD_VERSION: The version to attempt to automatically download and use if no OBS Studio is detected (may not work on all platforms).
|
||||
- CMAKE_INSTALL_PREFIX: Path that the INSTALL target copies files to.
|
||||
- CMAKE_PACKAGE_PREFIX: Path for the archives generated by PACKAGE_ZIP and PACKAGE_7Z.
|
||||
- CMAKE_PACKAGE_NAME: Name for the archives generated by PACKAGE_ZIP and PACKAGE_7Z.
|
||||
- CMAKE_PACKAGE_SUFFIX_OVERRIDE:
|
||||
4. Build obs-stream-effects.
|
||||
|
||||
### Installing into a local OBS Studio Installation
|
||||
Modify CMAKE_INSTALL_PREFIX to point at your OBS Studio installation directory (not the data directory) and build the INSTALL target.
|
||||
|
||||
### Packaging Release Archives
|
||||
Generate release archives by building either PACKAGE_ZIP or PACKAGE_7Z. To generate a full release archive, CMAKE_INSTALL_PREFIX has to be set to a directory that only contains release files for this plugin. See the CI scripts for an example on this.
|
||||
|
||||
# Commits
|
||||
Commits should always only focus on a single change that is necessary for that commit to work. For example, a commit that changes how something logs messages should not also include a new blur effect. In those cases, the commit should be split up into two, so that they can be reverted independently from another.
|
||||
|
||||
|
|
|
|||
24
README.md
24
README.md
|
|
@ -1,18 +1,12 @@
|
|||
|
||||
[](https://github.com/Xaymar/obs-StreamFX/actions) [](https://crowdin.com/project/obs-stream-effects)
|
||||
# About StreamFX [](https://github.com/Xaymar/obs-StreamFX/actions) [](https://crowdin.com/project/obs-stream-effects)
|
||||
StreamFX is a plugin to libOBS (OBS Studio, StreamElements OBS Live) that adds new sources, filters and transitions to give you the ability to drastically improve your stream and recording setup past what was possible in OBS Studio until now. Whether it is blurring out a region, moving something in 3D, or just writing your own shaders as a new transition, source or filter - StreamFX has it all.
|
||||
|
||||
# About StreamFX
|
||||
StreamFX is a plugin to libOBS (OBS Studio, OBS.live) which adds many new Sources, Filters and Transitions that enhance and extend the functionality in libOBS.
|
||||
## Support the StreamFX project!
|
||||
Like any other free project, StreamFX relies on donations to be continuously developed and stay free. If StreamFX helped you, consider helping the StreamFX project by making a one time donation via [PayPal](https://www.paypal.me/xaymar), or a continuous donation via [Patreon](https://www.patreon.com/Xaymar) or [Github Sponsors](https://github.com/sponsors/Xaymar)!
|
||||
|
||||
## Features
|
||||
* 3D Transform Filter (Ortho, Perspective, ...)
|
||||
* Blur Filter (Box, Gaussian, ...)
|
||||
* Displacement Mapping Filter
|
||||
* Shader Source, Shader Filter, Shader Transition
|
||||
* & more! Check out the [wiki](https://github.com/Xaymar/obs-StreamFX/wiki) for more information.
|
||||
## Contributing
|
||||
There's two ways you can directly contribute to the project. One is by [submitting translations into your language on Crowdin](https://crowdin.com/project/obs-stream-effects), and the other is [by contributing code to the project](https://github.com/Xaymar/obs-StreamFX/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Helping Out
|
||||
There's always something to translate, so consider [submitting translations into your language on Crowdin](https://crowdin.com/project/obs-stream-effects)! Crowdin allows many contributors to work together on translating a project without requiring any programming knowledge. All you need is an account, and you can start translating!
|
||||
|
||||
## Supporting the project
|
||||
The StreamFX project is funded through [Patreon](https://www.patreon.com/Xaymar), Github Sponsors and [PayPal donations](https://www.paypal.me/xaymar). Note that supporting the project does not grant you any special rights unless otherwise stated.
|
||||
## Further Links
|
||||
* [Wiki](https://github.com/Xaymar/obs-StreamFX/wiki)
|
||||
* [Installation Guide](https://github.com/xaymar/obs-streamfx/wiki/Installation)
|
||||
|
|
|
|||
Loading…
Reference in New Issue