Decouple Readme from Linux building instructions
This commit is contained in:
parent
a35f1d0e76
commit
ef25ea023e
|
@ -0,0 +1,25 @@
|
||||||
|
# Building
|
||||||
|
|
||||||
|
Install devel packages for `SDL2` and `SDL2_mixer`.\
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# On Debian and Ubuntu
|
||||||
|
sudo apt install cmake build-essential ninja-build libsdl2-dev libsdl2-mixer-dev libsdl2-mixer-2.0-0 libsdl2-2.0-0 fluidsynth
|
||||||
|
|
||||||
|
# On Fedora
|
||||||
|
sudo dnf install cmake ninja-build SDL2 SDL2-devel SDL2_mixer SDL2_mixer-devel fluidsynth fluidsynth-libs mscore-fonts g++
|
||||||
|
|
||||||
|
# Build
|
||||||
|
cmake -GNinja .
|
||||||
|
ninja
|
||||||
|
```
|
||||||
|
|
||||||
|
**If you can't hear the background music**: You need to export the following variable before launching the game like this:
|
||||||
|
`export SDL_SOUNDFONT=/path/to/your/soundfont`
|
||||||
|
|
||||||
|
Fluidsynth will install a default soundfont in the following path:
|
||||||
|
On Fedora: `/usr/share/soundfonts/FluidR3_GM.sf2`
|
||||||
|
On Ubuntu/Debian: `/usr/share/sounds/sf2/FluidR3_GM.sf2`
|
24
README.md
24
README.md
|
@ -4,7 +4,7 @@
|
||||||
|
|
||||||
## 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.
|
||||||
|
|
||||||
## How to play
|
## How to play
|
||||||
|
|
||||||
|
@ -60,33 +60,13 @@ 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
|
[![Packaging status](https://repology.org/badge/tiny-repos/spacecadetpinball.svg)](https://repology.org/project/spacecadetpinball/versions)
|
||||||
# On Debian and Ubuntu
|
|
||||||
sudo apt install cmake build-essential ninja-build libsdl2-dev libsdl2-mixer-dev libsdl2-mixer-2.0-0 libsdl2-2.0-0 fluidsynth
|
|
||||||
|
|
||||||
# On Fedora
|
|
||||||
sudo dnf install cmake ninja-build SDL2 SDL2-devel SDL2_mixer SDL2_mixer-devel fluidsynth fluidsynth-libs mscore-fonts g++
|
|
||||||
|
|
||||||
# Build
|
|
||||||
cmake -GNinja .
|
|
||||||
ninja
|
|
||||||
```
|
|
||||||
|
|
||||||
[![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.
|
||||||
|
|
||||||
**If you can't hear the background music**: You need to export the following variable before launching the game like this:
|
|
||||||
`export SDL_SOUNDFONT=/path/to/your/soundfont`
|
|
||||||
|
|
||||||
Fluidsynth will install a default soundfont in the following path:
|
|
||||||
On Fedora: `/usr/share/soundfonts/FluidR3_GM.sf2`
|
|
||||||
On Ubuntu/Debian: `/usr/share/sounds/sf2/FluidR3_GM.sf2`
|
|
||||||
|
|
||||||
### On macOS
|
### On macOS
|
||||||
|
|
||||||
* **Homebrew**: Install the `SDL2`, `SDL2_mixer` homebrew packages.
|
* **Homebrew**: Install the `SDL2`, `SDL2_mixer` homebrew packages.
|
||||||
|
|
Loading…
Reference in New Issue