Skip to main content
awoken-recorder is the companion tool that generates the thumbnails the appearance UI uses for Image Previews. It teleports your ped onto a built-in green screen, screenshots every drawable you select, removes the background, and writes the PNGs in the exact folder layout the appearance resource expects.
You only need the Recorder if you want the image-preview UI. If you’re happy with number steppers (Config.UseImagePreviews = false), you can skip this entirely.

​
Installation

1

Add the dependency

The Recorder needs screencapture. Make sure it’s present and started before the Recorder.
2

Drop in the resource

Place awoken-recorder in your resources. Keep the folder named awoken-recorder - it self-checks its name and won’t start if renamed.
3

Ensure it

Add ensure awoken-recorder to your server.cfg (after screencapture).
Run captures on a quiet/empty server. The Recorder teleports and freezes your ped on the green screen for the duration, and a full clothing sweep takes a while.

​
Capturing images

1

Open the tool

Run /recorder. The capture UI opens with your accent colour.
2

Pick gender + categories

Choose male or female, then the categories to capture - components (clothing), props, hair, head overlays - and the specific slots within them.
3

Start the capture

Begin the run. Your ped is moved to the green screen and each selected drawable is screenshotted in turn. A progress bar tracks it.
4

Stop early if needed

Press F9 (or run /stopscreenshot) to abort. Your ped’s model, clothes and position are restored automatically when a run ends or is stopped.
Don’t alt-tab away or interfere with the game mid-capture - moving the camera or ped will spoil the screenshots for that run.

​
Output & moving the images

Captured PNGs are written to the Recorder’s own folder, already in the right structure:
awoken-recorder/images/
To use them, copy the contents of awoken-recorder/images/ into the appearance resource’s web/dist/images/ folder:
Then make sure previews are enabled:
shared/config.lua

​
Reviewing captures

The Recorder UI includes a gallery so you can browse what’s been captured for a category before moving the files - handy for spotting gaps.

​
If you get stuck

  • Stuck with a cursor and no ped/control after a run - run /reloadskin (from the appearance resource) to restore your character, or reconnect.
  • server.js errors on start - confirm screencapture is started before awoken-recorder, and that the resource folder is named exactly awoken-recorder.