mirror of
https://github.com/Xaymar/obs-StreamFX
synced 2024-11-27 22:03:01 +00:00
project: Update README
This commit is contained in:
Michael Fabian 'Xaymar' Dirks
parent
a56cbf89a9
commit
b4a7ffceac
1 changed files with 17 additions and 46 deletions
63
README.md
63
README.md
|
|
@ -1,54 +1,25 @@
|
||||||
# OBS Stream Effects
|
|
||||||
Bring your stream to life with more modern effects! Stream Effects adds several much needed features to OBS Studio, such as real time Blur and 3D Transform. Now you can blur out sources you think may be questionable, add sick 3D effects or recreate the Heroes of the Storm displacement overlay with the Displacement filter.
|
Bring your stream to life with more modern effects! Stream Effects adds several much needed features to OBS Studio, such as real time Blur and 3D Transform. Now you can blur out sources you think may be questionable, add sick 3D effects or recreate the Heroes of the Storm displacement overlay with the Displacement filter. The choice is yours, the possibilities are endless.
|
||||||
|
|
||||||
## Support The Project
|
#### Status: [Windows: ](https://ci.appveyor.com/project/Xaymar/obs-stream-effects) | [Linux, Mac: ](https://travis-ci.org/Xaymar/obs-stream-effects) | [Translations: ](https://crowdin.com/project/obs-stream-effects)
|
||||||
The project is supported through [my Patreon](https://www.patreon.com/Xaymar), [Twitch Channel](https://www.twitch.tv/xaymar/) and [YouTube Channel](https://www.youtube.com/c/Xaymar). Any funds made through those means go towards improving this and other similar Projects. Support the project today and get early access to future releases!
|
|
||||||
|
|
||||||
## Features
|
# Features
|
||||||
### Filters
|
## Source Mirror (Source)
|
||||||
- 3D Transform
|
Source Mirror duplicates the video and optionally also the audio of any source, allowing you to apply filters to either without affecting the original source. It also can rescale the video to fit your target region using any of the obs supported scaling modes. There is no limit on the number of Source Mirrors you create for one source, so go wild!
|
||||||
- Blur
|
|
||||||
- Displacement
|
|
||||||
- Custom Shader
|
|
||||||
|
|
||||||
### Transitions
|
## Blur (Filter)
|
||||||
- Custom Shader
|
Blur out any unwanted content with this simple trick! This Filter allows you to apply various kinds of blur to any Source, even directional blur (often called motion blur)!
|
||||||
|
|
||||||
### Sources
|
### Warning: Blurring is a non-destructive process, the source image can be restored to some degree. Do not use this to hide sensitive information, like clear-text passwords, bank information or credit card information. You have been warned.
|
||||||
- Source Mirror (Alternative to Scenes, with Audio Mirroring)
|
|
||||||
- Custom Shader
|
|
||||||
|
|
||||||
## Build Status
|
## 3D Transform (Filter)
|
||||||
| Windows | Linux & Mac |
|
A popular request for OBS Studio is now available as a filter for you to use, move, rotate, scale and shear your Source in 3D space at will! Create reflections of your video camera on a floor, table, or place your video camera in a room - the possibilities are endless and you can choose what you want to do! It can even generate mipmaps for the transformed source to reduce aliasing on sharp angles or squished sources, to further improve quality.
|
||||||
|---------|-------------|
|
|
||||||
| [](https://ci.appveyor.com/project/Xaymar/obs-stream-effects) | [](https://travis-ci.org/Xaymar/obs-stream-effects) |
|
|
||||||
|
|
||||||
# Building the Project
|
## Inner/Outer Shadow (SDF) (Filter)
|
||||||
Building the project is fairly easy and relies on CMake to ease the process.
|
Add a shadow to any Source you wish to have a shadow for, optionally even a shadow in! Doesn't matter what kind of Source, just add this Filter and you're ready to have a Drop Shadow or an Inset Shadow, or even both!
|
||||||
|
|
||||||
## Prerequisites
|
## Displacement Mapping (Filter)
|
||||||
- Visual Studio 2013, 2015 or 2017
|
Displace the pixels of the Source, in any way you want - create a whirl, zoom in, whatever your input normal map can do will happen with this Filter.
|
||||||
- CMake
|
|
||||||
- A built version of obs-studio
|
|
||||||
|
|
||||||
## Configuration
|
# Support The Project
|
||||||
The project supports both command line and GUI versions of cmake, these are the parameters than can be configured:
|
The project is supported through [Patreon](https://www.patreon.com/Xaymar). Get early access and influence future decisions by supporting this (and other) Projects on Patreon!
|
||||||
|
|
||||||
- PATH_OBSStudio: Path to the root of a completely built obs-studio version.
|
|
||||||
- INSTALL_DIR: Where the INSTALL target installs files to.
|
|
||||||
- PACKAGE_PREFIX: The prefix for the PACKAGE_* generated files.
|
|
||||||
- PACKAGE_SUFFIX: The suffix for the PACKAGE_* generated files, defaults to the version number.
|
|
||||||
|
|
||||||
## Building
|
|
||||||
Building is simply handled by CMake. If you generated an IDE project, just use the IDE provided options for building.
|
|
||||||
|
|
||||||
## Installing
|
|
||||||
You can directly install files into an existing obs-studio installation or put them in a separate directory for later packaging and releasing. Simply point INSTALL_DIR to the directory where you want the files to be installed to and then run the INSTALL target (which will also build the project if it hasn't been built yet).
|
|
||||||
|
|
||||||
## Packaging
|
|
||||||
Packaging has two options, 7zip and zip. Simply run the targets PACKAGE_ZIP and/or PACKAGE_7ZIP and you will have a build that you can distribute.
|
|
||||||
|
|
||||||
# Continuous Integration
|
|
||||||
To ease detection of bad commits and PRs, CI support has been added to the project. Currently the following CI providers are supported:
|
|
||||||
|
|
||||||
- AppVeyor (for Windows on any support Visual Studio version)
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue