Game integration guide¶
This section will cover on how to integrate a game with our SDK and API and use it properly with the current flow. It will be a step by step guide with some steps considered as optional. Several links toward other sections of the documentation will be made available for further explanation of specific section.
- Integrate the Genvid SDK into your game
- Integrate the Web Genvid SDK into your own website for the game
- Create your Genvid Project Configuration
Integrate the Native Genvid SDK into your game¶
First, you need to integrate the Native Genvid SDK into your game project. You can follow the steps indicated in the Engine Integration section and you can also observe our samples for each supported Engine:
Integrate the Web Genvid SDK into your own website for the game¶
Second, you need to create a website with Web Genvid SDK to display your video stream from your game, display the informations from the game and develop the interactions you want from the viewers to the game. You can follow the steps indicated in the Website Integration section and you can also observe our samples for each supported Engine:
If you are confused about the website content, the Unity Sample Website Integration section contains more details for each section of our sample website.
Create your Genvid Project Configuration¶
This section will cover the steps to link your website and game together with configuration files and python script. Some steps will be indicated as optional since you are not forced to use this system to run your game into our system.
The page Genvid Project Configuration Overview cover
most of the information needed to configure your project. The page
is giving more information on the genvid.hcl
project file needed
and the stream.hcl
configuration file.
The page Nomad Templates cover the information needed to create a nomad template to use for your game.
Feel free to modify the run.py
script file available in all the sample
projects to your need for your project. Run.py
is used to instruct which
files to copy to perform a proper build later on when calling the
py local.py run-script build
command. This is an optional step as you can
manage the build process of your game project the way you prefer.