Commit 1b5faf03 authored by Martin Finkel's avatar Martin Finkel

Docs: Mention libvlcsharp docs more explicitly

parent bff201aa
Welcome to VLC for Unity on Windows!
## Docs reference
See the [LibVLCSharp documentation](https://code.videolan.org/videolan/LibVLCSharp/tree/master/docs).
It includes [best practices](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/best_practices.md), [Q&A guide](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/how_do_I_do_X.md), [libvlc specific information](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/libvlc_documentation.md) and [tutorials](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/tutorials.md).
## Components included
For reference, you need to a bunch of components to get this working:
- libvlc.dll, libvlccore.dll (and its plugins in /libs folder): These are nightly build DLLs of the VLC player libraries https://code.videolan.org/videolan/vlc
......@@ -8,12 +15,14 @@ For reference, you need to a bunch of components to get this working:
This is all included in this package and it all works automatically for you.
LibVLCSharp docs (not Unity specific) https://code.videolan.org/videolan/LibVLCSharp/blob/3.x/docs/getting_started.md
LibVLCSharp docs (not Unity specific) https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/getting_started.md
!! You need to set your Unity target platform to "PC, Mac & Linux Standalone" to target Windows classic. Go for the x86_64 architecture.
The scene from Assets/VLC-Unity-Windows/Scripts/main.unity provides a way to get started quickly.
## Sample script
Regarding the integration code that you need, you will find it in UseRenderingPlugin.cs.
First, you need to load the native libraries:
......
......@@ -64,7 +64,9 @@ Since this Unity plugin largely shares the same API than LibVLCSharp, most LibVL
## Documentation
See the [LibVLCSharp documentation](https://code.videolan.org/videolan/LibVLCSharp/tree/3.x/docs)
See the [LibVLCSharp documentation](https://code.videolan.org/videolan/LibVLCSharp/tree/master/docs).
It includes [best practices](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/best_practices.md), [Q&A guide](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/how_do_I_do_X.md), [libvlc specific information](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/libvlc_documentation.md) and [tutorials](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/tutorials.md).
## Support
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment