You are viewing a potentially older version of this package. View all versions.
Pirateskin-StoryFrame-1.2.0 icon

StoryFrame

Framing overlay for the replay editor: Story, Reel, 4:5, square, 4:3 and 16:9 frames with safe zones.

Date uploaded 3 days ago
Version 1.2.0
Download link Pirateskin-StoryFrame-1.2.0.zip
Downloads 161
Dependency string Pirateskin-StoryFrame-1.2.0

README

StoryFrame

A framing overlay for the replay editor. Line up your shot so the clip fits a phone screen, a Story, a Reel or a feed post exactly, with nothing important hidden behind the app's own buttons.

What it does

  • Draws a centred frame in the shape you pick and softly dims everything outside it, so you can still see the replay editor UI.
  • Formats: Story 9:16, Reel / TikTok 9:16, Portrait 4:5, Square 1:1, Classic 4:3 and Wide 16:9.
  • Safe zones: red bands show where the app's profile bar, caption and buttons cover the video (9:16 formats).
  • Optional rule-of-thirds grid and centre cross for composing the shot.
  • Shows the frame size in pixels each time you change something.
  • Key legend on both sides of the frame lists every key and its options, with your current choice highlighted.
  • Scales to any resolution and keeps the exact ratio.

It only draws a guide on your screen. It does not change the game or what gets recorded.

Install

  1. Download the zip and unzip it into your ReSkate Mods folder so you end up with Mods\storyframe\.
  2. ReSkate picks new plugins up automatically. If it does not show, restart the game.

Controls

Key Action
F4 Show / hide the overlay
F2 Cycle format
F3 Cycle guides
F5 Cycle dimming: Light, Medium, Dark, Off

All keys can be rebound on ReSkate's Binds page.

Guides cycle in this order: frame only, then safe zones (default), then thirds grid, then centre cross.

How to use it

  1. Open the replay editor and press F4.
  2. Press F2 until you reach the format you are posting to.
  3. Move the camera so your skater sits inside the bright frame, in the clear area away from the red zones.
  4. Press F4 again to hide the overlay before you record.

Settings

Open plugin/main.lua in any text editor. The values at the top let you change:

  • START_FORMAT, START_DIM, START_GUIDES: what the mod starts on.
  • SHOW_BADGE: turn the small ratio label in the frame corner on or off.
  • SHOW_KEYS: turn the key legend on the sides of the frame on or off.
  • FORMATS: the safe-zone percentages for each format, or add your own format.
  • DIMS: how dark each dim level is.

The safe zones are estimates and apps change their layouts from time to time, so adjust them to taste.

Troubleshooting

  • Nothing shows: check logs/ReSkate.log for lines starting with [storyframe].
  • A key does nothing: another mod or the replay editor may be using it. Rebind it on the Binds page.
  • Overlay too dark or too light: press F5 to change the dim level.

Credits

Made by Leigh.

CHANGELOG

Changelog

1.2.0

  • Key legend on both sides of the frame showing every key and all its options, with the current choice highlighted.
  • If the frame leaves no room on the sides (e.g. 16:9 on a 16:9 screen), the legend sits inside the frame's top-left corner instead.
  • Turn the legend off with SHOW_KEYS = false in plugin/main.lua.

1.1.0

  • Lighter dimming outside the frame so the replay editor UI stays readable. New F5 key cycles Light (default), Medium, Dark and Off.
  • New F2 key cycles formats: Story 9:16, Reel / TikTok 9:16, Portrait 4:5, Square 1:1, Classic 4:3 and Wide 16:9.
  • Reel / TikTok format has its own safe zones, including the button column on the right.
  • On-screen readout shows the format, frame size in pixels, guides and dim level after any change.
  • Small ratio badge in the corner of the frame.
  • Frame border now draws inside the frame, so it stays visible when the frame fills the screen.

1.0.0

  • First release: 9:16 Story frame, safe zones, thirds grid, centre cross.