RTS [[blue:Action Replay]] Extension

Replay yourbest moments

Capture [[blue:OBS Replay Buffer]] clips and play them through a [[blue:Streamer.bot]] controlled browser overlay.\nA complete clip management system with a [[blue:fully featured catalog]], search, ratings and playlists. Capture and play clips from [[blue:OBS]], [[purple:Twitch]], [[red:YouTube]] and [[green:Kick]] platforms.\n manage your clip library, and control playback directly from chat with over [[blue:39 commands]] across all supported platforms. The Settings interface provides control over [[blue:colours]], [[blue:layout]], [[blue:behaviour]] of playback, playlists, messages and presentation. Using the [[yellow:RTS Position Editor]], you can position and animate the [[blue:Player]], [[blue:Panels]] and [[blue:Messages]] anywhere on your overlay.

v1.0.0Streamer.botOBSMeldTwitchYouTubeKickVideoMedia CatalogReplay BufferClipsOverlay

THE EXPERIENCE

Turn OBS replay clips into an interactive on-stream replay player.

A complete multi-platform clipping and catalog system for your replays.

Supports Twitch, YouTube and KickFull support for [[purple:Twitch]], [[red:YouTube]], and [[green:Kick]] (via kickbot or kick). Capture clips directly from each platform's chat with platform-specific branding, depending on which platform initiated the command.

Complete colour controlCustomise the [[white:Brand Colours]], [[white:Logo]], and [[white:fonts]] to fit your stream design. [[blue:4 Design presets]] to choose from. Choose different presets for different platforms.

Full catalog with search, rating and leaderboardsComplete [[blue:catalog]] of all your clips, with full searching by [[white:date]], [[white:creator]], and [[white:rating]]. Leaderboards keep track of top clippers and clip requestors. Full [[blue:playlist]] functionality to queue multiple requested clips.

Remote or local overlayA complete, functioning [[blue:overlay]] to perform all the actions you need, with a [[white:dev mode]] for easy configuring and testing of the extension.

Complete layout control with full animationComplete control with our [[blue:positioning system]] lets you position the [[white:Player]], [[white:Search Panels]], and [[white:Overlay Messages]] wherever you want, Create [[blue:entry/exit animations]] for them with ease.

Include complete set of Chat commandsChat commands for everything: [[white:clipping]], [[white:Queuing]], [[white:Catalog Searching]], [[white:Playlist control]], and [[white:video control]].

PRODUCT DEMO

See it in action.

REQUIREMENTS

Before you install.

[[blue:Streamer.bot]] with its WebSocket and HTTP servers enabled.
OBS with Replay Buffer enabled. (for local capture of clips)
RtsUI.dll for the extension settings interface. The extension will automatically update and install this DLL if it is missing or out of date.

INSTALLATION

Get Action Replay running.

Import the [[blue:Streamer.bot]] actions, enable them, configure OBS Replay Buffer and the local HTTP file mapping, add the overlay to OBS, then test Action Replay.

01 Import the extension into [[blue:Streamer.bot]]

Open [[blue:Streamer.bot]] and use Import to paste the supplied import string, or download the latest import file and import it into [[blue:Streamer.bot]].

.1 Copy the import string

Look above for Action Import, click the Copy Import button, then paste the import code into [[blue:Streamer.bot's]] Import dialog.

.2 Open Import

Select Import from the [[blue:Streamer.bot]] toolbar.

.3 Paste the import code

Paste the supplied import string into the Import String box, then select Import.

.4 Confirm the import

Review the actions being imported, then select Import to continue.
02 Enable the imported actions

Enable the imported RTS Action Replay actions and commands so the extension can respond to events and chat commands.

.1 Enable the extension actions

Enable the imported RTS Action Replay actions in [[blue:Streamer.bot]].

.2 Check and Enable the commands

Confirm the imported RTS Action Replay commands are present and enabled where required.
03 Enable OBS Replay Buffer

If you want to enable capturing of local files created by the OBS Replay Buffer, choose the folder where the replay files are saved.

.1 Enable Replay Buffer

In OBS, open Settings > Output and enable Replay Buffer.

.2 Choose the replay folder

Configure OBS to save replay files to a folder that [[blue:Streamer.bot]] can access. You will use this same folder when configuring the HTTP Server mapping and RTS Action Replay settings.
04 Configure the [[blue:Streamer.bot]] HTTP Server

The hosted RTS overlay cannot read files directly from your computer. [[blue:Streamer.bot's]] HTTP Server provides the local URL that the overlay uses to load replay video files.

.1 Enable the HTTP Server

In [[blue:Streamer.bot]], open the Servers or Web Server settings and enable the HTTP Server. Keep note of the HTTP port.

.2 Add file mappings to the HTTP server

Create a file or directory mapping for the OBS Replay Buffer folder. Use a simple URL path such as [[code:replays]] and point it to the same local folder where OBS saves replay files.\nIf you want to save Twitch and Kick clips locally, add a mapping for those too. The mapping should point to the folder you set up in the extension settings for Twitch and Kick.

.3 Keep the HTTP server available

Leave the [[blue:Streamer.bot]] HTTP Server running while using Action Replay. The overlay uses this service to request the local replay video. It's recommended to turn on the toggle at the top of the HTTP settings to have the HTTP server auto-start on launch.
05 Enable the [[blue:Streamer.bot]] WebSocket

The hosted overlay uses the [[blue:Streamer.bot]] WebSocket to receive Action Replay events and commands.

.1 Enable the WebSocket Server

In [[blue:Streamer.bot]], open the WebSocket Server settings and enable the server. Keep the configured port available to the overlay.

.2 Keep WebSocket access available

The [[blue:Streamer.bot]] WebSocket Server must remain running while the Action Replay overlay is in use. It's recommended to turn on the toggle at the top of the WebSocket settings to have the WebSocket server auto-start on launch.
06 Add the Action Replay overlay to OBS

Add the Action Replay hosted overlay as an OBS Browser Source, or use the supplied local overlay files.

.1 Copy the Overlay URL

Look above in the Quick Access section and click the Copy Overlay URL button. This copies the overlay URL to your clipboard for use in OBS.

.2 Create a browser source

Add a Browser Source to an existing or newly created scene in OBS.

.3 Configure the browser source

Paste the Overlay URL you just copied into the URL field, then set the width and height to 1920x1080 or another 16:9 size. The Action Replay overlay uses a 1920x1080 coordinate system. Enable Refresh browser when scene becomes active if required by your scene setup.
07 Configure RTS Action Replay Settings

Open the RTS Action Replay settings and configure the extension.

.1 Open the settings dialog

In the [[blue:Streamer.bot]] Actions panel, look for RTS Action Replay settings action to open the extension settings. The settings are fully documented below in [[yellow:Action Replay Documentation]]

* Automatic installation of RtsUI.dll

If you do not have the DLL installed, the extension can download and place it in your [[blue:Streamer.bot]] installation directory. If you do not see the install prompt, it may be hiding behind another window. Check your taskbar for a [[blue:Streamer.bot]] dialog and bring it to the front.

* Automatic updating of RtsUI.dll

If the extension requires an updated version, it can ask whether you want to download and install the latest version. If you do not see the update prompt, it may be hiding behind another window. Check your taskbar for a [[blue:Streamer.bot]] dialog and bring it to the front.
08 Test Action Replay Setup and Configuration

Test and set up the Extension using the overlay's built-in development mode.

.1 Put the overlay into dev mode

Copy the [[overlay:Overlay URL]], open it in a browser, and add [[muted:?dev=true]] at the end.\n\nThis will put the overlay into dev mode, where you can test and preview the extension's features and settings.

.2 Send the current config to the overlay

In the Test tab of the extension's settings, you can click the Send Configuration to Overlay button. Once this is done, all the presets will be sent to the overlay and can be previewed.

.3 Use the test harness to preview your current settings.

The Testing tab of the settings allows you to send various actions to the overlay so you can preview your changes easily.\n\nAfter changing an option in the test settings, click save before initiating a test.

DOCUMENTATION

Action Replay Settings Guide

There are a large number of settings that enable you to configure how the extension behaves and looks.\nThis documentation guide aims to walk you through what each setting does, allowing you to tailor the extension to your specific needs.

01 Local Capture
[[blue:Streamer.bot]] can be set up to watch a folder for new media.\nThis is particularly useful for OBS (or other capture/streaming software) when captures via its replay buffer are saved to a folder on your computer. [[blue:Streamer.bot]] picks this up and adds the file to the catalog.\n[[blue:Streamer.bot's]] HTTP Service maps the folder and serves the file to the overlay when requested.
.1 Local Capture / OBS

Replay Folder
Browse to the folder where you have set up OBS (or other streaming software) to save its Replay Buffer files to.\nTwitch and Kick downloads use separate folders and are configured in their own sections.

Replay File Types
File extensions accepted when scanning or registering files from the Replay Folder. Separate multiple extensions with commas, for example [[code:.mp4, .mkv]].

HTTP Mapping
URL path used in the local replay URL. It must match the [[blue:Streamer.bot]] HTTP server mapping you set up in the installion step [[yellow:04]].

HTTP Port
Port used in the local replay URL. It must match Streamer.bot's HTTP server port.

Related Commands
!add-existing-replay "<filename>" <title>Add one existing OBS replay file from the configured Replay Folder to the Catalog. If no title is supplied, the Replay Title Template is used. Existing Catalog entries are not added again.

!scan-replay-folderScan the configured Replay Folder and add replay files that are not already in the Catalog.

!savereplay | !save-replay | !clip-local | !cliplocalTell OBS to save the current Replay Buffer. What happens next depends on Replay Source and Playlist settings.

.2 Replay Defaults

Replay Title Template
Generates the title of a newly added OBS replay. Available variables are [[code:%replayName%]], [[code:%replayDate%]] and [[code:%replayTime%]]. A manually supplied title bypasses the template.

Variables
Variables%replayName%%replayDate%%replayTime%
.3 Local Capture Handling
Auto-add Saved Replays (OBS Capture)
Adds each newly saved OBS replay to the Catalog. It also becomes available to Recent Clips through the Catalog's recent history.

Auto-play OBS Captures
Adds a newly saved OBS replay to the playback queue for playback.

When automatic registration is disabled, existing replay files can still be registered with Add Replay or Scan Replays.

Related Commands
02 Twitch
Configure how [[purple:Twitch clips]] are acquired and made available to the player.
.1 Twitch Clips
Twitch Clip Playback
Use the Twitch URL, download locally, or support both methods.\nIn Both mode, a local copy is preferred, and Twitch is the fallback.

Twitch Clip Folder
Folder used for downloaded Twitch clips. It must be separate from the OBS Replay Folder.

Twitch HTTP Mapping
URL path used by [[blue:Streamer.bot]] to serve downloaded Twitch clips. The shared HTTP Port is configured under Local Capture / OBS.

Clip Duration
Default duration used by Twitch clip commands when no duration is supplied.

The allowed Twitch clip duration is 5-60 seconds. A duration supplied with the command overrides the setting within that range.

Related Commands
!twitch-clip [<duration>] [<title>] | !twitchclip [<duration>] [<title>] | !create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>]Create a Twitch clip. Twitch chat only. Duration is 5-60 seconds.
03 YouTube
Configure timestamp-based clips from the current monitored [[red:YouTube]] broadcast.
.1 YouTube Clips
Clip Duration
Default duration used by [[red:YouTube]] clip commands when no duration is supplied.

The allowed duration is 5-60 seconds. Action Replay uses the current broadcast and its monitored start time to calculate the clip timestamp.

Related Commands
!create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>]Create a timestamped clip from the current YouTube live broadcast. YouTube chat only.
04 Kick

Configure how [[green:Kick]] clips are acquired and made available to the player.

.1 Kick Clips

Kick Clip Playback
Use the [[green:Kick]] URL, download locally, or support both methods. In Both mode, a local copy is preferred, and direct [[green:Kick]] playback is the fallback.

Kick Clip Folder
Folder used for downloaded [[green:Kick]] clips. It must be separate from the OBS Replay Folder.

Kick HTTP Mapping
URL path used by [[blue:Streamer.bot]] to serve downloaded [[green:Kick]] clips. The shared HTTP Port is configured under Local Capture / OBS.

Related Commands
!create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>]Request a Kick clip through the KickBot workflow. Kick chat only.
05 Player
Control how replays start and how playback controls and player styling are presented.
.1 Playback

Show Controls
Displays the Play/Pause control and interactive playback progress bar.

Show Progress Bar
Displays the interactive playback progress bar.

Default Playback Speed
Playback speed used when a replay is loaded; normal playback speed is 1. Range from 0.25 to 2.0.

Show Visibility
Controls when the playback speed indicator is displayed.

Related Commands
!recently-played [--amount <N>] | !last-played [--amount <N>]Show the most recently played replays.

!player-pos <position tag> [<duration ms>] | !player-position <position tag> [<duration ms>]Move the player to a saved position. Use the saved position tag, not the display name.

!hide-player | !player-hideHide the current player without deleting or resetting the replay.

!video-pause | !player-pausePause the current video.

!video-play | !player-playResume the current video.

!set-speed <playback speed> | !player-speed <playback speed> | !clip-speed <playback speed>Change playback speed. Accepted range is 0.25 to 4.0.

!show-player | !player-showShow the current player and resume the current video.
.2 Player Appearance
Frame Colour Source
Uses a Custom, Branding Primary or Branding Secondary colour for the player frame.

Frame Colour
Custom frame colour when Frame Colour Source is Custom.

Control Colour Source
Uses a Custom, Branding Primary or Branding Secondary colour for the Play/Pause control and progress bar.

Control Colour
Custom control colour when Control Colour Source is Custom.

Border Glow
Adds a branded glow around the player border.

Border Width
Player border width in pixels.

Corner Radius
Player corner radius in pixels.

Colours support opacity using the alpha slider in the colour picker.\nChange Player Branding to Clip Source is configured later under Player Behaviour. When enabled, it can override the player frame and control branding with the active source branding option.

Related Commands
!player-pos <position tag> [<duration ms>] | !player-position <position tag> [<duration ms>]Move the player to a saved position. Use the saved position tag, not the display name.
06 Catalog

The Catalog is the persistent replay library. Recent Clips and Last Played are different views/history derived from replay data, while the Playlist is the live playback queue.

.1 Recent Clips and Live Playlist

Maximum Recent Clips
Maximum number of entries shown in Recent Clips and retained in Last Played history. Older Catalog entries remain available.

Maximum Catalog Results
Maximum number of results shown per Catalog/search page. The [[code:--amount]] option can request a different page size up to this limit.

Persist Playlist Across Restarts
Keeps the current Playlist queue when [[blue:Streamer.bot]] restarts. Active playback and pause state are not persisted.

Related Commands
!search-recent [--amount <N>]Show recently captured or added replays. This is different from Last Played.

!playlistShow the current Playlist.

!play-clip <replay number> | !play-replay <replay number>Add a replay to the Playlist. A replay can be selected by Catalog/search result number, custom title, or platform and user search context.

!playlist-clear | !playlistclearRemove waiting items while leaving the currently playing item alone.

!playlist-clearall | !playlistclearallRemove everything from the Playlist without stopping a replay already playing.

!playlist-pause | !playlistpausePause automatic Playlist progression without stopping the current video.

!playlistremove <playlist item> | !playlist-remove <playlist item>Remove a waiting item by its Playlist position. The currently playing item cannot be removed.

!playlistresume | !playlist-resumeResume Playlist progression. If nothing is playing and queued items exist, Resume starts the next item.
07 Branding Presets

Define reusable colours, typography and branding identity used by Player, Panel, Clapperboard and Message presentation.

.1 Brand Preset Settings

There are 5 branding presets pre-configured: [[white:default]], [[yellow:RTS]], [[purple:Twitch]], [[red:YouTube]], and [[green:Kick]]. They can be changed, but not deleted.\nYou can create and delete extra presets as you need, and they will be available for use throughout the settings.

Preset Name
Display name used in settings and selection lists.

Source Platform
Optional [[purple:Twitch]], [[green:Kick]], or [[red:YouTube]] association.\n This Branding Preset will be used when the [[yellow:Use Source Branding option]] is turned on.\ne.g. If [[purple:Twitch]] is set as the source platform, this branding preset will be used to style requests initiating from [[purple:Twitch]].

Primary Colour
Primary branding colour.

Secondary Colour
Secondary branding colour.

Player Title Colour
Replay title text colour.

Player Prefix / Suffix Colour
Decorative title prefix/suffix colour.

Panel Text Colour
Panel title/list text colour.

Panel List Shadow Colour
Panel list shadow colour.

Font
Google Font used by player titles, panel titles and branding.

Font Size
Font size used by player and panel titles.

Logo URL
HTTPS URL of the branding logo.

Fallback Text
Text used when the branding logo cannot be loaded.

Brand Label
Label displayed with the logo or fallback text.
08 Design Presets

Define the visual treatment used by Player, Panel, and Message presentation.\nThere are 2 configurable presets [[yellow:Broadcast]] and [[yellow:Cut]], plus two non-configurable presets [[yellow:Cinematic]] and [[yellow:Minimal]]

.1 Broadcast

Provides an animated chevron treatment.

Background Source
The background colour to use for panels,and messages. Options: RTS Dark Blue background, Branding Secondary Colour, or Custom Colour

Background Colour
The colour will be used if Custom is set for Background Source

Chevron Height
How tall the chevrons will appear. 1 - 89

Randomise Height
The height for each chevron will be randomised as it is generated, between 1 and the Chevron Height setting

Chevron Width
How wide the chevrons will appear. 1-300

Randomise Width
The width for each chevron will be randomised as it is generated. between 0 and the Chevron Width setting

Chevron Spacing
How much space between each chevron. 0-200

Randomise Spacing
The space between each chevron will be randomised as it is generated. between 0 and the Chevron Space setting

Chevron Speed
How fast the chevrons move horizontally from left to right. 10-500

.2 Cut

Provides an animated block/bar treatment.

Background Source
The background colour to use for panels, and messages. Options: RTS Dark Blue background, Branding Secondary Colour, or Custom Colour

Background Colour
The colour will be used if Custom is set for Background Source

Block Width
How wide the blocks will appear. 1 - 600

Randomise Height
The height for each chevron will be randomised as it is generated, between 1 and the Block Width setting

Bar Height
How tall the blocks will appear. 1-50
09 Title Presets

.1 Title Presets

Define how replay titles are positioned, decorated, and animated in the Player. The default preset can be changed, but not deleted.\n*DO NOT RENAME THE DEFAULT PRESET!!!

Preset Name
Display name for the preset.

Decoration Position
Places the decoration before or after the title.

Title Position
Places the title at the top or bottom of the player.

Decoration
Text displayed as the title prefix/suffix.

Animation
Title entrance/exit animation. There are 3 options:\nLeft to Right - Slides in from the left to the right: Slides out from the right to the left\nRight to Left - Slides in from the right to the left : Slides out from the left to the right\nSlide Up/Down - Slides up from the bottom and back down, or slides down from the top and back up, depending on whether the title is positioned at the top or the bottom. : Slides out from Right to Left\n

Show Delay
Delay before the title is shown, in milliseconds.

Display Duration
Time the title remains displayed, in milliseconds.

Animation Duration
Duration of the title animation, in milliseconds.
10 Positions

Define reusable Player, Panel, Message, and Clapperboard positions in the shared 1920x1080 overlay coordinate space.

.1 Panel and Message Positions

Panel and Messages can have their Width, Height, and Corner Radius set. After changing these options, save and exit settings, then reopen settings before editing the positions.\nPositions are used in animation presets for displaying the Panels/Messages.

Width
Width of Panel/Message in pixels.

Height
Height of Panel/Message in pixels.

Corner Radius
Corner Radius of Panel/Message in pixels.

Edit Positions
Opens the RTS Position Editor (See Position Editor below)

.2 Player Positions

Saved positions used by Player Animation and playback.

Edit Positions
Opens the RTS Position Editor (See Position Editor below)

Related Commands
!player-pos <position tag> [<duration ms>] | !player-position <position tag> [<duration ms>]Move the player to a saved position. Use the saved position tag, not the display name.

.3 Clapperboard Positions

Saved positions used by Clapperboard Animation and playback.

Edit Positions
Opens the RTS Position Editor (See Position Editor below)

.3 RTS Position Editor

The [[yellow:RTS Position Editor]] allows you to place the Player, Panels, Messages, and Clapperboard anywhere on your display;\n you can place elements on and off screen then use the animation presets to show and hide elements however you choose.\n The position editor is based on a 16:9 resolution and works on 1080p and 1440 resolutions. All four position editors support saved transforms, including scale, X/Y/Z position, and X/Y/Z rotation. Animation Profiles reference these saved positions, so changing a saved position affects every profile that uses it.

Position Presets
The left-hand column lists the presets that have been created. The [[code:Full Screen]] is a default preset and cannot be edited. Presets you create will appear here and will be available for the [[yellow:animation editor]] (see below)

Position Titles and Tags
When creating a position you can set the title and a tag, the tag is used when using !set-pos command to position the player, currently it is not possible to set the position of Panels, Messages, or the Clapperboard on the fly.

Positioning X, Y, Z
Allows positioning of the element on the X, Y, and Z axis, 0 is centered. You can move the element left using - values and right using positive values. Z moves the element towards you (positive, e.g. 100) or away from you (negative e.g -100) in 3d space.

Transform X, Y, Z
Allows rotating of the element on the X, Y, and Z axis, 0 is centered. You can rotate the element left using - values and right using positive values. Z rotates the element left (negative e.g -100) or right (positive, e.g. 100) on a flat plane

Scale X, Y
Allows resizing of the elements' X and Y values; setting to 0 will effectively hide the element completely

Availiable Buttons
Add Position - Adds a new position preset.\nDuplicate - Duplicates the selected Position Preset.\nDelete - Deletes the selected Preset.\nPreview Position- Sends the current position to the dev overlay so you can see exactly where it will appear on the overlay.\nHide Preview - I have no clue what this was for or what it does...

Save, Close and Cancel
They do what they say; make sure you click Save before previewing a position. Always save and exit, unless you want to lose your changes.
11 Animation Profiles

Animation Profiles are created to allow complete configuration of how your elements appear and disappear.\nThere are 4 animation profile tabs one each for the [[yellow:Player]], [[yellow:Panel]], [[yellow:Message]] and [[yellow:Clapperboard]]. The Animation system works the same for all elements. There is a default Animation profile for each element that cannot be deleted. More presets can be created for each element as needed.

.1 Animation Sequences

Each Animation Profile has a [[yellow:Start Sequence]] and an [[yellow:End Sequence]]. The Start Sequence determines how the element appears; the End Sequence determines how it disappears.

.2 Start Sequence

A sequence is created from 1 or more positions defined in the elements [[yellow:Position Editor]]; only the positions for the current element will be shown, i.e., player positions cannot be used in Panel Sequences

The First item in a Start sequence
The first row determines the start position of the animation.\nIt is best to use a position where the element's width and height are set to 0, or an off-screen position.\nThe first position should alway have its duration and delay set to 0 as there is nothing for it to transistion from.

Adding items to a sequence
Click Add Row to add a new step in the sequence, the animation engine will use the rows setting and transition from the last item to smoothly transition to the next item.

Position
Select the position you want to transition to

Duration
The duration for the transition in milliseconds (1000ms = 1 second).

Easing
How you want the transition animation to run; easing affects the speed of the transition at its start and end. There are 4 easing settings to choose from.

Delay
How long to wait before starting the next item in the sequence.

.3 End Sequence

An End sequence is created from 1 or more positions defined in the elements [[yellow:Position Editor]]; only the positions for the current element will be shown, i.e., player positions cannot be used in Panel Sequences

The First item in an End Sequence
The end Sequnce effectite start position is taken from where it is currently displayed in the overlay, (e.g. the last position in the Start Sequence). The first item in the End Sequence will transition from the current position to the first item in the End Sequence. Then continue the other steps, It is reccomended that the last step in thee sequnce is a position off screen or with its width and height set to 0, so that the element is hidden at the end of the sequence.

Adding items to a sequence
Click Add Row to add a new step in the sequence, the animation engine will use the rows setting and transition from the last item to smoothly transition to the next item.

Position
Select the position you want to transition to

Duration
The duration for the transition in milliseconds (1000ms = 1 second).

Easing
How you want the transition animation to run; easing affects the speed of the transition at its start and end. There are 4 easing settings to choose from.

Delay
How long to wait before starting the next item in the sequence.
12 Player Behaviour

The player Behaviour tab allows you to congigure how the player looks and behaves on each platform, there are 4 Create profiles for each platform: [[blue:OBS]], [[purple:Twitch]], [[red:YouTube]], and [[green:Kick]].\nThe Create profiles determine how the player looks when a clip is created on that platform.

.1 Use Source Platform Branding

When this is on, the player will use the branding preset associated with the platform that created the clip, if a matching preset exists. Otherwise it will default to using the Branding set in the Play Replay setting (see below).\nWhen it is Off, the player will use the Branding Preset set in the Create setting for that platform.

.2 Create [[blue:OBS]], [[purple:Twitch]], [[red:YouTube]], and [[green:Kick]] settings

Each platform can have its own Animation Profile, Design Preset, Title Preset, and Branding Preset.\nThe Create settings determine how the player looks when a clip is created and played from that platform.

Branding Preset
Selects the Branding Preset to be used when a clip is created on the associated platform.

Design Preset
Selects the Design Preset to be used when a clip is created on the associated platform.

Title Preset
Selects the Title Preset to be used when a clip is created on the associated platform.

Animation Profile
Selects the Animation Profile to be used when a clip is created on the associated platform.

.3 Play - Replay settings

The Play settings determine how the player looks when a clip is played from the [[yellow:Playlist]], [[yellow:Recent Clips]], or [[yellow:Last Played]].\nThe Branding Preset, Design Preset, Title Preset, and Animation Profile can be set independently of the Create settings.

Change Player Branding to Clip Source
Uses the branding of the platform the clip was captured on, e.g. If the clip was created on twitch it will use the twitch branding preset when being played. Each clip in the playlist will change the branding of the player to match the platform the clip was created on.

Branding Preset
Selects the Branding Preset to be used when a clip is played from the playlist, recent clips, or last played.

Design Preset
Selects the Design Preset to be used when a clip is played from the playlist, recent clips, or last played.

Title Preset
Selects the Title Preset to be used when a clip is played from the playlist, recent clips, or last played.

Animation Profile
Selects the Animation Profile to be used when a clip is played from the playlist, recent clips, or last played.
13 Panel Behaviour

The Panel Behaviour tab allows you to configure how the panels look and behave, there are several options available to customize the appearance and behavior of the panels.\n you can configure each panel type separately [[yellow:Recent/Search]], [[yellow:Playlist]] and [[yellow:Leaderboards]].

.1 Use Source Platform Branding

When this is selected, the recent/search will use the branding preset asscociated with the platform that the request came from.

.2 Recent / Search

When this is selected, the panels will use the branding preset asscociated with the platform that the request came from.

Branding Preset
The branding preset to use for the recent/search panel when Use Source Platform Branding is not selected.

Design Preset
The design preset to use for the recent/search panel

Animation Profile
The animation profile to use for the recent/search panel

.3 Playlist

Whenever a clip is requested, captured or queued, the playlist panel will be updated to reflect the current state of the playlist.\nThe playlist panel can be configured to use a different branding preset, design preset and animation profile than the recent/search panel.

Branding Preset
The branding preset to use for the recent/search panel when Use Source Platform Branding is not selected.

Design Preset
The design preset to use for the recent/search panel

Animation Profile
The animation profile to use for the recent/search panel

Related Commands
!playlistShow the current Playlist.

!playlist-clear | !playlistclearRemove waiting items while leaving the currently playing item alone.

!playlist-clearall | !playlistclearallRemove everything from the Playlist without stopping a replay already playing.

!playlist-pause | !playlistpausePause automatic Playlist progression without stopping the current video.

!playlistresume | !playlist-resumeResume Playlist progression. If nothing is playing and queued items exist, Resume starts the next item.

!playlistremove <playlist item> | !playlist-remove <playlist item>Remove a waiting item by its Playlist position. The currently playing item cannot be removed.

.4 Leaderboards Creator and Most Views

Action Replay keeps track of the most viewed clips and the creators with the most clips created.\nThe leaderboard panels can be configured to use a different branding preset, design preset and animation profile than the recent/search panel.

Branding Preset
The branding preset to use for the Leaderboard panel when Use Source Platform Branding is not selected.

Design Preset
The design preset to use for the Leaderboard panel

Animation Profile
The animation profile to use for the Leaderboard panel

Related Commands
!creator-leaderboard [<period>] [--amount <N>]Show the creator leaderboard.
14 Message Behaviour

Configure how transient messages are presented in the overlay.

.1 Use Source Platform Branding

When this is set the messages will use the branding of the platform the request came from.

.2 Use Default Branding

When this is set the messages will use the default branding of the platform the request came from.

Branding Preset
Branding used by transient messages, with source-platform fallback when enabled.

Design Preset
Design used by transient messages.

Animation Profile
Animation used by transient messages.

Display Time
Time the message remains visible before its end animation begins, in milliseconds.

Related Commands
!overlay-message <message> | !rts-message <message>Send a message directly to the RTS overlay using the configured Message Behaviour.
18 Clapperboard Behaviour

Configure the Clapperboard that is used when a new replay is created.

.1 Use Clapperboard

If selected the clapperboard will be shown when a new clip is created. If this setting is disabled, the message system will be used instead.

.2 Use Source Platform Branding

When this is set the Clapperboard will use the branding of the platform the clip was created on.

.3 Animation Profile

The animation profile used by the Clapperboard.

Use Clapperboard
Uses the Clapperboard for Replay Created instead of the Message system when Replay Created Overlay is enabled.

Use Source Platform Branding
Uses the Branding Preset associated with the platform that created the clip when available.

Animation Profile
Animation profile used by the Clapperboard.

Branding Preset
Fallback branding used when source-platform branding is disabled or unavailable.

Display Time
Time the Clapperboard remains visible before its end animation begins, in milliseconds.

Related Commands
!savereplay | !save-replay | !clip-local | !cliplocalTell OBS to save the current Replay Buffer. What happens next depends on Replay Source and Playlist settings.

!create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>]Request a Kick clip through the KickBot workflow. Kick chat only.

!twitch-clip [<duration>] [<title>] | !twitchclip [<duration>] [<title>] | !create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>]Create a Twitch clip. Twitch chat only. Duration is 5-60 seconds.

!create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>]Create a timestamped clip from the current YouTube live broadcast. YouTube chat only.
15 Search Options
Control how Search, Playlist and Recent Items presented.
.1 Search Presentation
Control how search results are presented in the overlay and chat.

Search - Panel
Shows Catalog/search results in the Search Panel.

Search - Chat
Shows Catalog/search results in the chat.

Both can be enabled at the same time. If none are enabled, search results are not presented in the overlay or chat.

Related Commands
!search <search text> [--amount <N>]Search the Catalog by text. With no search text, returns the Catalog without a text filter.

!search-creator <creator> [--amount <N>] | !creator-search <creator> [--amount <N>]Search for replays by creator.

!search-date <date period> [--amount <N>] | !date-search <date period> [--amount <N>]Search for replays from a date period. Supported forms include today, this week, last week, this year, last year, year, month and month year.

!search-rating [<rating>] [--amount <N>]List replays by rating. 0 is unrated; 1-4 select average rating bands 1.0-4.9; 5 selects a 5.0 average. Without a rating, rated replays are returned ordered by average rating.

!search-recent [--amount <N>]Show recently captured or added replays. This is different from Last Played.

!search-views [--amount <N>] | !most-views [--amount <N>]List replays ordered by playback count. Only replays with at least one recorded play are included.

!creator-leaderboard [<period>] [--amount <N>]Show the creator leaderboard.
.2 Playlist Presentation
Playlist - Panel
Displays the playlist results in the playlist panel on the overlay.

Playlist - Chat
Sends the playlist results to the chat.

Both can be enabled at the same time. If none are enabled, search results are not presented in the overlay or chat.

Related Commands
!playlistShow the current Playlist.
.3 Recent Clips Presentation
Recent - Panel
Displays the recent clips results in the recent clips panel on the overlay.

Recent - Chat
Sends the recent clips results to the chat.

Both can be enabled at the same time. If none are enabled, recent clips results are not presented in the overlay or chat.

Related Commands
!search-recent [--amount <N>]Show recently captured or added replays. This is different from Last Played.
.4 List Entry Format

Send full List as One Message
When disabled, each list entry is sent as a separate message. When enabled, the entire list is sent as a single message. If the list is too long to fit in a single message, it will be split into multiple messages.

List Entry Format
The format of the list entry used for each list entry.

Variables
Variables%listNumber%%title%%creator%%rating%%platform%%plays%
19 Messages
Configure message outputs for the various [[yellow:yellow:Action Replay]] events
- Each event has message text and a Chat toggle. Events that support overlay output also have an Overlay toggle.
- Replay Created uses the separate Clapperboard presentation when Use Clapperboard is enabled. The other overlay-capable lifecycle events use the Message presentation.
- Overlay messages are queued centrally. Chat messages are sent immediately. An overlay message is considered finished only when its exit animation completes.
- Replay Queued is generated only when the Playlist already contained an item before the new replay was added.
.1 Chat Message Limits

Set the platforms max character limit for chat messages.

Twitch
[[purple:Twitch]] maximum character limit (max 500 characters)

Youtube
[[red:YouTube]] maximum character limit (max 200 characters)

Kick
[[green:Kick]] maximum character limit (max 500 characters)

.2 Replay Created Message

When a replay is created this message is generated.

Replay Created Chat
Sends a message to the chat when a replay is created.

Replay Created - Overlay
Displays a message in the overlay when a replay is created.

Variables
Replay Created%replayTitle%%replayUser%%replayPlatform%%replaySourcePlatform%%requesterName%%requesterPlatform%

.3 Replay Played Message

When a replay is played this message is generated.

Replay Played Chat
Sends a message to the chat when a replay is played.

Replay Played - Overlay
Displays a message in the overlay when a replay is played.

Variables
Replay Played%replayNumber%%replayTitle%%replayUser%%replayPlatform%%replaySourcePlatform%%requesterName%%requesterPlatform%

.4 Replay Queued

When a replay is queued this message is generated.

Replay Queued Chat
Sends a message to the chat when a replay is queued.

Replay Queued - Overlay
Displays a message in the overlay when a replay is queued.

Variables
Replay Queued%replayTitle%%replayUser%%replayPlatform%%replaySourcePlatform%%requesterName%%requesterPlatform%

.5 Playlist Replay Removed

When a replay is removed from the playlist this message is generated.

Playlist Replay Removed - Chat
Sends a message to the chat when a replay is removed from the playlist.

Playlist Replay Removed - Overlay
Displays a message in the overlay when a replay is removed from the playlist.

Variables
Replay Removed%replayTitle%%requesterName%%requesterPlatform%

.6 Playlist Cleared

When the playlist is cleared this message is generated.

Playlist Cleared - Chat
Sends a message to the chat when the playlist is cleared.

Playlist Cleared - Overlay
Displays a message in the overlay when the playlist is cleared.

Variables
Playlist Cleared%clearedCount%%requesterName%%requesterPlatform%

.7 Playlist Clear All

When the all items in the playlist are cleared this message is generated.

Playlist Clear All - Chat
Sends a message to the chat when the playlist is cleared.

Playlist Clear All - Overlay
Displays a message in the overlay when the playlist is cleared.

Variables
Playlist Clear All%clearedCount%%requesterName%%requesterPlatform%

.8 Replay Rated

When a replay is rated this message is generated.

Replay Rated - Chat
Sends a message to the chat when a replay is rated.

Replay Rated - Overlay
Displays a message in the overlay when a replay is rated.

Variables
Replay Rated%replayTitle%%replayDescription%%replayRating%%averageRating%%requesterName%%requesterPlatform%

.9 Replay Renamed

When a replay is renamed this message is generated.

Replay Renamed - Chat
Sends a message to the chat when a replay is renamed.

Replay Renamed - Overlay
Displays a message in the overlay when a replay is renamed.

Variables
Replay Renamed%replayNumber%%oldTitle%%newTitle%%requesterName%%requesterPlatform%

.10 Replay Deleted

When a replay is deleted from the catalog, this message is generated.

Replay Deleted - Chat
Sends a message to the chat when a replay is deleted from the catalog.

Replay Deleted - Overlay
Displays a message in the overlay when a replay is deleted from the catalog.

Variables
Replay Deleted%replayTitle%%replayUser%%replayPlatform%%replaySourcePlatform%%requesterName%%requesterPlatform%
20 Import / Export
.1 Import Settings
Import selected RTS Action Replay settings from a JSON file. Click Import and you will be prompted to choose a file containing the settings you want to import.

Once you have selected your import file a dialog will open where you can choose what settings you want to import
.2 Import Catalog

Allows you to import catalog items back into [[blue:Action Replay]]

Catalog Scope
All - Import Everything into the catalog.\nSelected - Only import the selected items into the catalog.

Platforms
Choose which platforms to import clips from.\n[[purple:Twitch]] - Import Twitch Clips.\n[[red:YouTube]] - Import YouTube clips.\n[[green:Kick]] - Import Kick clips.\n[[blue:]] - Import Local OBS Clips (this will not import the actual media files the catalog links too)

Duplicate Entries
Choose what to do when duplicate entries are found - Skip or Overwrite

.3 Branding Profiles

Allows you to import Branding Profiles back into [[blue:Action Replay]].\n A list of profiles contained in the export will be displayed, check the profiles you wish to import.

.4 Animation Profiles

Allows you to import Animation Profiles back into [[blue:Action Replay]].\n A list of profiles contained in the export will be displayed, check the profiles you wish to import.

.5 Import Selected

Click the Import Selected Button to import the selected data.
.6 Factory Reset
Restores RTS Action Replay configuration to its built-in defaults.

Factory Reset preserves the Catalog and play history. Configuration globals, Branding Presets, Animation Profiles are reset and required defaults are recreated.
21 Testing

.1 Configuration Sync

Send Configuration to Overlay sends the complete current Action Replay configuration to the overlay for testing purposes. The configuration can also be imported directly from the overlay when it is in dev mode.

.2 Player, Panels and Clapper Board

You can test the configuration for the Player, Panels and Clapper Board by clicking on the respective buttons.

Test Origin
Allows you to set the platform the test originates from.

Replay Origin
Allows you to set the platform the clip you are testing originates from.

Test Video
Plays the first Catalog replay using the current Player presentation settings without adding it to the Playlist or play history.

Test Panel
Shows a representative panel using the first Catalog replay and current Panel presentation settings.

Test Clapperboard
Shows the Clapperboard for the first Catalog replay using the current Clapperboard presentation settings.

.3 Messages

Message Type
Selects the type of message simulated by Test Message.

Test Source
Selects either the current Message settings or the selected Design and Branding overrides.

Message Design
When Test Source is Override, selects the presentation design used for the test.

Message Branding
When Test Source is Override, selects the presentation branding used for the test.

Test Message
Shows the selected message using the first Catalog replay. Chat output follows the selected Test Origin.

COMMANDS

Command Reference

Complete reference for the RTS Action Replay chat commands.

01Catalog

Add Existing Replay !add-existing-replay "<filename>" <title> Add one existing OBS replay file from the configured Replay Folder to the Catalog. If no title is supplied, the Replay Title Template is used. Existing Catalog entries are not added again.

Search By Creator !search-creator <creator> [--amount <N>] | !creator-search <creator> [--amount <N>] Search for replays by creator.

Search By Date !search-date <date period> [--amount <N>] | !date-search <date period> [--amount <N>] Search for replays from a date period. Supported forms include today, this week, last week, this year, last year, year, month and month year.

Delete Clip !delete-from-catalog <number(s)> Delete Catalog entries from the current result set. Multiple current-page results can be supplied as comma-separated numbers. The physical media file is not deleted.

First Page !search-first Return to the first page of the current Catalog/search results.

Last Page !search-last Jump to the last page of the current Catalog/search results.

Most Views !search-views [--amount <N>] | !most-views [--amount <N>] List replays ordered by playback count. Only replays with at least one recorded play are included.

Next Page !search-next Move to the next page of the current Catalog/search results.

Previous Page !search-prev Move to the previous page of the current Catalog/search results.

Purge !catalog-purge Remove Catalog entries whose replay media can no longer be resolved. It does not delete physical files.

Rate Replay !rate-replay <rating> | !rate-clip <rating> | !rate-video <rating> Rate the replay currently playing. Rating is 1 to 5 and is stored per user.

Search !search <search text> [--amount <N>] Search the Catalog by text. With no search text, returns the Catalog without a text filter.

Show Current Search Page !search-show Show the current page of the current Catalog/search results.

Search Top Rated !search-rating [<rating>] [--amount <N>] List replays by rating. 0 is unrated; 1-4 select average rating bands 1.0-4.9; 5 selects a 5.0 average. Without a rating, rated replays are returned ordered by average rating.

Leaderboard - Creator !creator-leaderboard [<period>] [--amount <N>] Show the creator leaderboard.

Name Replay !name-clip <replay number> <replay title> | !rename-clip <replay number> <replay title> Give a Catalog replay a custom title. Custom titles must be unique, ignoring case. The physical video file is not renamed.

Play History !play-history <history item> Play an item from the Last Played history.

List Recent !search-recent [--amount <N>] Show recently captured or added replays. This is different from Last Played.

Scan Replay Folder !scan-replay-folder Scan the configured Replay Folder and add replay files that are not already in the Catalog.

Show Replay Leaderboard !clip-leaderboard Show replay playback activity.
02Create Clip

Create Kick Clip !create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>] Request a Kick clip through the KickBot workflow. Kick chat only.

Create Twitch Clip !twitch-clip [<duration>] [<title>] | !twitchclip [<duration>] [<title>] | !create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>] Create a Twitch clip. Twitch chat only. Duration is 5-60 seconds.

Create YouTube Clip !create-clip [<duration>] [<title>] | !createclip [<duration>] [<title>] Create a timestamped clip from the current YouTube live broadcast. YouTube chat only.

Save Replay !savereplay | !save-replay | !clip-local | !cliplocal Tell OBS to save the current Replay Buffer. What happens next depends on Replay Source and Playlist settings.
03Message

Overlay Message !overlay-message <message> | !rts-message <message> Send a message directly to the RTS overlay using the configured Message Behaviour.
04Playback

Playback History !recently-played [--amount <N>] | !last-played [--amount <N>] Show the most recently played replays.

Screen Position !player-pos <position tag> [<duration ms>] | !player-position <position tag> [<duration ms>] Move the player to a saved position. Use the saved position tag, not the display name.

Hide Player !hide-player | !player-hide Hide the current player without deleting or resetting the replay.

Pause !video-pause | !player-pause Pause the current video.

Play !video-play | !player-play Resume the current video.

Set Speed !set-speed <playback speed> | !player-speed <playback speed> | !clip-speed <playback speed> Change playback speed. Accepted range is 0.25 to 4.0.

Show Player !show-player | !player-show Show the current player and resume the current video.
05Playlist

The Playlist is the live playback queue and is separate from the Catalog and playback history.

List Playlist !playlist Show the current Playlist.

Play Replay !play-clip <replay number> | !play-replay <replay number> Add a replay to the Playlist. A replay can be selected by Catalog/search result number, custom title, or platform and user search context.

Playlist - Clear !playlist-clear | !playlistclear Remove waiting items while leaving the currently playing item alone.

Playlist - Clear All !playlist-clearall | !playlistclearall Remove everything from the Playlist without stopping a replay already playing.

Playlist - Pause !playlist-pause | !playlistpause Pause automatic Playlist progression without stopping the current video.

Playlist - Remove !playlistremove <playlist item> | !playlist-remove <playlist item> Remove a waiting item by its Playlist position. The currently playing item cannot be removed.

Playlist - Resume !playlistresume | !playlist-resume Resume Playlist progression. If nothing is playing and queued items exist, Resume starts the next item.

REVIEWS

What people think.

Loading reviews...

YOUR REVIEW

Checking sign-in...