Skip to content

EverestAPI/CelesteTAS-EverestInterop

Repository files navigation

Celeste TAS

Advanced TAS tools for Celeste / Everest

Quick Start

To get started with TASing Celeste, you first need to make sure the Everest Mod Loader is installed and up-to-date.
After that you want to install the CelesteTAS mod, either by searching for in Olympus under "Download Mods" or by simply using the 2-click-installer.

If you now launch the game, Celeste Studio, our own purpose-built TAS editor, should've been installed automatically. On the main menu, you can go into the Mod Settings and under Celeste TAS > More Options you will find an option called Launch Studio at Boot. If you enable that setting, it should automatically open now, and also every time alongside the game being opened.
If you wish to manually open it, you can find the program in the CelesteStudio folder inside your Celeste install.
You can find the documentation about Celeste Studio here. It is strongly recommended to at least check out the available keyboard shortcuts which Studio offers.

Now both CelesteTAS and Celeste Studio are set up!

Depending on what you're planning to do with CelesteTAS, consider following on of these guide on how to get started:

Important

If you want know how something works, please first check if it is documented on the CelesteTAS Wiki. It contains both information about the tooling with CelesteTAS and Celeste Studio, but also references on how certain mechanics work to better understand them while TASing. The wiki is free for anyone (who has a GitHub account) to contribute to, so if you feel like something is missing, wrong or just worded weirdly, don't shy away from editing it!

If you're stuck with a problem which isn't described in the wiki, consider joining the Celeste Discord and asking in the #tas_general channel in the TASing category.

Using Development versions

Using the latest development version of CelesteTAS allows you to use cutting-edge features before the public release.
Do note however, that it should be expected for certain features to broken / have issues, so please make sure to properly report any oddities as mentioned below.

You can install the latest development version from here.

Providing Feedback

If you encounter any issues / oddities with the tools, would like to suggest a feature idea or just provide feedback in general, you have a few options on making your voice heard:

Make sure to try to include as much information about the topic as you have available (include log files, videos, etc.)!

Building CelesteTAS yourself

If you just want to use CelesteTAS and not modify it, you can skip this section.

To build CelesteTAS yourself, you just need to (recursively!) clone this repository into your Mods folder and then inside the repository's root run dotnet build. Alternatively you can open the solution in your favourite C# IDE. Note that the .NET 9 SDK or higher is required.

Contributing

If you want to contribute to CelesteTAS or Celeste Studio (not the wiki, that is separate!), simply open a Pull Request with your desired changes.
If you can't code you can still contribute by, for example, translating CelesteTAS into your language. (See CelesteTAS-EverestInterop/Dialog for dialog files).

Credits

Many people have helped to bring CelesteTAS and the tools surrounding it into the amazing state they currently are. This list just highlights a few which have played a big role, but that doesn't mean other smaller contributions aren't appreciated!

  • Kilaye (@kilaye on Discord): Developer of libTAS and among the first TASers of the game.
  • DevilSquirrel (@devilsquirrel on Discord): Started development of the CelesteTAS project in 2018 and maintained it for the first year.
  • 0x0ade (@0x0ade on Discord): Helped with porting the mod to the Everest mod-loader, to avoid having to manually patch the game and allow for improved mod compatibility
  • EuniverseCat (@eunidiscriminator0317 on Discord): Occasional but active contributor the project from 2019 to 2023
  • DemoJameson (@demojameson on Discord): Maintainer of the project from 2020 to 2024, massively pushing it forward with new features and improvements
  • psyGamer (@psygamer on Discord): Current maintainer of the project since 2024, reworking Studio to be cross-platform and in general trying to modernize and improve the project.

Additional Tools

  • Speedrun Tool: Provides savestate functionally to CelesteTAS to easily get back to a certain spot in the TAS without having to wait.
  • TAS Recorder: Create high quality fixed framerate video recordings of your TAS.
  • TAS Helper: Additional features which don't fit into the main CelesteTAS mod, but are still very useful while TASing.
  • GhostModForTas: Compare new TASes with old ones.
  • Jadderline (integrated into Studio under Tools): Simple tool to generate inputs for a Jelly Ladder from a certain stating condition.
  • Featherline (integrated into Studio under Tools): Genetic algorithm to attempt to generate optimal inputs for feather movement.
  • Radeline Simulator (integrated into Studio under Tools): Attempts to get the player into a desired specific position by brute-forcing input combinations.
  • Radeline Optimizer: Chaos monkey that optimizes a Celeste TAS by randomly (or sequentially) changing inputs.
  • Lobby Router: Helps find the fastest route for a collab lobby