Twitch API Gem - Lumberyard User Guide

Twitch API Gem

The Twitch API Gem is a wrapper for the Twitch RESTful API. Install this Gem into your Lumberyard project to access Twitch features through the Twitch API. This Gem makes it simple to engage broadcasters and leverage existing Twitch functionality for your game.

The Twitch API Gem does not provide a means for fetching information required to authenticate with the Twitch API, such as User ID, Application/Client ID, or Bearer tokens. You must first provide this information to the Gem through EBus calls. Information about the types of Bearer tokens and how they can be acquired are detailed in the Authentication section of the Twitch developer documentation.

For more information on integrating the Twitch API Gem with your Lumberyard project, see Engaging Broadcasters and Viewers on Twitch.

Enable the Twitch API Gem

To enable the Twitch API Gem, do the following:

  1. Use Project Configurator to add the TwitchApi Gem to your project. The TwitchApi Gem requires the following Gem as a dependency:

    • HttpRequestor

  2. Configure your project. Use the following command.

    lmbr_waf configure
  3. Build your project. Use the following command.

    lmbr_waf build_win_x64_vs2019_profile -p all --progress

For more information on Gems, see the Gems system documentation.