Sourcetape

About

Sourcetape is a media format for developers to record and playback the process of programming. It combines code editor operations and audio.

You can use sourcetape to create interactive tutorials, messages and documentation that run inside your IDE.

Sourcetape empowers engineers to create up to date, rich interactive documentation. You can use sourcetape to:

• Reduce context switching fatigue
• Record code reviews and share with teammates
• Create learning material
• Document important logic as training material for future team members

Sourcetape comes with a commercial desktop application to provide the following features

• Power search
• Note taking
• Export to workflow diagram (.png)
• Export session to share with colleagues (.zip)
• Export session as animation for sharing

Visit Sourcetape to unlock Desktop License Key

Getting Started With Sourcetape Format in VSCode

Setup

1. Install FFmpeg: brew install ffmpeg. If you are using windows you can either download it from here and add it to your path, or use a tool like chocolatey which will handle that for you.

FFmpeg is how we record and play audio files. You can read more about it here.

2. Get the Sourcetape Format extension from the marketplace

Recording a Sourcetape

You can record a sourcetape through the command palette using the Sourcetape: Record Sourcetape and Sourcetape: Record Sourcetape and Add to Project commands or the the Sourcetape View in the explorer tab.

Sourcetape will then prompt you to name your recording. When you are done, Sourcetape will start recording.

You can finish the recording session through the command palette using the Sourcetape: Save Recording command or by pressing cancel on the recording progress message. You can also use the save icon in the control panel of the Sourcetape View, under the explorer tab.

if your are using the Sourcetape: Record Sourcetape and Add to Project command, sourcetapes will be saved in a .sourcetape folder in your current open workspace. If you use the Sourcetape: Record Sourcetape command, sourcetape files will be saved in the sourcetape library, located at ~/Library/sourcetape/sourcetapes.

Playing a Sourcetape

You can play a sourcetape recording through the command palette or the Explorer tree viewer:

• Use the Sourcetape: Play Sourcetape command from the command palette.
• Browse the Sourcetape Tree Viewer under the Explorer tab. It will show all sourcetapes it can find in your project, under the .sourcetape folder, and in the Sourcetape library, which is located at ~/Library/sourcetape/sourcetapes. Press on one of the sourcetapes and a session will start.

Controlling a Sourcetape Session - Pause, Rewind and Forward

When playing a sourcetape, a progress indicator will be displayed and three additional buttons will appear in the editor navigation menu at the top right of each open file:

• Rewind 10 seconds
• Pause/Resume
• Forward 10 seconds

You can control the sourcetape session by using any one of those buttons. You can end the sourcetape session by closing the progress message. This will also remove the buttons.