Skip to content

Installation

Fernando Carrascosa edited this page May 10, 2021 · 2 revisions

Installation

Here's a short guide to get you up and running in a quick way.

Table of contents

Prerequisites

In order to use this script you need to do a few things first.

  1. Create an account in the FACEIT Developer Portal.
  2. Create an app in the FACEIT App Studio.
  3. Get a Client API key for the app you created.

Create an account in the FACEIT Developer

Go to the FACEIT Developer Portal and login with your FACEIT credentials.

FACEIT Developer Portal Screenshot

Create an app in the FACEIT App Studio

Once you have created a developer account and logged in to the FACEIT Developer Portal, go to the FACEIT App Studio to create your app.

FACEIT Developer Portal Screenshot

Click on the Create New App button and you will be prompted with a form. You only need to fill in the App name and App description fields, but you can fill the other ones if you want to.

After that you will be redirected to your app details.

FACEIT Developer Portal Screenshot

Get a Client API key for the app you created

Once you have created your app and you are in the details page for it, you will see a nav menu on top of the main content. Click on API KEYS

FACEIT Developer Portal Screenshot

Once in that page you'll see an overview of your API Keys (should be empty if you just created your APP). Click on the + icon below Create FACEIT API Keys text.

FACEIT Developer Portal Screenshot

You will be prompted with a form asking you which type of API Key you want to create. Select Client side and click CREATE.

FACEIT Developer Portal Screenshot

You will be redirected again to your API Keys overview. Refresh the page and you will see your API Key.

FACEIT Developer Portal Screenshot

Download and Install

Download

Download the last version of this script either from the Streamlabs Chatbot Discord scripts channel or from the releases page of this repo.

FACEIT Developer Portal Screenshot

Installation

There are two ways you can install this script. In both we assume you already configured the Scripts Tab in your chatbot.

From Streamlabs Chatbot

  • Open Streamlabs Chatbot.
  • Go to the Scripts Tab.
  • Click on the import button.

FACEIT Developer Portal Screenshot

  • Select the zip file you just downloaded.

Copying the Files

  • Open an explorer window.
  • Navigate to C:/Users/$YOURUSER/AppData/Roaming/Streamlabs/Services/Scripts.
  • Uncompress the zip file you just downloaded into that folder.
  • In Streamlabs Chatbot's Script tab click on "Reload Scripts" button.

First Steps

Now that you have the script installed, in Streamlabs Chatbot's Scripts tab click on "Faceit Integration" and the settings for this script should display to the right side of your screen.

You'll see two empty fields asking for your FACEIT API Key and your FACEIT nickname. These two fields are mandatory, fill them.

FACEIT Developer Portal Screenshot

At the bottom you'll see the "Save Settings" button. Click it. After that you are ready to go. You can also click again on the "Reload Scripts" button.

FACEIT Developer Portal Screenshot

You are ready to go.

Clone this wiki locally