-
Notifications
You must be signed in to change notification settings - Fork 146
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
382c39e
commit 02813a9
Showing
1 changed file
with
42 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,8 +5,12 @@ Unreal Engine 4 Media Framework plug-in using the Video LAN Codec (libvlc). | |
|
||
## About | ||
|
||
This plug-in is still under development and likely has a lot of remaining issues to be fixed. Use in production is not yet recommended. Make sure to pull the *Tag* that matches your Unreal Engine version. If you sync to *Master* the code may not | ||
compile, because it may depend on Engine changes that are not yet available in the UE4 Master branch. | ||
This plug-in is still under development and likely has a lot of remaining issues | ||
to be fixed. Use in production is not yet recommended. | ||
|
||
Make sure to pull the *Tag* that matches your Unreal Engine version. If you sync | ||
to *Master* the code may not compile, because it may depend on Engine changes | ||
that are not yet available in the UE4 Master branch. | ||
|
||
|
||
## Supported Platforms | ||
|
@@ -18,16 +22,27 @@ against the following platforms: | |
- ~~Mac~~ | ||
- Windows | ||
|
||
**IMPORTANT**: Please note that this repository contains pre-compiled binaries for libvlc and its plug-ins, which are licensed under LGPL. This means that you cannot create monolithic builds of your game without violating LGPL, the UE4 EULA or both. The libvlc libraries must remain dynamic libraries that are bound at run-time - static linking is not allowed - and the licensing related files in */ThirdParty/vlc* must be retained. | ||
**IMPORTANT**: Please note that this repository contains pre-compiled binaries | ||
for libvlc and its plug-ins, which are licensed under LGPL. This means that you | ||
cannot create monolithic builds of your game without violating LGPL, the UE4 | ||
EULA or both. The libvlc libraries must remain dynamic libraries that are bound | ||
at run-time - static linking is not allowed - and the licensing related files in | ||
*/ThirdParty/vlc* must be retained. | ||
|
||
This also means that this plug-in cannot work on platforms that do not support dynamically linked libraries (i.e. iOS, HTML5) or do not currently implement support for it (i.e. Android, XboxOne). | ||
This also means that this plug-in cannot work on platforms that do not support | ||
dynamically linked libraries (i.e. iOS, HTML5) or do not currently implement | ||
support for it (i.e. Android, XboxOne). | ||
|
||
Epic is in the process of adding plug-in support to monolithic builds, but there is no ETA yet. Once this is supported, you will be able to distribute monolithic game and server builds with VlcMedia, provided that the libvlc libraries and plug-ins remain as separate DLLs. | ||
Epic is in the process of adding plug-in support to monolithic builds, but there | ||
is no ETA yet. Once this is supported, you will be able to distribute monolithic | ||
game and server builds with VlcMedia, provided that the libvlc libraries and | ||
plug-ins remain as separate DLLs. | ||
|
||
|
||
## Prerequisites | ||
|
||
A relatively recent version of libvlc is required. The latest stable release (currently 2.2.1) is not sufficient. | ||
A relatively recent version of libvlc is required. The latest stable release | ||
(currently 2.2.1) is not sufficient. | ||
|
||
For Mac and Windows, the following nightly builds are currently included: | ||
* Mac: vlc-3.0.0-x86_64-20160113-0109 | ||
|
@@ -38,21 +53,37 @@ Nightly builds can be downloaded from the VideoLAN web site (see below). | |
|
||
### Linux | ||
|
||
A suitable version of **libvlc** must be installed or compiled from source. If you ship your game on Linux, you will likely want to include libvlc with it, so that users don't have to install it themselves. We will eventually include those binaries in this repository, although it is not clear what distros should be supported and where the builds are coming from. A better workflow needs to be established for this. | ||
A suitable version of **libvlc** must be installed or compiled from source. If | ||
you ship your game on Linux, you will likely want to include libvlc with it, so | ||
that users don't have to install it themselves. We will eventually include those | ||
binaries in this repository, although it is not clear what distros should be | ||
supported and where the builds are coming from. A better workflow needs to be | ||
established for this. | ||
|
||
### Mac, Windows | ||
|
||
All required libraries and plug-ins are included in the *ThirdParty* directory and work out of the box. | ||
All required libraries and plug-ins are included in the *ThirdParty* directory | ||
and work out of the box. | ||
|
||
|
||
## Dependencies | ||
|
||
This plug-in requires Unreal Engine 4 source code from the Master branch. | ||
This plug-in requires Visual Studio and either a C++ code project or the full | ||
Unreal Engine 4 source code from GitHub. If you are new to programming in UE4, | ||
please see the official [Programming Guide](https://docs.unrealengine.com/latest/INT/Programming/index.html)! | ||
|
||
|
||
## Usage | ||
|
||
Clone this repository into your game's */Engine/Plugins/Media* directory and compile your game. | ||
You can use this plug-in as a project plug-in, or an Engine plug-in. | ||
|
||
If you use it as a project plug-in, clone this repository into your project's | ||
*/Plugins* directory and compile your game in Visual Studio. A C++ code project | ||
is required for this to work. | ||
|
||
If you use it as an Engine plug-in, clone this repository into the | ||
*/Engine/Plugins/Media* directory and compile your game. Full Unreal Engine 4 | ||
source code from GitHub is required for this. | ||
|
||
|
||
## Support | ||
|
@@ -66,3 +97,4 @@ or email us at [email protected] | |
|
||
* [VideoLAN Homepage](http://videolan.org) | ||
* [VideoLAN Nightly Builds](http://nightlies.videolan.org/) | ||
* [Introduction to UE4 Plugins](https://wiki.unrealengine.com/An_Introduction_to_UE4_Plugins) |