VS Code Chronicler
Chronicler is a cross-platform plugin for recording screens (windows) within VS Code. The application relies upon FFmpeg as the base for recording. The primary functionality of the plugin is to start and stop recording. The status bar contains an item that will provide you the current state of the recording process, and is an actionable element for starting/stopping a recording.
How Recording Works
The recording process determines the location and dimensions of your VS Code window, and will start a recording session for that region, immediately. To prevent the UI from getting in the way, when stopping, use the keyboard shortcuts to terminate the process. The status bar will be your indicator of the current status of your recording. On completion you can can choose to open the file with your operating system, you can copy the path to your clipboard, or just dismiss. Additionally, if you are configured your settings for supporting the animated gif production, the file path will change to point to the
The underlying tools for screen recording, rely upon FFmpeg. This has a distinct limitation of only being able to record a portion of the screen. This means that the recording does not follow windows as they move, but specifically the initial location/size of the VS Code window.
How to Start Recording
This will initiate a new recording, and will prompt for the FFmpeg installation if not set yet. This prompt will allow you to specify the location or to download the latest version as needed.
This can be triggered by:
How to Stop Recording
This will stop the current recording, and provide a link to the final file location. This can be triggered by:
The available configuration options are:
Animated GIFs are supported, if you configure
This project was inspired by:
Currently, wayland support is missing
Resolving reverted localization fix for windows.
Bugfix for win32 scale detection and for handling spaces in ffmpeg path in win32 Bugfix for x11, allow for host display environment variable to be honored
Bugfix for win32 non-US locales (different decimal point symbol).
Bugfix that broke darwin-based screen lookups
Updating screen-recorder/win-info to 0.2.x line, to support win32 desktop scaling.
Resolving a bug in which copying the file deletes the file as well. Additionally deleting mp4 files when deleting the animated gif.
Updating recording icons to use debug set, which provides color. Updating documentation.
Removed color styling from status bar, to better support themes. Added ability to open a recording's containing folder, or delete it on termination of recording.
Adding in support for
Adding in new osx binary, statically compiled, and upgrading screen-recorder to 0.1.6. Additionally merged changes in for the output directory to be a properly configurable element.
Added in support for auto recording VS Live Share session. Added in flag to support scaling of generated GIFs. Special thanks to @lostintangent for the live share integration.
Exposed download functionality from @arciisine/screen-recorder, and provide ability for user to set required configuration in a guide manner. Special thanks to @DonJayamanne for the feedback.
Externalized the ffmpeg interactions into @arcsine/screen-recorder, fixing default recording folder
Aligned screen support with @arcsine/active-win, pulling in support for X11 vs linux. Additionally support for multiple displays.
Bug fix with respect to binary location detection, and handling.
Released windows compatibility, reworked ffmpeg argument generation to tailor to each platform better.
Issue with linux launching (odd/even pixel issue) as well as better results launching
Cleaned up linux support Provided link for ffmpeg 4.1 with patch applied for audio capture during screen recording UI improvements
Added support for:
Initial release, support for