|
1 |
| -# OBS Plugin Template |
| 1 | +<div align="center"> |
2 | 2 |
|
3 |
| -## RICHARD- HEADER STUFF HERE |
| 3 | +[](https://www.elgato.com/uk/en/s/marketplace-connect-for-obs) |
4 | 4 |
|
5 |
| -## Build Instructions |
6 |
| -Currently the Elgato Marketplace Connect plugin can only be built on Windows. The plugin uses the OBS plugin template build system, and more detailed build instructions can be found on the [template project's wiki](https://github.com/obsproject/obs-plugintemplate/wiki). |
| 5 | +# Marketplace Connect for OBS |
7 | 6 |
|
8 |
| -### Build system requirements |
9 |
| -Two sets of development tools are required. Ensure both are installed prior to configuring and building the plugin: |
| 7 | +[](https://elgato.com) |
| 8 | +[](https://discord.gg/GehBUcu627) |
10 | 9 |
|
11 |
| -* Visual Studio 17 2022 |
12 |
| -* CMake 3.30.5 |
| 10 | +</div> |
13 | 11 |
|
14 |
| -### Building the project |
15 |
| -After making sure the required development tools are installed, building the plugin should be a straightforawrd process. |
| 12 | +Add and share OBS setups in just a few clicks — with the Marketplace Connect plugin, anyone can stream and produce like a pro. It powers up your OBS workflows, so you can get right to the good stuff. |
16 | 13 |
|
17 |
| -1. Configuration: in a terminal window, navigate to the root plugin folder, and configure the project files with: `cmake --preset windows-x64`. This will download any build dependencies and set up a Visual Studio project file in a new project directory called `build_x64`. |
18 |
| -2. Inside the new `build_x64` directory added to the projects root, you will find a `elgato-marketplace-connect.sln` file. Open this file in Visual Studio to edit and build the project. |
19 |
| -3. Alternatively, cmake can build the project directly with the command: `cmake --build --preset windows-x64`. |
| 14 | +## System Requirements |
20 | 15 |
|
21 |
| -If you wish to debug the plugin within a running OBS, the (Project Wiki)[https://github.com/obsproject/obs-plugintemplate/wiki/How-To-Debug-Your-Plugin#debugging-plugins-with-visual-studio] has some great instructions. We recommend using the second variant (Adding the plugin to an OBS Studio Project), and when doing so, you will need to add the plugin project, plugin-support project, and the elgato-marketplace-connect-loader project to the solution explorer (step 2 in the instructions there). |
| 16 | +To build the plugin locally, you will need the following installed. |
| 17 | + |
| 18 | +- Windows 10, or higher |
| 19 | +- Visual Studio 17 2022 |
| 20 | +- CMake 3.30.5 |
| 21 | + |
| 22 | +Please note, Marketplace Connect for OBS is currently only available on Windows. |
| 23 | + |
| 24 | +> [!NOTE] |
| 25 | +> The plugin uses the OBS plugin template. For more information, please refer to the [OBS Project's wiki](https://github.com/obsproject/obs-plugintemplate/wiki). |
| 26 | +
|
| 27 | +## Building |
| 28 | + |
| 29 | +Once all system requirements are installed, follow these steps to build the project and get started with developing. |
| 30 | + |
| 31 | +1. In the project's root folder, run `cmake --preset windows-x64` — this will download the build dependencies and set up a Visual Studio project file in the `build_x64` directory. |
| 32 | +2. Open `build_x64/elgato-marketpalce-connect.sln` within Visual Studio to edit and build the project. |
| 33 | + |
| 34 | +Alternatively, `cmake` can build the project directly with the command `cmake --build --preset windows-x64`. |
| 35 | + |
| 36 | +## Further Reading |
| 37 | + |
| 38 | +- Learn more about the template this project is build on in the [OBS Plugin Template Wiki](https://github.com/obsproject/obs-plugintemplate/wiki). |
| 39 | +- Read about [debugging the project within OBS](https://github.com/obsproject/obs-plugintemplate/wiki/How-To-Debug-Your-Plugin#variant-2-add-plugin-to-obs-studio-project). |
| 40 | + |
| 41 | +> [!TIP] |
| 42 | +> When debugging with [Variant 2: Add Plugin To OBS Studio Project](https://github.com/obsproject/obs-plugintemplate/wiki/How-To-Debug-Your-Plugin#variant-2-add-plugin-to-obs-studio-project), you will need to add the `plugin`, `plugin-support`, and `elgato-marketplace-connect-loader` projects to the solution. |
| 43 | +
|
| 44 | +## Licence |
| 45 | + |
| 46 | +This project is licenced under [GPL-2.0](./LICENSE), and conforms with the requirements outlined by the OBS Project. |
0 commit comments