Creator Docs

Spritesheets

A spritesheet is one picture that holds many small pictures, called frames. RouteVN Creator shows the frames one after another, so they move. Use spritesheets for small animations, such as a blinking arrow or a waving flag.

A small character turns around again and again. It shows the front, the side, the back, and the side again.

You can make a spritesheet in the app from your own pictures. You can also add spritesheet files: one PNG file and one JSON file.

The whole Spritesheets page on a phone. The Default folder has 2 spritesheets, Makkuro Turn and Chibi Makkuro. The whole Spritesheets page on desktop. The Default folder has 2 spritesheets, Makkuro Turn and Chibi Makkuro. On the right are the preview and details of Chibi Makkuro.

Words to know

  • Frame: One small picture in the spritesheet.
  • Clip: One animation in the spritesheet, such as spin. A spritesheet can have many clips. Some places in the app call clips Animations.
  • FPS: Frames per second. It is the speed of a clip. A bigger number plays faster.
  • Spritesheet JSON: A file that says where each frame is, and which frames make each clip. It goes together with the PNG file.

Open the Spritesheets page

  1. Open your project. See Projects.

  2. Go to the Spritesheets page.

    • Phone or tablet: Tap Assets in the bottom bar. Then tap Spritesheets under Animated Assets.
    • Desktop: In the far left bar, click the Animated Assets button, below the Assets button. Then click Spritesheets.
    The list of pages on a phone, opened from the Assets tab. Spritesheets under Animated Assets is marked. The list of Animated Assets pages on desktop. The Animated Assets button in the far left bar and Spritesheets in the list are marked.

The Spritesheets page opens. New spritesheets go in the Default folder. To make more folders, see File Explorer.

Make a spritesheet from pictures

You need one picture for each frame. PNG, WebP, and JPEG pictures work. This example makes Makkuro Turn from 3 pictures of a small character.

  1. Next to the Default folder, tap Add. The Add Spritesheet box opens.

  2. In Name, type Makkuro Turn.

  3. Check that Source says Empty.

  4. Tap Add Spritesheet, at the bottom right of the box.

    The Add Spritesheet box on a phone. Name says Makkuro Turn. Source, which says Empty, and the Add Spritesheet button are marked. The Add Spritesheet box on desktop. Name says Makkuro Turn. Source, which says Empty, and the Add Spritesheet button are marked.

The empty spritesheet appears in the Default folder. Next, open it in the spritesheet editor.

Open the spritesheet editor

Open the spritesheet in the editor.

  • Phone or tablet: Tap the spritesheet. A panel opens at the bottom of the screen. Tap Open.
  • Desktop: Double-click (click twice quickly) the spritesheet. You can also right-click (click with the right mouse button) it, and then click Open.
The panel for Makkuro Turn at the bottom of the Spritesheets page on a phone. The Open button is marked.

The spritesheet editor opens.

Parts of the spritesheet editor

The empty spritesheet editor on a phone. Number 1 marks the back button, 2 the undo and redo buttons, 3 the preview, 4 Frame Size and FPS, 5 the Add Pictures button, and 6 the list of frames. The empty spritesheet editor on desktop. Number 1 marks the back button, 2 the undo and redo buttons, 3 the preview, 4 Frame Size and FPS, 5 the Add Pictures button, and 6 the list of frames.
The numbers match the list below.
  1. Back button: Goes back to the Spritesheets page. Your changes save by themselves.
  2. Undo and redo: Undo the last change, or bring it back.
  3. Preview: Plays the clip again and again. Tap Pause to stop it. Tap Play to start it again.
  4. Frame Size and FPS: The size of the frames, and the speed of the clip.
  5. Add Pictures: Adds pictures as frames.
  6. Frames: The list of frames. The clip plays them from top to bottom.

Add frames

  1. Tap Add Pictures. A window opens, so you can choose files.
  2. Choose your pictures. You can choose many pictures at once.

The pictures appear at the end of the list, one frame for each picture. The preview plays them.

The spritesheet editor on a phone with 3 frames: chibi makkuro 1, 2, and 3. Each frame has a Hold box and a three dots button. The spritesheet editor on desktop with 3 frames: chibi makkuro 1, 2, and 3. The preview shows the small character.

On desktop, you can also drag picture files onto the list of frames.

Put the frames in order

  1. Next to a frame, tap the three dots button (the button with three dots that opens more options). A menu opens.

  2. Tap Move Up or Move Down.

    The menu of the second frame on a phone. Move Up and Move Down are marked. The menu of the second frame on desktop. Move Up and Move Down are marked.

On desktop, you can also drag (hold, then move) a frame up or down the list.

Change the speed

FPS is the speed of the whole clip. A new clip plays at 12 FPS.

  1. Tap the box under FPS. A small box opens, with a slider.

  2. Type a number from 1 to 120, such as 8. You can also drag the slider.

  3. Tap Submit.

    The small box for FPS on a phone, with a slider and the number 12. The Submit button is marked. The small box for FPS on desktop, with a slider and the number 12. The Submit button is marked.

To show one frame longer, change its Hold the same way. Hold can be 1 to 99. For example, Hold 2 shows the frame twice as long as Hold 1.

Delete a frame

  1. Next to the frame, tap the three dots button.
  2. Tap Delete.

To get the frame back, tap the undo button. A spritesheet needs at least one frame. The editor cannot save an empty list.

Add spritesheet files

Use this when you already have a PNG file and a JSON file. This example uses Chibi Makkuro, a small character with 4 frames and 2 clips.

  1. Next to the Default folder, tap Add. The Add Spritesheet box opens.

  2. Tap the box under Source. Then tap From Spritesheet Files. PNG File and JSON File appear.

  3. Next to PNG File, tap Choose File. Choose the PNG file.

  4. Next to JSON File, tap Choose File. Choose the JSON file.

    If Name is empty, the app fills it in with the file name.

    The Add Spritesheet box on a phone. Source says From Spritesheet Files, and both files are chosen. Source and the 2 Choose File buttons are marked. The Add Spritesheet box on desktop. Source says From Spritesheet Files, and both files are chosen. Source and the 2 Choose File buttons are marked.
  5. Tap Add Spritesheet.

The spritesheet appears in the Default folder.

Change a spritesheet from files

You can open these spritesheets in the editor too. A spritesheet from files can have many clips. The editor shows one clip at a time.

  1. Open the spritesheet in the editor. See Open the spritesheet editor.

  2. Tap the box under Clip. Then tap a clip, such as look around.

    The spritesheet editor on a phone with Chibi Makkuro open. The box under Clip, which says spin, is marked. The spritesheet editor on desktop with Chibi Makkuro open. The box under Clip, which says spin, is marked.

The frames, FPS, and preview change to that clip.

When you only change the order, Hold, or FPS, the app keeps your PNG and JSON files. When you add pictures, the app makes a new spritesheet picture from the frames. The animation looks the same.

Change the details of a spritesheet

  1. Tap the spritesheet.

  2. Tap the pencil icon next to its name. The Edit Spritesheet box opens.

    The panel for Chibi Makkuro at the bottom of the Spritesheets page on a phone. The pencil icon next to the name is marked. The details of Chibi Makkuro on desktop. The pencil icon next to the name is marked.
  3. Change what you need, such as the name or the files.

  4. Tap Update.

If you choose a new JSON file, keep the same clip names. Layouts find their clip by its name.

Where you use spritesheets

Good to know

  • Delete removes a spritesheet right away. The app does not ask first.

Problems and fixes

  • The app says "Leave without saving?" The editor could not save. Tap Stay, and do what the message says. For example, add a picture.
  • The app says "Cannot delete resource, it is currently in use." Remove the spritesheet from every layout, scene, and control first.

Next steps