Miraiclip SDK
Screen recordings

Desktop recorder

Record your whole screen on macOS or Windows with your camera and voice, and log clicks, shortcuts and scrolls in every app, not just the browser.

Miraiclip Recorder is a desktop app for macOS and Windows. It records a whole screen with your microphone and camera, and logs what you do anywhere on that screen: clicks, shortcuts, scrolls and the cursor's path, in any app. It saves the same .mcrec file as the Capture extension, so Polish zooms in on your clicks and highlights the pointer in desktop apps too.

Download it below and use it as it is. Its source is in the SDK repository (apps/capture-desktop, built with Electron on @miraiclip/capture), so you can also use it as the starting point for your own recorder.

Extension or desktop app?

Use the extension for walkthroughs that stay in the browser. It knows what was clicked (button names, private fields) and can record a single tab. Use the desktop recorder when the walkthrough leaves the browser: a desktop app, the terminal, system settings, or several apps in turn.

Install

Your computerDownload
Mac with Apple silicon (M1 and later)Miraiclip-Recorder-mac-arm64.dmg
Mac with an Intel processorMiraiclip-Recorder-mac-x64.dmg
Windows 10 or 11 (x64 or Arm)Miraiclip-Recorder-Setup.exe

These links always get the newest version. Release notes and older versions are on the releases page. Not sure which Mac you have? Open the Apple menu → About This Mac: it says Chip: Apple M… or Processor: Intel. The Editor UI kit's Record panel also offers the right download for your computer.

  • macOS: open the .dmg and drag Miraiclip Recorder to Applications.
  • Windows: run the installer and pick where to install it.

The builds aren't signed yet, so they show a warning the first time they open. On macOS, right-click the app and choose Open, then Open again. On Windows, click More info → Run anyway in SmartScreen.

Build from source

With access to the SDK repository, you can build it yourself on the computer you'll record on:

pnpm install
pnpm --filter miraiclip-capture-desktop start      # build and open the app
pnpm --filter miraiclip-capture-desktop dist:mac   # on a Mac  → apps/capture-desktop/release/*.dmg
pnpm --filter miraiclip-capture-desktop dist:win   # on Windows → apps/capture-desktop/release/*.exe

Permissions on macOS

PermissionWhyWhere
Screen RecordingTo record the screenSystem Settings → Privacy & Security → Screen & System Audio Recording. Quit and reopen the app after allowing it
AccessibilityFor the click log (to see clicks and keys in other apps)The app asks; Allow… in the panel shows the prompt, Open System Settings goes to the pane
Camera, MicrophoneYour camera and voiceAsked the first time the app opens

Without Accessibility the app still records, just without the click log; the panel and the controls say so. Windows needs no extra permissions.

Record

  1. Open Miraiclip Recorder.

  2. Pick the screen to record (with several displays, each one has a thumbnail).

  3. Choose your camera and microphone, or No camera / No microphone. With a camera, a round preview of you appears at the bottom left of the screen; drag it anywhere.

  4. On Windows, turn on Record the computer's sound to include system audio.

  5. Click Start recording. After the 3-second countdown, the panel hides and the controls appear at the bottom of the recorded screen:

    ControlWhat it does
    ■ (red)Finish. Alt+Shift+X works from any app
    ❚❚ / ▶Pause and resume. Alt+Shift+P. Paused time is cut from the video and the log alike
    FlagMark a step. Alt+Shift+S. Steps become chapters, guide sections and voiceover lines
    BinDiscard the recording (click twice)

    The controls show click log while clicks are being logged, and no click log when they can't be (see Permissions on macOS).

  6. Finish. Choose where to save the .mcrec file (by default your Videos/Miraiclip folder), then Show in folder or Record again.

The controls and the camera preview are kept out of the video on Windows. On macOS the camera preview hides while you record, because macOS may still include it in screen recordings; check that the controls aren't in your video, and if they are, drag them to another display.

Open it in the editor

In the Editor UI kit, open Record in the left rail, then Import a recording and pick the .mcrec file. The screen recording opens as a new project with a marker for each step, and your camera as a round picture-in-picture (change it under Camera). Then go to Polish: zooms follow your clicks, and since the real pointer is in the video, Polish adds a highlight around it instead of drawing a second cursor.

What's in the log

EventLogged
Pointer movesPosition on the recorded screen (for zooms and the cursor highlight)
ClicksPosition and button. Right clicks and double clicks too. A drag is not a click
Named keys and shortcutsEnter, Shift+Tab, Ctrl+c, Meta+k, …
TypingOnly that a key that types was pressed. Never which one
ScrollsThat you scrolled, and which way
Leaving the screenWhen the pointer moves to another display
StepsYour step marks

Positions are in the recorded screen's points from its top-left corner, so they line up with the video exactly, at any display scaling. Clicks on the recorder's own controls and its shortcuts aren't logged.

Compared with the extension

Capture extensionDesktop recorder
RecordsA tab, a window or a screenA whole screen
Clicks logged inChrome pagesEvery app
What was clicked (label, box)YesNot yet
Private fields blurred automaticallyYesNot yet: blur them by hand in the editor
Mouse pointerDrawn by Polish (tab) or highlighted (window, screen)Highlighted

Good to know

  • Whole screens only, for now. Single-window recording and knowing what was clicked (button names, private fields, through macOS Accessibility and Windows UI Automation) are next.
  • What you type is never recorded. The log only notes that a typing key was pressed; shortcuts with Ctrl, ⌘ or Alt keep their names, as in the extension.
  • Long recordings are packed in memory before they're saved. Typical walkthroughs are fine; for recordings over an hour, keep an eye on memory.

Build your own

The app is a thin shell around @miraiclip/capture. startRecording records the screen, microphone and camera with events: false. The click log comes from a system-wide input hook in the main process and is added with recording.addEvent(), timed with recording.clockAt(). packRecording then makes the .mcrec file. The session is marked surface: "monitor", with the display as its viewport and viewportInVideo set to the whole frame, so the editor maps every event onto the video directly. See apps/capture-desktop/README.md for the code tour.

On this page