Improve readme
This commit is contained in:
parent
e8f7ed61f1
commit
56d4ed311d
21
README.md
21
README.md
|
@ -1,16 +1,22 @@
|
||||||
<!-- markdownlint-disable-file MD033 -->
|
<!-- markdownlint-disable-file MD033 -->
|
||||||
|
|
||||||
# SpaceCadetPinball
|
# 3D Pinball for Windows – Space Cadet
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
Reverse engineering of `3D Pinball for Windows – Space Cadet`, a game bundled with Windows.
|
Reverse engineering of `3D Pinball for Windows – Space Cadet`, a game bundled with Windows.
|
||||||
|
|
||||||
|
## About the original game
|
||||||
|
|
||||||
|
3D Pinball for Windows – Space Cadet is a pinball video game developed by Cinematronics and published by Maxis in 1995. It features pre-rendered 3D graphics and three tables—Space Cadet, Skullduggery, and Dragon's Keep. On each table, there are displays on the side that show the players' score, ball number, player number, a display for various information and a table-specific image.
|
||||||
|
|
||||||
## How to play
|
## How to play
|
||||||
|
|
||||||
Place compiled executable into a folder containing original game resources (not included).\
|
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.
|
||||||
|
|
||||||
|
Use your keyboard or mouse to control the flipper
|
||||||
|
|
||||||
## Known source ports
|
## Known source ports
|
||||||
|
|
||||||
| Platform | Author | URL |
|
| Platform | Author | URL |
|
||||||
|
@ -60,9 +66,22 @@ 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.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# On Debian and Ubuntu
|
||||||
|
sudo apt install cmake build-essential ninja libsdl2-dev libsdl2-mixer-dev libsdl2-mixer-2.0-0 libsdl2-2.0-0
|
||||||
|
|
||||||
|
# On Fedora
|
||||||
|
sudo dnf install TBD
|
||||||
|
|
||||||
|
# Build
|
||||||
|
cmake -GNinja .
|
||||||
|
ninja
|
||||||
|
```
|
||||||
|
|
||||||
[![Packaging status](https://repology.org/badge/tiny-repos/spacecadetpinball.svg)](https://repology.org/project/spacecadetpinball/versions)
|
[![Packaging status](https://repology.org/badge/tiny-repos/spacecadetpinball.svg)](https://repology.org/project/spacecadetpinball/versions)
|
||||||
|
|
||||||
Some distributions provide a package in their repository. You can use those for easier dependency management and updates.
|
Some distributions provide a package in their repository. You can use those for easier dependency management and updates.
|
||||||
|
|
Loading…
Reference in New Issue