starred/overdrive
1
0 Fork 0
mirror of https://github.com/MyLuxy/overdrive.git synced 2026-10-19 02:10:55 -05:00
Code Issues Packages Projects Releases 3 Wiki Activity

feat: readme with install guide

Browse Source
This commit is contained in:
MyLuxy committed 2026-10-14 05:19:40 +02:00
1 parent 32422ca811
commit f4140b8d54
11 files changed
+297 -45
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+244 -45
View File
@@ -1,29 +1,227 @@
# Overdrive
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset=".github/readme/logo-dark.svg">
<img src=".github/readme/logo-light.svg" alt="Overdrive" width="440">
</picture>
</p>
Overdrive is a game-store front end for the PS5 (title id `PPSA99058`). This
repository holds a source reconstruction of the released application and the
tooling that builds it, so it can be changed and rebuilt.
<p align="center">
<b>Your PS5 game store.</b><br>
Back from the dead, rebuilt from its own binary, with every line of source in the open.
</p>
## Layout
<p align="center">
<a href="https://github.com/MyLuxy/overdrive/releases/latest"><img src="https://img.shields.io/github/v/release/MyLuxy/overdrive?style=for-the-badge&label=release&labelColor=0b0b0d&color=2a2a2f" alt="Latest release" width="197"></a>
<a href="https://github.com/MyLuxy/overdrive/releases"><img src="https://img.shields.io/github/downloads/MyLuxy/overdrive/total?style=for-the-badge&label=downloads&labelColor=0b0b0d&color=2a2a2f" alt="Downloads" width="183"></a>
<img src="https://img.shields.io/badge/platform-PS5-2a2a2f?style=for-the-badge&labelColor=0b0b0d" alt="Platform: PS5" width="184">
</p>
<p align="center">
<a href="#install-in-four-steps">Install</a> ·
<a href="#features">Features</a> ·
<a href="#updates">Updates</a> ·
<a href="#troubleshooting">Troubleshooting</a> ·
<a href="#build-it-yourself">Build it yourself</a>
</p>
> [!NOTE]
> The original Overdrive project has been shut down so I decompiled the last released build,
> recovered the complete source and rebuilt it.
<p align="center">
<img src=".github/readme/discover.jpg" alt="Overdrive's Discover page, with a featured game and the Popular now row" width="100%">
</p>
<p align="center">
<img src=".github/readme/browse.jpg" alt="Browse library: 1,845 games with filters, sorting, scores and sizes" width="49.5%">
<img src=".github/readme/downloads.jpg" alt="Downloads page with activity and storage for internal storage and a USB drive" width="49.5%">
</p>
## Features
- **1,800+ games** to discover, with **Top rated**, **New releases** and a featured spotlight
- **Browse the whole library** with filters, sorting, scores and download sizes at a glance
- **Downloads straight to the console**, to internal storage or any USB drive, with live speed and storage stats
- **Favorites**, **search** with an on-screen keyboard, and a **Files** page to see and clean up what's on your drives
- **13 languages**: English, Deutsch, Español, Français, Português (Brasil), Русский, Bahasa Indonesia, 日本語, 简体中文, العربية, اردو, हिन्दी, বাংলা
- **Updates itself**: a new version installs from the console, no PC needed
- Made for the controller: <kbd>L1</kbd> <kbd>R1</kbd> to switch sections, <kbd>✕</kbd> to select, <kbd>○</kbd> to go back
## Install in four steps
<p align="center">
<img src=".github/readme/install-steps.svg" alt="1 Download Overdrive.exfat · 2 Copy it into a homebrew folder on a USB drive · 3 Plug it in: ShadowMount+ installs it · 4 Play" width="100%">
</p>
### Before you start
You need a **jailbroken PS5** running **[ShadowMount+](https://github.com/drakmor/ShadowMountPlus)**,
the payload that installs `.exfat` images by itself. If ShadowMount+ shows its notification
when the console starts, you are ready. You also need a **USB drive** and a **PC**.
<p align="center">
<a href="https://github.com/MyLuxy/overdrive/releases/latest/download/Overdrive.exfat"><img src="https://img.shields.io/badge/Download-Overdrive.exfat-f2f2f3?style=for-the-badge&labelColor=0b0b0d" alt="Download Overdrive.exfat" width="347"></a>
</p>
<table>
<tr>
<td width="64" align="center" valign="top"><img src=".github/readme/step-1.svg" alt="1" width="40"></td>
<td>
**Download `Overdrive.exfat`** with the button above, or from the
[latest release](https://github.com/MyLuxy/overdrive/releases/latest). It is the only file you
need. Leave it as it is: don't unzip it and don't change the `.exfat` at the end of its name.
</td>
</tr>
<tr>
<td align="center" valign="top"><img src=".github/readme/step-2.svg" alt="2" width="40"></td>
<td>
**Copy it onto a USB drive, inside a folder called `homebrew`.** Plug the drive into your PC,
create a new folder named exactly `homebrew` (all lowercase) at the top level of the drive, and
copy `Overdrive.exfat` into it:
```text
USB drive
└── homebrew
└── Overdrive.exfat
```
The drive must be formatted as **exFAT**, which is how most drives come and what the PS5 reads.
</td>
</tr>
<tr>
<td align="center" valign="top"><img src=".github/readme/step-3.svg" alt="3" width="40"></td>
<td>
**Plug the drive into the PS5.** ShadowMount+ checks for new files every few seconds: it finds
Overdrive, mounts it and installs it, and a notification tells you when it's done. There is
nothing to click.
</td>
</tr>
<tr>
<td align="center" valign="top"><img src=".github/readme/step-4.svg" alt="4" width="40"></td>
<td>
<img src="app/sce_sys/icon0.png" alt="Overdrive's icon" width="64" align="right">
**Open Overdrive from the home screen.** Look for this icon. Enjoy!
</td>
</tr>
</table>
You can also use **any FTP client** to move the file onto the console's internal storage
instead, again inside a `homebrew` folder: `/data/homebrew/Overdrive.exfat`.
## Updates
You only install Overdrive by hand once. When a new version comes out, the app tells you by
itself a few seconds after it opens:
1. A window shows the new version and what changed. Press **Install**.
2. Overdrive downloads the update, checks it and puts it in place of the old one.
3. When it's done, the app **closes itself**. Open it again and you are on the new version.
The update needs about **600 MB free** on the drive that holds Overdrive. `update.zip` in each
release is the package the app downloads for this; you never need it yourself.
## Troubleshooting
<details>
<summary><b>Overdrive doesn't appear on the home screen</b></summary>
<br>
- Make sure **ShadowMount+ is running**: it shows a notification when it starts.
- Check the folder: it must be called exactly `homebrew` and sit at the **top level** of the
drive, not inside another folder.
- Check the file still ends in **`.exfat`**. Some PCs hide extensions: a file renamed to
`Overdrive.exfat.zip` or unzipped into a folder won't be found.
- Give it a minute: ShadowMount+ waits until the file has finished copying before it installs it.
</details>
<details>
<summary><b>After an update, the app still shows the old version</b></summary>
<br>
The new version is installed but the console still has the old one loaded. **Restart the
console** and open Overdrive again; the app tells you this itself if it happens twice in a row.
</details>
<details>
<summary><b>The update says there isn't enough space</b></summary>
<br>
The update is downloaded next to the installed app, so the drive holding Overdrive needs about
600 MB free. Free some space on that drive and press **Retry**. Nothing has been changed yet
when this happens.
</details>
<details>
<summary><b>The update says it couldn't replace the app</b></summary>
<br>
Install it by hand: download `Overdrive.exfat` from the
[latest release](https://github.com/MyLuxy/overdrive/releases/latest), close Overdrive, and copy
the new file over the old one in the `homebrew` folder.
</details>
<details>
<summary><b>How do I remove Overdrive?</b></summary>
<br>
Delete `Overdrive.exfat` from the `homebrew` folder first, then delete its icon from the home
screen. In the other order ShadowMount+ finds the file again and puts the icon back.
</details>
## Build it yourself
<details>
<summary><b>What's in this repository</b></summary>
<br>
| Path | What it is |
| --- | --- |
| `app/` | The application: JSX sources, state, assets, catalog data, and `app.json` (title id, version, capabilities) |
| `app/` | The application: JSX sources, state, assets, catalog data, and `app.json` (title id `PPSA99058`, version, capabilities) |
| `ps5-react/` | The framework it runs on, vendored from [half144/ps5-react](https://github.com/half144/ps5-react) |
| `packaging/make-exfat.sh` | Builds the exFAT image `ShadowMount+` installs |
| `packaging/make-exfat.sh` | Builds the exFAT image ShadowMount+ installs |
| `.github/workflows/build.yml` | The build |
## Building
</details>
Every push builds on `ubuntu-24.04` with clang 18 and uploads `Overdrive.exfat`
as a workflow artifact; a `v*` tag also publishes a release carrying `Overdrive.exfat`
(the image, to copy by hand) and `update.zip` (the same image alone,
which is what the app's updater fetches for an image install).
<details>
<summary><b>How the source was recovered</b></summary>
<br>
The same build locally, on any Linux with the packages the workflow installs
(`clang-18`, `llvm-18`, `cmake`, `ninja-build`, `nodejs`, `npm`, `zlib1g-dev`,
`build-essential`, `pkg-config`, `unzip`, `curl`, `exfatprogs`, and Pillow from
`ps5-react/requirements.txt`):
Overdrive is a React app running on [ps5-react](https://github.com/half144/ps5-react), and its
whole JavaScript bundle sits in plain text inside `eboot.bin`. A bundler merges every module into
one scope, so imports between modules turn into bare names; since each top-level name stays
unique, the module that declares a name can be worked out again. That split the bundle back into
its 137 original modules with their real `import`/`export` lines, checked against the original
bundle until every import edge matched.
What a bundler throws away could not come back: most comments, the JSX syntax (it reads as
`jsx(View, {…})` calls), and `const`/`let` (now `var`). None of that changes how the app behaves.
</details>
<details>
<summary><b>Building</b></summary>
<br>
Every push builds on `ubuntu-24.04` with clang 18 and uploads `Overdrive.exfat` as a workflow
artifact; a `v*` tag also publishes a release with `Overdrive.exfat` and `update.zip`.
The same build locally, on any Linux with the packages the workflow installs (`clang-18`,
`llvm-18`, `cmake`, `ninja-build`, `nodejs`, `npm`, `zlib1g-dev`, `build-essential`,
`pkg-config`, `unzip`, `curl`, `exfatprogs`, and Pillow from `ps5-react/requirements.txt`):
```sh
cd ps5-react
@@ -31,43 +229,44 @@ python3 tools/build_ps5.py --app-dir ../app --llvm /usr/bin
sudo ../packaging/make-exfat.sh dist/PPSA99058 ../Overdrive.exfat
```
The build downloads its pinned dependencies into `ps5-react/.deps` and writes
the app folder, a `.zip` and a `.receipt.json` into `ps5-react/dist`. It verifies
the result itself (`tools/verify.py`), so a green build means the payload
structure and signatures check out.
The build downloads its pinned dependencies into `ps5-react/.deps` and writes the app folder, a
`.zip` and a `.receipt.json` into `ps5-react/dist`. It verifies the result itself
(`tools/verify.py`), so a green build means the payload structure and signatures check out.
`--llvm /usr/bin` points it at the system clang; upstream defaults to the Homebrew LLVM path
because macOS is its supported development environment.
`--llvm /usr/bin` points the build at the system clang; upstream defaults to the
Homebrew LLVM path because macOS is its supported development environment.
The image is a plain exFAT volume whose root is the app folder, with 64 KiB clusters and the
label `OVERDRIVE`. To release a new version, raise the version in `app/version.js` and
`app/app.json` and push a `v*` tag: installed apps offer it on their next start.
## Fixes over upstream
</details>
Two fixes in the vendored framework, both in the build tooling and both reported
by a Linux build:
<details>
<summary><b>Fixes over upstream ps5-react</b></summary>
<br>
- `ps5-react/tools/common.py` read the `git apply --summary` line with a fixed
space count, which glued the file mode onto the path (`100644 <path>`) and made
every fresh dependency checkout fail on the first patch that creates a file.
It now splits on whitespace.
- `ps5-react/tools/build_ps5.py` opened the pinned LLVM package's `data.tar.zst`
with `tarfile`, which reads zstd only from Python 3.14 while the documented
minimum is 3.12. It now falls back to the `zstd` command.
Two fixes in the vendored framework, both in the build tooling and both reported by a Linux build:
- `ps5-react/tools/common.py` read the `git apply --summary` line with a fixed space count, which
glued the file mode onto the path (`100644 <path>`) and made every fresh dependency checkout
fail on the first patch that creates a file. It now splits on whitespace.
- `ps5-react/tools/build_ps5.py` opened the pinned LLVM package's `data.tar.zst` with `tarfile`,
which reads zstd only from Python 3.14 while the documented minimum is 3.12. It now falls back
to the `zstd` command.
Nothing else in the framework is changed.
## Installing
</details>
Copy `Overdrive.exfat` to the console and let `ShadowMount+` install
it. The image is a plain exFAT volume whose root is the app folder, 64 KiB
clusters, label `OVERDRIVE`.
## Credits
Installed, the app checks this repository's releases at startup and offers a
newer one; replacing an image install needs free space for the image plus the
update next to it. A build installed before the rename keeps looking for the old
asset names and needs one manual reinstall.
- **[MyLuxy](https://github.com/MyLuxy)**, who decompiled Overdrive, recovered its source and rebuilt it.
- **[ps5-react](https://github.com/half144/ps5-react)**, the framework it runs on.
- **[ShadowMount+](https://github.com/drakmor/ShadowMountPlus)** by drakmor, which installs it.
## Licensing
`ps5-react/` is GPL-3.0-or-later and carries its own `LICENSE`, `LICENSE-ATTRIBUTION` and
`NOTICE`. Every dependency notice is copied into `notices/` inside the built app, and
`ps5-react/docs/DEPENDENCIES.md` lists them with their sources.
`ps5-react/` is GPL-3.0-or-later and carries its own `LICENSE`,
`LICENSE-ATTRIBUTION` and `NOTICE`. Every dependency notice is copied into
`notices/` inside the built app; `ps5-react/docs/DEPENDENCIES.md` lists them with
their sources.
<sub>Overdrive is an unofficial homebrew project and is not affiliated with or endorsed by Sony
Interactive Entertainment. PlayStation and PS5 are trademarks of Sony Interactive Entertainment.</sub>