Skip to content

Testing the installation

Adding a first plugin

First, you need to configure your GitHub environment (more information in development prerequisites).
If you don't have a GitHub account, Create a GitHub account now.

Warning

A.V.A.T.A.R is a reserved profile name. Never use this name to name your profile.

Creating an access token

Personal access tokens (classic) function like ordinary OAuth access tokens. They can be used instead of a password for Git over HTTPS, or can be used to authenticate to the API over Basic Authentication.

In your Github environment:

  1. In the top right-hand corner, open the contextual menu and go to Settings.
  2. Then, at the bottom of the left-hand menu, click on Developer settings.
  3. Then click on Personal access tokens then Tokens (classic).
  4. In the top right-hand corner, click on the Generate new token button and Generate new token (classic).
  5. Enter a name for the token in the note field.
  6. Enter No expiration in the Expiration list.

  7. in the repo tab, select repo:status and public_repo in the scopes.

  8. Then click on Generate token button.

  9. Copy and save your personal access token (It will be used to connect to the Plugin librairy).

Downloading the worldTime plugin

To download the plugin, we'll use the Plugin librairy.

Remember

Always wait until the client is fully initialized before clicking on its name to open its context menu.
Wait until you see the Ready to listen! message in the console.

  1. In the A.V.A.T.A.R menu, click on Edition -> Plugin librairy:

  2. Enter your Github login and your personal access token.

  3. Click on the Remember me toggle if you no longer wish to enter your login details.

    Note

    If possible regarding the operating system, your personal access token will save in the application as an encrypted string.
    These functions add extra protection to data stored on disk, using the cryptography provided by the operating system. See more information in the API

  4. Click on the Sign in button.

  5. Plugin librairy searches for plugins from all contributors.

  6. In the Plugin librairy window, drag slides to bring up the worldTime plugin:

  7. Click on the Install button.

  8. Restart A.V.A.T.A.R.

The worldTime plugin is installed !

Tip

Use Plugin studio to configure the two plugin parameters default.zone and default.speech of the worldTime plugin.
Once you have modified these settings, right-click on the plugin properties and click on save.
Restart A.V.A.T.A.R.

Ready to test

You are now ready to test the installation.

  1. Start the server.
  2. Start a client.

  3. You can now speak the voice rule (of course, in the langage defined in the client properties, the example below is in English for the documentation):

    • Sarah, what time is it?
Tip

Don't forget the trigger keyword you've set (default Sarah or Jarvis)

  1. If everything has been done correctly, A.V.A.T.A.R will tell you what time it is.



Introduction