Skip to content

Latest commit

 

History

History
116 lines (89 loc) · 6.5 KB

README.md

File metadata and controls

116 lines (89 loc) · 6.5 KB
Raw

Celia

A PICO-8 TAS framework based on picolove

Requires LÖVE 11.4 (LÖVE 11.x experimentally supported)

What is PICO-8:

What is LÖVE:

What Celia is:

Celia has 3 uses:

  • A general TAS tool for tasing any PICO-8 cart
  • A framework for developing designated TAS tools PICO-8 games
  • A fully fledged TAS tool for celeste and mods.

Limitations and caveats

  • Celia is based on this fork of picolove. Carts not supported by it will not work. in particular, some more advanced/newer PICO-8 features might not be avaliable (though it does have many features not present in other picolove forks, such as support for _ENV and bitwise ops).
  • Due to the last point, Celia uses floats instead of 16.16 Fixed point numbers, which may cause some differences from PICO-8
  • No support for seeding reproducing randomness deterministically (yet)
  • No support for coroutines, as they cannot be serialized in standard lua, as far as I know
  • The spritesheet and music/sfx data are not serialized as part of the state, and will not rewind correctly.
  • Right now Celia is a bit of a memory hog, consuming ~0.5MB per frame (depending on the cart). A more "traditional" savestate-based TAS tool could be created to address this issue

Usage

this is the usage for the general PICO-8 TAS tool. For usage specific to the cctas (celeste) Tas tool, see here (but make sure to read this file as well)

clone the repository, and place the cart that you want to run in the carts folder, then run

<path to your love executable> . cartname.p8 from a terminal/command line in the project root directory

In the center of the screen, you'll see the PICO-8 screen, displaying the current frame On the left, you'll see the HUD, displaying the current frame number, and an input display, with the currently pressed inputs On the right, you'll see the pianoroll, which shows the inputs in the frames around the current one

Web build

Some changes were made to make this project more compatible with web/emscripten/wasm. Right now it is a work-in-progress. For building, Davidobot's fork of love.js is used, so make sure to have the npm package for it installed.

$ npm -g install love.js
$ git clone --recursive https://github.com/gonengazit/Celia && cd Celia
$ make web
$ python -m http.server -b 127.0.0.1 -d build/__site/ # example way to host

Building on Windows should be possible as well, since the js tools are cross-platform. However without going to the lengths of installing cygwin or git bash with info-zip, the makefile recipe won't run, and you'll have to do the copying and zipping manually.

Controls

  • L - advance 1 frame forward
  • K - rewind 1 frame back
  • Left, Right, Up, Down, Z/C, X (controller buttons)- toggle the respective button for the current frame
  • Shift + controller button - toggle hold of the respective button. held buttons will be pressed when advancing/rewinding to a frame
  • D - preform a full-rewind, return to frame 0
  • P - start realtime playback. The TAS will play back in real time, and inputs can't be modified. any keypress during realtime playback will stop it.
  • Shift + R - reset, clear the inputs, and rewind to frame 0
  • M - save the current inputs to a file .lua, in the games data folder (By default, on windows this is %appdata%/love/Celia, and on linux ~/.local/share/love/Celia). The filepath will be outputted to the terminal.
  • Shift + W - Load the input file from the data folder
  • Insert - Insert a blank input frame before the current frame (This respects held keys)
  • Ctrl + Insert - Duplicate the current input frame
  • Delete - Delete the current input frame
  • Ctrl + V - paste inputs from the clipboard before the current frame
  • Ctrl + Z - perform undo. pretty much any operation that changes the inputs can be undone. max undo depth is 30
  • Ctrl + Shift + Z perform redo.
  • Shift + L - enable visual selection mode
  • Ctrl + T - toggle console
  • F3 - begin gif recording
  • F4 - stop gif recording
  • F6 - take screenshot
  • Ctrl + R - reload cart and tas tool (Warning: this cannot be undone!)

Visual selection mode

Visual selection mode allows you to perform operations on a contiguous range of inputs. The selected range will always start with the current frame (highlighted blue on the piano roll), and contain all subsequent frames (highlighted gray). You can always exit visual selection mode, by making the selection empty, or pressing ESC.

  • L - advance selection 1 frame forward
  • K - move selection 1 frame back. if the selection now only includes the current frame, exit visual selection mode.
  • ESC - exit visual selection mode
  • End - extend selection until last frame
  • Home - reduce selection to the current frame, and the next one.
  • controller button - set/unset the button for all selected frames
  • Alt + basic button - toggle the button for all selected frames
  • Ctrl + C - copy selected frames to clipboard
  • Ctrl + V - replace selection with frames pasted from clipboard
  • Ctrl + X - cut frames to clipboard

Console

Using the console, you can access and modify the variables of the PICO-8 instance. it supports standard terminal keybindings, and allows you to input and run lua code on the pico8 instance.

Warning: making changes to variables in the PICO-8 instance, then rewinding before the changes will lose the changes. It's very easy to make TASes that desync by modifying the variables of the cart, so use it carefully.

Acknowledgements

Web specific