Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
cabf1f3
Rename the command-line installer opengp-install to opengp-cli
OfficiallySp Nov 2, 2026
1d7d96d
Menu: an Open folder button instead of the folder's path
OfficiallySp Nov 2, 2026
493ea43
Menu: Back + Start held together opens it too
OfficiallySp Nov 2, 2026
94536d1
Controls: keys by the keyboard's layout in the menu
OfficiallySp Nov 2, 2026
7afac76
Video: the window's size grows with the display's scale
OfficiallySp Nov 2, 2026
ca6507f
Console: what's only for working on OpenGP needs --verbose
OfficiallySp Nov 2, 2026
9746b1a
Controls: the Enter key is Enter, not SDL's Return
OfficiallySp Nov 2, 2026
d644aa2
First run: a hint about coins, start and the menu
OfficiallySp Nov 2, 2026
f0a53f1
Installer: no deprecation warning on macOS 26
OfficiallySp Nov 2, 2026
5fd58cc
Controls: steering and pedals at full precision
OfficiallySp Nov 2, 2026
4378ba0
Controls: a pedal that hasn't reported is released
OfficiallySp Nov 2, 2026
cc4a202
Camera: no webcam at start-up, no dark first photo
OfficiallySp Nov 2, 2026
e9745c6
Audio: catch up after a device change, fewer gaps
OfficiallySp Nov 2, 2026
d9bd6ad
Camera: brighten a dim room; warm-up from the first frame
OfficiallySp Nov 2, 2026
493d9c6
First run: the hint doesn't cover the menu
OfficiallySp Nov 2, 2026
5a6b202
Video: no hitch every 17 s on 60 and 120 Hz displays
OfficiallySp Nov 2, 2026
221d964
OpenGP 1.0.2: the version and the changelog
OfficiallySp Nov 2, 2026
a8c21e9
Menu: plainer labels and help text in the settings pages
OfficiallySp Nov 3, 2026
4dabbaf
update changelog for 1.0.2
OfficiallySp Nov 3, 2026
d92a830
reword first launch hint
OfficiallySp Nov 3, 2026
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
29 changes: 28 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
## 1.0.2

- The command-line installer is now called `opengp-cli`, so it is no longer mistaken for the way to install OpenGP
- The menu no longer shows your full folder path: an **Open folder** button opens the card or controls folder instead
- Plainer names and help text in the menu's settings, These now match the settings text from the launcher
- Aspect ratio and resolution choices now name their sizes (16:9, 1080p, 4K and so on)
- Gamepads without a Guide button (or where Steam takes it) open the menu with **Back** and **Start** held together
- Key bindings now show the correct key labels on non-US keyboards
- Fixed the default window size on high-DPI displays
- Removed debug spam from the console (use `--verbose` to restore pre 1.0.2 behaviour)
- Added a first-run hint for inserting a coin and opening the menu
- Improved wheel and pedal precision
- Fixed pedals reading as half-pressed until they were first moved
- Fixed pedals binding to the wrong axis half when bound before they were first moved
- The webcam no longer switches on at start-up: the game's camera check gets a picture without it
- Fixed the first photo coming out darker than intended
- Fixed audio drifting out of sync after changing the audio device
- Fixed occasional audio stutter
- Fixed a small periodic stutter on 60 and 120 Hz displays

### Known issues

- Races need most of a CPU core: a PC busy with something else (another game) can drop below
60 fps.
- Linked races can still freeze for a moment now and then; this is being fixed for 1.0.3.
- 1.0.2 cabinets link with 1.0.1 ones, but not with 1.0.0, run 1.0.1 or newer on every cabinet.

## 1.0.1 (2/11/2026)

- A new in-game menu in the OpenGP launcher's look: a pause card, with the settings in a dialog
Expand Down Expand Up @@ -39,4 +66,4 @@

- Races need most of a CPU core: a PC busy with something else (another game) can drop below
60 fps.
- 1.0.1 cabinets can't link with 1.0.0 or 0.4.0 ones: run the same version on every cabinet.

2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.25)
project(OpenGP VERSION 1.0.1 LANGUAGES C CXX)
project(OpenGP VERSION 1.0.2 LANGUAGES C CXX)

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ your GGPE02.iso ─extract─> main.dol ─decomp-toolkit─> symbols.txt
| Input | `runtime/input/` | Keyboard, gamepads and wheels (SDL3) mapped onto the cabinet's controls, force feedback, scripted input |
| App | `runtime/app/` | Command line, settings, window, the in-game menu (Dear ImGui) |
| Games | `games/` | Per-game manifest, symbol maps, recompiler config and patches (`mkgp1`, `mkgp2`); what both share in `common/` (their `main()`, SDK replacements, the arcade library's free play and test-menu restart) |
| Installer | `tools/installer/` | Builds the games on the player's machine from the installer package: the library the package's launcher uses, and `opengp-install` (see [docs/packaging.md](docs/packaging.md)) |
| Installer | `tools/installer/` | Builds the games on the player's machine from the installer package: the library the package's launcher uses, and `opengp-cli` (see [docs/packaging.md](docs/packaging.md)) |
| Scripts | `tools/*.py`, `tools/devshell.ps1` | Game setup (extract and verify `main.dol`), naming functions (SDK signatures, the GP 2 decomp, matching functions between the games), Windows build shell |
| Tests | `tests/` | Decoder, known-answer semantics and differential tests (interpreter vs recompiled code), and tests of the hardware, renderer front end, settings, input, link, paths, the installer and crash reports |

Expand Down Expand Up @@ -61,7 +61,7 @@ The code is held to the same checks as any other:
Download the launcher package for Windows, Linux or macOS (Apple Silicon) from the releases,
unpack it and open `OpenGP`, the launcher. Add your disc image of each game: OpenGP builds the games
on your machine from your images, then plays them (see [docs/packaging.md](docs/packaging.md) and
[docs/playing.md](docs/playing.md)). On the command line, `opengp-install` builds them the same way.
[docs/playing.md](docs/playing.md)). On the command line, `opengp-cli` builds them the same way.

## Building

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ Releases ship everything but the games: the runtime as static libraries with its
recompiler (inside the installer) and the games' own files. The installer checks the player's image,
recompiles its `main.dol`, compiles the result with a C++ compiler (llvm-mingw on Windows, the
system's on Linux and macOS) and links it with the runtime. It is a library: the program players
open, `OpenGP` (from opengp-launcher), builds the games with it, and so does `opengp-install`, its
open, `OpenGP` (from opengp-launcher), builds the games with it, and so does `opengp-cli`, its
command-line program. See [packaging.md](packaging.md).

### Reboots (`runtime/os/reboot.h`)
Expand Down
11 changes: 7 additions & 4 deletions docs/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ build/<preset>/games/mkgp2/opengp-mkgp2 [--iso PATH] [--user-dir PATH] [--timeou
[--headless] [--no-video] [--screenshot FRAME]... [--screenshot-every N]
[--input SCRIPT] [--input-file PATH] [--free-play] [--test-menu]
[--no-audio] [--volume PERCENT] [--audio-dump PATH] [--game-log]
[--camera off|webcam|test] [--cabinet 1-4] [--lan]
[--camera off|webcam|test] [--cabinet 1-4] [--lan] [--verbose]
```

`opengp-mkgp1` (Mario Kart Arcade GP, in `build/<preset>/games/mkgp1/`) takes the same options. `--version` prints the
Expand All @@ -85,9 +85,11 @@ version and the game.
Controls and playing are covered in [playing.md](playing.md).

`opengp-mkgp2` finds the image in `ISO/` or `private/` (or takes `--iso`), boots it and runs the
game in a window (Vulkan, or Metal on macOS, through SDL3's GPU API). It prints:
- the game's `OSReport` output;
- a status line every `--status` seconds (default 5; 0 for none): retraces, frames and draws so
game in a window (Vulkan, or Metal on macOS, through SDL3's GPU API). It prints a short summary at
start-up, what happens (a card, a gamepad, a restart) and problems. With `--verbose` it also prints:
- the game's `OSReport` output, the hardware's unhandled accesses and first register accesses, and
the DSP's microcode;
- a status line every `--status` seconds (default 5 with `--verbose`, else none; 0 for none): retraces, frames and draws so
far, guest threads, pending interrupts, the sound output's queue (its length, and how often it
ran dry or overflowed), and each guest thread's call stack when call tracing is on.

Expand All @@ -112,6 +114,7 @@ options that change them do so for that run only.
| `--volume PERCENT` | Sound volume, 0-100 (default 100) |
| `--audio-dump PATH` | Also write the sound to a WAV file (works headless too) |
| `--game-log` | Print the game's own debug messages (see [triforce.md](triforce.md#the-games-debug-messages-milestone-10)) |
| `--verbose` | Print what is only for working on OpenGP: the SDK's messages, hardware accesses, a status line every 5 s |
| `--camera SOURCE` | The camera's pictures: `off`, `webcam` or `test` (colour bars; see [playing.md](playing.md#the-camera)) |
| `--cabinet N` | This cabinet's number for linking, 1-4 (see [playing.md](playing.md#linked-cabinets)) |
| `--lan` | Link with cabinets on the local network too |
Expand Down
14 changes: 7 additions & 7 deletions docs/packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,17 @@ Update every linked cabinet: cabinets on different versions of OpenGP may not li

### On the command line

`opengp-install` (`opengp-install.exe`), next to OpenGP, is the same installer for the command
`opengp-cli` (`opengp-cli.exe`), next to OpenGP, is the same installer for the command
line. It builds each game from the images you give it, or without any, from the images the games
were built from before, then those in `ISO/`. On Windows you can also drop an image on
`opengp-install.exe`. If it finds no image for a game, it skips that game and builds the other.
`opengp-cli.exe`. If it finds no image for a game, it skips that game and builds the other.

When you run it again, it rebuilds only the games that an earlier version of the package built.
`--force` rebuilds every game. If you move an image, give `opengp-install` its new path (or drop it
on `opengp-install.exe`), and the game uses it from then on.
`--force` rebuilds every game. If you move an image, give `opengp-cli` its new path (or drop it
on `opengp-cli.exe`), and the game uses it from then on.

```
opengp-install [IMAGE...] [--force] [--jobs N] [--cxx COMPILER] [--keep-build]
opengp-cli [IMAGE...] [--force] [--jobs N] [--cxx COMPILER] [--keep-build]
```

- `--jobs N` compiles N files at a time. The default is one per CPU thread.
Expand Down Expand Up @@ -143,7 +143,7 @@ OpenGP[.exe] the launcher, which players open (OpenGP.app on macOS, w
qt/, qt.conf the Qt the launcher uses, on Windows and Linux. On Windows, Qt's DLLs are
next to OpenGP.exe, with Microsoft's Visual C++ runtime and Direct3D shader
compilers (d3dcompiler_47.dll, dxcompiler.dll and dxil.dll)
opengp-install[.exe] the installer, for the command line
opengp-cli[.exe] the installer, for the command line
sdk/package.toml the version, the pinned compiler, compile and link settings
sdk/include/ the runtime's headers
sdk/lib/ the runtime as static libraries, with SDL3 and Dear ImGui
Expand Down Expand Up @@ -224,7 +224,7 @@ cmake --install build/launcher --prefix $PWD/out/OpenGP-linux-x64 # or -wind
```

To try a package build, open its launcher, for example `out/OpenGP-windows-x64/OpenGP.exe`, or run
its installer, `opengp-install`, with an image.
its installer, `opengp-cli`, with an image.

Some settings must change together:
- CI builds the runtime with the llvm-mingw release that `cmake/package.cmake` pins, and the
Expand Down
34 changes: 24 additions & 10 deletions docs/playing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ details.

- **From the installer package**: unpack it, open `OpenGP` (the launcher) and add your disc image
of each game. It builds each game you have an image of, once, and then plays it; see
[packaging.md](packaging.md). On the command line, `opengp-install` builds them the same way.
[packaging.md](packaging.md). On the command line, `opengp-cli` builds them the same way.
The games, `opengp-mkgp2` and `opengp-mkgp1`, then sit next to OpenGP.
- **From source**: see [building.md](building.md) and [game-files.md](game-files.md).

Expand All @@ -20,7 +20,8 @@ way, and everything on this page applies to both.

The games behave like the arcade cabinet: insert a coin and press start; in the menus, steer to
choose and step on the gas pedal to decide. Turn on free play in the menu (Esc), or start the
game with `--free-play`, to play without coins ("Step on gas pedal to start").
game with `--free-play`, to play without coins ("Step on gas pedal to start"). The first time a
game starts, a hint says which keys put in a coin, start and open the menu.

```sh
opengp-mkgp2 --free-play # in the installer package's folder
Expand All @@ -32,14 +33,14 @@ the card keeps your progress (Mario Coins, titles, unlocked characters). See [Ma

## The menu

**Esc** (or a gamepad's guide button) opens the menu over the game: **Resume**, **Settings**,
**Esc** (or a gamepad's guide button, or **Back** and **Start** held together) opens the menu over the game: **Resume**, **Settings**,
**Test menu** (the game's own, for operators: it restarts the game) and **Quit**. The game pauses
while the menu is open and gets no controls (turn off **Pause while this menu is open** in
Settings, on the Game page, to keep it running).

The menu works with the keyboard, a gamepad or the mouse: the arrows (or the d-pad and left stick)
move, **Enter** (or **A**) selects, and **Esc** (or **B**) goes back one step, out to the game
from the first one; the guide button closes the menu from anywhere. In Settings, **Page Up** and
from the first one; the guide button (or Back + Start) closes the menu from anywhere. In Settings, **Page Up** and
**Page Down** (or **LB** and **RB**) change pages, and **Left** and **Right** change the chosen
row's value without opening a list. Quitting, the test menu and restoring the default controls
ask first.
Expand Down Expand Up @@ -112,10 +113,18 @@ even_pacing` in `user/settings.toml`), OpenGP holds each frame until the game's
cabinet's display does, so the frames come evenly spaced. It costs about half a frame (8 ms) of
delay, and matters most in fullscreen with FreeSync or G-Sync.

### 60 Hz and 120 Hz displays

The game's clock is NTSC's 59.94 Hz, a little slower than a 60 Hz display: at real speed one
frame in a thousand would be shown twice, a small hitch every 17 seconds. With vsync on, on a
display within half a percent of 60 Hz or a multiple of it, OpenGP runs the game 0.1% faster to
match it (the console says so); the sound speeds up the same, which no one hears. Linked races
run at real speed.

## Mario Cards

Cards are saved in `user/cards/GGPE01/` (GP) and `user/cards/GGPE02/` (GP 2), one file per card
(`Card 1.bin`, ...). In the menu's Game tab you choose the card you hold: you insert it when the
(`Card 1.bin`, ...); **Open folder**, under the card list, opens that folder. In the menu's Game tab you choose the card you hold: you insert it when the
game asks for your card, and the game takes it back at the end. **New card** gives you a blank one (answer **No** to "Do you have Mario
Card?", then buy a card, and it is saved under that name); **No card** plays without one. A card the
game gives you is yours to hold from then on, so you can keep a card per player. Files can be
Expand All @@ -141,9 +150,11 @@ there is no webcam, the game runs without its camera and says so on the console.
`webcam` (the webcam's name, `""` for the first), and `--camera off|webcam|test` sets it for one
run.

The webcam is on only while the game uses it: while your photo is taken, for a moment as the game
starts (it checks its camera), and on the test menu's camera page. Its light goes off a few
seconds later. If the webcam can't be opened then (another program is using it, say), the photo
The webcam is on only while the game uses it: while your photo is taken and on the test menu's
camera page (the game's camera check at start-up gets a grey picture, without the webcam). Its
light goes off a few seconds later. Its first moment's pictures, dark while it adjusts to the
room's light, are left out, and in a dim room the picture is brightened (the cabinet had its own
light). If the webcam can't be opened then (another program is using it, say), the photo
is grey and the console says why.

## Linked cabinets
Expand Down Expand Up @@ -223,7 +234,7 @@ it as well.
| Start | Enter, 1 | Start |
| Coin | 5, C | Back |
| Service / test | F1 / F2 | |
| Menu | Esc | Guide |
| Menu | Esc | Guide, Back + Start |
| Pause | P, Pause | |
| Fullscreen | F11, Alt+Enter | |
| Screenshot | F12 | |
Expand All @@ -246,7 +257,7 @@ at all is kept as `controls.toml.bad` and the default controls are used. Each co

```toml
[keyboard]
gas = ["Up", "W", "Left Shift"] # SDL key names
gas = ["Up", "W", "Left Shift"] # SDL key names, by their place on a US keyboard

[gamepad]
item = ["a", "x"] # SDL gamepad button names
Expand All @@ -257,6 +268,9 @@ gas = ["-axis2"] # a pedal that reads highest when released
brake = ["-axis3"]
```

The file names keys by where they are on a US keyboard, so it works with any layout; the menu
shows them as your keyboard's layout prints them (`W` on an AZERTY keyboard shows as **Z**).

Axes: `axis2` is the whole axis, `axis2+` and `axis2-` are one half of it, and a leading `-`
turns it around. The file itself lists every name.

Expand Down
5 changes: 4 additions & 1 deletion games/common/sdk_hle.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
#include "os/printf.h"
#include "os/reboot.h"
#include "os/threads.h"
#include "os/verbose.h"
#include "ppc/memory.h"
#include "ppc_recomp_shared.h"

Expand All @@ -42,8 +43,10 @@ gekko::u8* ram(gekko::u8* base, gekko::u32 address, gekko::u32 size) {

namespace guest {

// OSReport(const char* fmt, ...): print to the host console.
// OSReport(const char* fmt, ...): print to the host console with --verbose
// (the SDK's start-up banners and the like: nothing a player needs).
PPC_FUNC(OSReport) {
if (!os::verbose()) return;
std::string text = os::format_guest(ctx, base, ctx.gpr[3], 4);
if (text.empty() || text.back() != '\n') text += '\n';
std::fputs(("[OSReport] " + os::sjis_to_utf8(text)).c_str(), stdout);
Expand Down
Loading
Loading