mirrors
/
SpaceCadetPinball
mirror of https://github.com/k4zmu2a/SpaceCadetPinball.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix: lint README to make more linkable

This commit is contained in:
eggplants 2021-10-16 02:38:24 +09:00
parent 82d4d8719f
commit 7725fdbe67
No known key found for this signature in database
GPG Key ID: E84F494AD6539CE2
1 changed files with 59 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
README.md
View File

@ -1,64 +1,79 @@
# SpaceCadetPinball <!-- markdownlint-disable-file MD033 -->
**Summary:** Reverse engineering of `3D Pinball for Windows – Space Cadet`, a game bundled with Windows.
**How to play:** Place compiled executable into a folder containing original game resources (not included).\ # SpaceCadetPinball
## Summary
Reverse engineering of `3D Pinball for Windows – Space Cadet`, a game bundled with Windows.
## How to play
Place compiled executable into a folder containing original game resources (not included).\
Supports data files from Windows and Full Tilt versions of the game. Supports data files from Windows and Full Tilt versions of the game.
**Known source ports:** ## Known source ports
| Platform | Author | URL | | Platform | Author | URL |
| --- | --- | --- | | --------------- | ------ | ---------------------------------------------------------------------------------------------------------- |
| PS Vita | Axiom | <https://github.com/suicvne/SpaceCadetPinball_Vita> | | PS Vita | Axiom | <https://github.com/suicvne/SpaceCadetPinball_Vita> |
| Emscripten | alula | <https://github.com/alula/SpaceCadetPinball> <br> Play online: https://alula.github.io/SpaceCadetPinball | | Emscripten | alula | <https://github.com/alula/SpaceCadetPinball> <br> Play online: <https://alula.github.io/SpaceCadetPinball> |
| Nintendo Switch | averne | https://github.com/averne/SpaceCadetPinball-NX | | Nintendo Switch | averne | <https://github.com/averne/SpaceCadetPinball-NX> |
Platforms covered by this project: desktop Windows, Linux and macOS. Platforms covered by this project: desktop Windows, Linux and macOS.
\
\
\
\
\
\
**Source:**
* `pinball.exe` from `Windows XP` (SHA-1 `2A5B525E0F631BB6107639E2A69DF15986FB0D05`) and its public PDB
* `CADET.EXE` 32bit version from `Full Tilt! Pinball` (SHA-1 `3F7B5699074B83FD713657CD94671F2156DBEDC4`)
**Tools used:** `Ghidra`, `Ida`, `Visual Studio` ## Source
**What was done:** * `pinball.exe` from `Windows XP` (SHA-1 `2A5B525E0F631BB6107639E2A69DF15986FB0D05`) and its public PDB
* All structures were populated, globals and locals named. * `CADET.EXE` 32bit version from `Full Tilt! Pinball` (SHA-1 `3F7B5699074B83FD713657CD94671F2156DBEDC4`)
* All subs were decompiled, C pseudo code was converted to compilable C++. Loose (namespace?) subs were assigned to classes.
**Compiling:** ## Tools used
`Ghidra`, `Ida`, `Visual Studio`
## What was done
* All structures were populated, globals and locals named.
* All subs were decompiled, C pseudo code was converted to compilable C++. Loose (namespace?) subs were assigned to classes.
## Compiling
Project uses `C++11` and depends on `SDL2` libs.
### On Windows
Project uses `C++11` and depends on `SDL2` libs.\
On Windows:\
Download and unpack devel packages for `SDL2` and `SDL2_mixer`.\ Download and unpack devel packages for `SDL2` and `SDL2_mixer`.\
Set paths to them in CMakeLists.txt, see suggested placement in /Libs.\ Set paths to them in `CMakeLists.txt`, see suggested placement in `/Libs`.\
Compile with Visual Studio; tested with 2019. Compile with Visual Studio; tested with 2019.
On Linux:\ ### On Linux
Install devel packages for `SDL2` and `SDL2_mixer`.\ Install devel packages for `SDL2` and `SDL2_mixer`.\
Compile with CMake; tested with GCC 10, Clang 11.\ Compile with CMake; tested with GCC 10, Clang 11.\
To cross-compile for Windows, install a 64-bit version of mingw and its `SDL2` and `SDL2_mixer` distributions, then use the `mingwcc.cmake` toolchain. To cross-compile for Windows, install a 64-bit version of mingw and its `SDL2` and `SDL2_mixer` distributions, then use the `mingwcc.cmake` toolchain.
On macOS:\ ### On macOS
**Homebrew**: Install the `SDL2`, `SDL2_mixer` homebrew packages.\
**MacPorts**: Install the `libSDL2`, `libSDL2_mixer` macports packages.\ * **Homebrew**: Install the `SDL2`, `SDL2_mixer` homebrew packages.
Compile with CMake. Ensure that `CMAKE_OSX_ARCHITECTURES` variable is set for either `x86_64` Apple Intel or `arm64` for Apple Silicon.\ * **MacPorts**: Install the `libSDL2`, `libSDL2_mixer` macports packages.
Compile with CMake. Ensure that `CMAKE_OSX_ARCHITECTURES` variable is set for either `x86_64` Apple Intel or `arm64` for Apple Silicon.
Tested with: macOS Big Sur (Intel) with Xcode 13 & macOS Montery Beta (Apple Silicon) with Xcode 13. Tested with: macOS Big Sur (Intel) with Xcode 13 & macOS Montery Beta (Apple Silicon) with Xcode 13.
**Plans:** ## Plans
* ~~Decompile original game~~
* ~~Resizable window, scaled graphics~~ * ~~Decompile original game~~
* ~~Loader for high-res sprites from CADET.DAT~~ * ~~Resizable window, scaled graphics~~
* Misc features of Full Tilt: 3 music tracks, multiball, centered textboxes, etc. * ~~Loader for high-res sprites from CADET.DAT~~
* Cross-platform port * Misc features of Full Tilt: 3 music tracks, multiball, centered textboxes, etc.
* Cross-platform port
* Using SDL2, SDL2_mixer, ImGui * Using SDL2, SDL2_mixer, ImGui
* Maybe: Android port * Maybe: Android port
* Maybe x2: support for other two tables * Maybe x2: support for other two tables
* Table specific BL (control interactions and missions) is hardcoded, othere parts might be also patched * Table specific BL (control interactions and missions) is hardcoded, othere parts might be also patched
**On 64-bit bug that killed the game:**\ ## On 64-bit bug that killed the game
I did not find it, decompiled game worked in x64 mode on the first try.\ I did not find it, decompiled game worked in x64 mode on the first try.\
It was either lost in decompilation or introduced in x64 port/not present in x86 build.\ It was either lost in decompilation or introduced in x64 port/not present in x86 build.\
Based on public description of the bug (no ball collision), I guess that the bug was in `TEdgeManager::TestGridBox` Based on public description of the bug (no ball collision), I guess that the bug was in `TEdgeManager::TestGridBox`