User Guide

Installing OpenAdapt

Experiencing difficulty? Get support on our Discord.

OpenAdapt requires Python3.10, you can download it here or try our installer, which will download Python for you.

Download OpenAdapt

We have builds available for Windows and Mac

IMPORTANT: If you are on MAC, you would need to provide some permissions

  • Download the OpenAdapt application from here

image
  • Extract the zip

image
  • Click on the extracted application

  • It creates an app-tray on top right. This app tray can be used to control the application.

image

Start Recording

Now after the application is installed, you can start recording following the steps explained.

  • Click the record button in the app-tray

  • It opens up a prompt to name your recording

image
  • Give it a name and click ok. Now the recording starts.

Stop Recording

To end the recording you can simply

  • Click the stop recording button in the app-tray and the recording is saved.

image

Replay Recording

To replay the saved recordings

  • Click on replay in the app-tray. It opens list of all the recordings.

image
  • Click on the recording you want to replay. This will open up a prompt to choose the replay strategy & replay instructions

image

Good to know: Read more about strategies here

  • Here is a quick demo of how to use replay strategy & instructions.

Visualize Recording

You can visualize data about your recording events too.

  • Click on visualize in the app-tray

  • Choose the recording you want to visualize

image
  • It opens an HTML page with extensive details about the events in your recordings

image

Delete Recording

If you want to delete any recording from OpenAdapt, you can do it easily.

  • Click on delete button in app-tray

  • A list of available recordings appear

  • Choose the recording to delete

Dashboard

You can now control OpenAdapt from the GUI recently introduced. You can easily see all the recordings, get recording data, change setting such as API keys, choose to scrubb a recording, replays etc

  • Click on dashboard in the app-tray

  • A GUI opens on your browser similar to this

image
  • On settings page you can change API keys, turn on scrub etc

image

Scrubbing

You can now scrub a recording of your choice and it gets processed.

  • In the dashboard settings, turn on scrubbing.

  • Navigate to scrubbing and choose a recording to scrub. Choose the provider

  • Now wait for the recording to be processed

image

Last updated

Revision created

test commit for image size test commit for image size test commit for image size test commit for image size test commit for image size test commit for image size