Loading...

Setup

The full guide on how to get Index OS up and running on your Playdate! It's as easy as 1, 2, 3.

  Wait a sec!
Just so you know, installing Index OS on real hardware will void your warranty, and has the potential to cause some unwanted bad stuff to happen, as would any custom stuff like this. Please read the entire setup guide carefully before proceeding, and of course...install at your own risk!!

Installer Setup

Here's a list of things you'll need before we begin:
• The Index OS Installer (get it if you haven't already!)
• A Playdate system. This installer is meant for real hardware only - please get the Core file instead if you're running a simulator.
(Also, make sure your system's on the latest 2.X firmware. The installer won't function properly on devices running OS 1.X.)
• Some way to sideload games onto your Playdate! It can be over USB, or through the Playdate sideload page.


Set it up!

After you've downloaded the Installer file, sideload the PDX onto your Playdate using your preferred method. (If you don't know how to do this, you probably shouldn't be installing this Launcher...but there's an official guide on Playdate's help page.)
Once it's on your device, start it up and follow the on-screen prompts carefully!! After it's all said and done, you'll be prompted to restart your system, and you'll be up and running on Index!


I wanna switch back!

You can switch back to the stock Launcher at any time simply by opening the installer on your device again. There, you'll have a prompt to uninstall Index (along with all it's files) - doing that will have you back to the stock Launcher lickety-split.
If you want out just for a little bit, there's a button at the bottom of the System folder that will take you back to the stock Launcher for that session. Next time you close a game, you'll be back in Index.


Catastrophe!!

Has something gone horribly awry, leaving your system in a total error loop? Fear not, you can recover safely from here! Hold down the A, B, Lock and Menu buttons until your device boots to the Playdate logo. After that, let go of A and B, but keep holding Lock and Menu!! Your device will enter recovery mode, effectively "system updating" your device to entirely-stock OS version 1.11.1.
All of your games and save data will be intact, so don't worry!, but do note that you'll have to update your system afterwards to get back to the latest version.

Core Setup

Here's a list of things you'll need before we begin:
• The Index OS Core file (get it if you haven't already!)
• A Playdate Simulator. The core file is meant for Simulators only - please get the Installer file instead if you're running on real hardware.
(Make sure you have the latest version of the SDK/Simulator.)


Set it up!

With the Index OS file in hand, navigate to path/to/PlaydateSDK/Disk/System. There, you'll find the .pdx for the stock Launcher - we strongly recommend keeping that file around in case you ever wanna switch back! Just rename it something else.
Next, drag the Index OS.pdx file into that folder, and rename it to 'Launcher.pdx'. Reset your sim, and you should be up and running on Index!


I wanna switch back!

You can switch your default back to stock at any time simply by coming back to this folder, and renaming the .pdx files. Just make sure the one you wanna use is named 'Launcher.pdx'!
If you want out just for a little bit, there's a button at the bottom of the System folder that will take you back to the stock Launcher for that session. Next time you close a game, you'll be back in Index.