The Tutorial Sample

This section walks your through how to set up and run the Tutorial Sample on a local environment. Seeing how it work will help you understand how we integrate the SDK with this application and what you need to do with your own project.


Our Tutorial Sample Application is based on an official D3D11 sample from Microsoft. We integrated Genvid with the sample so you can experience the features available with our SDK.


The tutorial application displays 3 cubes named Athos, Porthos, and Aramis. These cubes rotate and move in different fixed directions. When a cube reaches an edge, it moves to the opposite side of the world to continue its movement without interruption. The player controls one cube at a time using these controls:

  • The arrow and W A S D keys change the trajectory of the selected cube.
    Modifying the direction also affects the rotation of the object.
  • The 1, 2, and 3 keys select different cubes.
  • The numeric keypad keys change the selected cube’s color.
  • The 0 key resets the orientation of the selected cube.
  • The P key resets the position of the selected cube.
  • The Backspace key stops the cube from moving.

Before You Begin

  1. Download and install the latest GenvidSDK.
  2. Install the Genvid Toolbox scripts.
  3. Install the Genvid supervisor services.

Run The Tutorial

  1. Clean and load the project configuration.

    genvid-sdk setup # Make sure the local cluster is created.
    genvid-sdk clean-config # Clean old config in case of existing cluster.
    genvid-sdk load-config-sdk # Configure the basic services for the SDK.
  2. Go to the /samples/tutorial directory.

  3. Copy the Genvid files used to build the project.

    py prepare
  4. Build the project and the website.

    py build
  5. Load the tutorial.

    py load
  6. Launch the Cluster UI.

    genvid-sdk monitor
  7. Click the Jobs tab.

  8. Click START ALL.

    This starts the following jobs:

    • services
    • tutorial application
    • web

    You can also start the services individually.

    The links become active after the job status changes to running.

  9. Click TUTORIAL DEMO in the Links section to launch the tutorial.

  10. When finished, click STOP ALL to stop all the services.

See also