Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions psprecomp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ see [Prerequisites](#prerequisites).
## Quickstart

The build for the current target is scripted in `games/dissidia/tools/`. You need your own copy of
the game as an `.iso` or `.cso`; no game data ships with this repo. The steps (Steam Deck and Linux PC) are in the
top-level README: [Install and play](../README.md#install-and-play).
the game as an `.iso` or `.cso`; no game data ships with this repo. Players use the setup app (top-level README:
[Install](../README.md#install)); building from a checkout is [Building from source](../README.md#building-from-source) there.

`pipeline.sh` builds the Rust recompiler, rebuilds the analysis from the shipped metadata (or runs
Ghidra with `--ghidra <dir>`), recompiles the EBOOT and its overlays, and builds the runtime with
Expand Down
3 changes: 2 additions & 1 deletion psprecomp/games/dissidia/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

The Dissidia-specific part of the PSPRecomp fork: manifests, runtime hooks, the setup and build scripts, the modding tools, the Blender add-on and the Move Studio. No game data is included.

**Installing and playing** is in the [top-level README](../../../README.md#install-and-play). Everything else is in [docs/](docs/README.md).
**Installing and playing** is in the [top-level README](../../../README.md#install) (the setup app); building from a checkout is
[Building from source](../../../README.md#building-from-source) there. Everything else is in [docs/](docs/README.md).

## What's here

Expand Down
18 changes: 12 additions & 6 deletions psprecomp/games/dissidia/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@
Everything about the game itself, the native build and the modding tools, in one place. Paths in these docs are relative to `psprecomp/games/dissidia/` unless they say otherwise.

## Start here
- [The top-level README](../../../../README.md#install-and-play): install and play (Steam Deck, Linux PC). The install steps are written there only.
- [steamdeck.md](steamdeck.md): the Steam Deck in detail (`deck_setup.sh`, Steam entry, controls, troubleshooting).
- [The top-level README](../../../../README.md#install): install and play with the setup app (Windows, Linux, Steam Deck, Android);
[building from source](../../../../README.md#building-from-source).
- [installer.md](../../../docs/installer.md): design of the setup app, releases and update checks.
- [android.md](../../../docs/android.md): Android: the setup app, building on the phone, what runs on the device, how the APK is put together.
- [steamdeck.md](steamdeck.md): the Steam Deck in detail (Game Mode, controls, performance, the from-source `deck_setup.sh` route, troubleshooting).
- [native-build.md](native-build.md): what each setup step does, the work folder, every runtime option (window, scaling, input, camera).
- [settings-menu.md](settings-menu.md): the in-game Settings screen (from the title, start and pause menus): every page and row.
- [frame-rate.md](frame-rate.md): frame rates above 30 (any multiple of 30 up to 240): how the game paces itself and what was patched.
- [loose-file-mods.md](loose-file-mods.md): how loose files replace `PACKAGE.BIN` entries, the model size budget, package index internals.
- [texture-packs.md](texture-packs.md): HD texture replacement: dumping, upscaling, the built-in upscaler.
- [texture-packs.md](texture-packs.md): HD texture packs (LiinkPK's and the AI upscaled one): loading, dumping, upscaling.
- [multiplayer.md](multiplayer.md): Communications mode over UDP (LAN, one machine, internet), options, how the ad-hoc stack is emulated.
- [savedata.md](savedata.md): saves between regions: `savemgr` list / import / export.
- [cloud-sync.md](cloud-sync.md): saves between devices through a folder, WebDAV or Google Drive.
- [frame-rate.md](frame-rate.md): native 60 fps battles (how the game paces itself, what was patched), and the in-game settings menu.
- [testing.md](testing.md): the battle test harness, frame-rate parity tests, testing on a phone or a Deck.

## Making characters
Short guides next to the tools, and the full reference here:
Expand All @@ -26,10 +31,11 @@ Short guides next to the tools, and the full reference here:
- [spawned-objects.md](spawned-objects.md): the `wpnp` table and the objects `hold_prop` / `summon_object` spawn (Gilgamesh's swords, Yuna's aeons).
- [effects.md](effects.md): how the game draws effects (placement, timing, colour and blending, every component), and corrections to the FEP notes.
- [audio.md](audio.md): extra BGM tracks, voice banks.
- [recomp-status.md](recomp-status.md): how the native build came together, and soak-test findings.
- [recomp-status.md](recomp-status.md): how the native build came together (October 2026), and soak-test findings. Historical.
- [character-lighting.md](character-lighting.md): live key and rim lighting on character bodies in the native build (`body.lighting`).
- [spring-bones.md](spring-bones.md): how the game swings capes, hair, skirts and weapon chains, and giving a mod character a physics cape.
- Custom effect shaders are an engine feature: [psprecomp/FX_SHADERS.md](../../../FX_SHADERS.md).
- Engine docs: [ARCHITECTURE](../../../ARCHITECTURE.md), [DEBUGGING](../../../DEBUGGING.md), [ENV_FLAGS](../../../docs/ENV_FLAGS.md), [GRAPHICS](../../../docs/GRAPHICS.md), [TROUBLESHOOTING](../../../docs/TROUBLESHOOTING.md).
- Engine docs: [ARCHITECTURE](../../../ARCHITECTURE.md), [DEBUGGING](../../../DEBUGGING.md), [ENV_FLAGS](../../../docs/ENV_FLAGS.md), [GRAPHICS](../../../docs/GRAPHICS.md), [VULKAN_PORT](../../../docs/VULKAN_PORT.md), [TROUBLESHOOTING](../../../docs/TROUBLESHOOTING.md).

## Archive
Dated investigations kept for the record:
Expand Down
14 changes: 7 additions & 7 deletions psprecomp/games/dissidia/docs/frame-rate.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# 60 fps and the settings menu
# Frame rates above 30 (60, 90, 120 ... 240 fps)

## Using it

- **Settings menu**: Esc or F1 on a keyboard, Guide or L3 + R3 (both stick buttons) on a pad. The game pauses while it
is open. Rows: Display (Fullscreen / Window), Window Size (a whole multiple of 480x272, or 1280 x 800, the Deck's
screen, when the desktop is big enough; in fullscreen it is remembered for Window mode), Render Scale (1x to 4x),
Frame Rate (30 / 60), FPS Counter (a small transparent frames-per-second number in the top-right corner; saved as
`fps_counter`, `PSPRECOMP_FPS_COUNTER=1` turns it on without the menu), Quit Game (press twice). Left / right changes a value, Cross cycles it, Circle or Start closes.
It is drawn from the game's own menu textures, like the save dialog.
- **Settings menu** (all pages and rows: [settings-menu.md](settings-menu.md)): Esc or F1 on a keyboard, Guide or L3 + R3
(both stick buttons) on a pad, or the Settings row in the title screen, start menu and battle pause menu. The game
pauses while it is open. **Frame Rate** is any multiple of 30 up to 240; the default follows the display's refresh
rate (60 on a 60 Hz screen, 90 on the OLED Steam Deck, 120 on a 120 Hz one). Menus stay at 30, battles run at the
chosen rate. **FPS Counter** shows a small frames-per-second number in the top-right corner (saved as `fps_counter`,
`PSPRECOMP_FPS_COUNTER=1` turns it on without the menu).
- **Debug page**: L / R (shoulder buttons), or Q / E / Tab on a keyboard, switches between System and Debug:
- Performance Overlay: for debugging. Frames per second, average and worst frame time over the last half second,
presents per second (a gap to the fps means the presenter runs without new game frames), render scale and process
Expand Down
6 changes: 3 additions & 3 deletions psprecomp/games/dissidia/docs/native-build.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# The native build in detail

How the three setup steps work, the work folder, and every runtime option (window, scaling, render resolution, input, camera). The short install steps are in the [top-level README](../../../../README.md#install-and-play); the Steam Deck walkthrough is [steamdeck.md](steamdeck.md). Paths are relative to `psprecomp/games/dissidia/`.
How the three setup steps work, the work folder, and every runtime option (window, scaling, render resolution, input, camera). Players install with the setup app ([top-level README](../../../../README.md#install)), which runs these same steps for them; the short from-source steps are in [Building from source](../../../../README.md#building-from-source), and the Steam Deck walkthrough is [steamdeck.md](steamdeck.md). Paths are relative to `psprecomp/games/dissidia/`.

## What each step does

You need your own copy of the game, a 64-bit Linux PC or a Steam Deck, about 8 GB of free disk space, and patience:
the first build takes a long time (tens of minutes to hours). The steps, for the Deck and for a Linux PC, are in the
top-level README: [Install and play](../../../../README.md#install-and-play). Steam Deck details (Steam, controls,
the first build takes a long time (tens of minutes to hours). The from-source steps for a Linux PC or a Mac are in the
top-level README: [Building from source](../../../../README.md#building-from-source); for the Deck, [`docs/steamdeck.md`](steamdeck.md). Steam Deck details (Steam, controls,
display, troubleshooting): [`docs/steamdeck.md`](steamdeck.md).

On a Linux PC or a Mac, `tools/install.sh <game.iso> [workdir]` does all of it in one go: the build tools (apt or Homebrew,
Expand Down
7 changes: 7 additions & 0 deletions psprecomp/games/dissidia/docs/recomp-status.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Native build (static recompilation): history and findings

> **Historical.** This is a dated log of October 2026; its "Where it stands" and "Next" parts describe the state then.
> For the current state see the top-level README and the release notes on the Releases page.

How the native build came together, from the first code census to the first battle, and the soak-test findings after. How to build and run it today: [../README.md](../README.md). Engine internals: [psprecomp/ARCHITECTURE.md](../../../ARCHITECTURE.md) and [psprecomp/DEBUGGING.md](../../../DEBUGGING.md).

- [Dissidia 012 static recompilation (2026-10-15)](#dissidia-012-static-recompilation-2026-10-15)
Expand Down Expand Up @@ -75,6 +78,10 @@ Three more runtime bugs stood between the finite matrices and a picture: (1) the
2. Packaging for Steam Deck (SDL2/OpenGL build, data from the user's own ISO via `setup_from_iso.py` + `pipeline.sh`; untested end to end on a Deck).
3. Upstream the generic bits — none are Dissidia-specific.

Outcome (November 2026): 1 is done (the batched GPU-skinning renderer and the Vulkan
backend replaced the CPU vertex path as the default) and so is 2 (the setup app for Windows, Linux, Steam Deck and
Android, and `deck_setup.sh`); 3, upstreaming the generic recompiler and runtime fixes to PSPRecomp, is still open.

### Tooling notes
- Ghidra in the Claude VM on the Mac (arm64 Linux): built the missing decompiler from source; Ghidra 12 scripts are Java. PSPRecomp pins Ghidra 12.0.2 + allegrex v21.3, but 12.1.3 + v21.4 works.
- Runtime needs cargo, JDK 21, cmake, SDL2 dev, OpenGL; headless: `xvfb-run` + `LIBGL_ALWAYS_SOFTWARE=1`. Run with `PSPRECOMP_DISC0=<extracted iso> PSPRECOMP_MS0=<memory stick dir> PSPRECOMP_CROSS_MID=1 PSPRECOMP_CLEANROOM=1`; debug socket on TCP 9999 (`I` state, `B` buttons, `S` screenshot); `PSPRECOMP_HLE_TRACE=1` logs every OS call.
Expand Down
Loading
Loading