bm2dnix/spicetools
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 1 Wiki Activity

Update readme to be less vague about how the project is built

Browse Source
This commit is contained in:
Hazel 2024-08-28 12:17:45 -04:00
parent 915397b28f
commit badae421da
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,22 +1,23 @@
SpiceTools SpiceTools for Linux (Experimental)
========== ==========
This is a loader for various arcade games developed by 573. This is a loader for various arcade games developed by 573.
The project is using CMake as it's build system, with a custom build The project is using CMake as it's build system, with a custom build
script for making packages ready for distribution and to keep it easy script for making packages ready for distribution and to keep it easy
for people not knowing how to use CMake. for people not knowing how to use CMake.
This fork aims to re-implement a Pipewire backend for WASAPI exclusive mode that was originally written for the 23-09-29 build of spice2x.
## Building/Distribution ## Building/Distribution
We're currently using Arch Linux for building the binaries. We're currently using Arch Linux for building the binaries.
You'll need: You'll need:
- MinGW-64 packages (can be found in the AUR) - MinGW-64 packages (can be found in the AUR, package name is mingw-w64-cmake)
- bash - bash
- git - git
- zip - zip
- upx (optional) - upx (optional)
For any other GNU/Linux distributions (or Windows lol), you're on your For any other GNU/Linux distributions (or Windows lol), you're on your
own. own. Don't use the Docker scripts, they're broken.
To build the project, run: To build the project, run:
@ -24,6 +25,10 @@ To build the project, run:
## Build Configuration ## Build Configuration
Note: Individuals using AUR helper tools like yay may experience errors when building the project, as a result of missing toolchain files. Please make sure to select "packages to cleanBuild?" when installing with yay, or better yet, use the PKGBUILD directly.
This is due to the fact that the spice2x Arch build scripts expect that you have toolchain files in /usr/share/mingw which are only generated if you build MinGW from source.
You can tweak some settings at the beginning of the build script. You You can tweak some settings at the beginning of the build script. You
might want to modify the paths of the toolchains if yours differ. It's might want to modify the paths of the toolchains if yours differ. It's
also possible to disable UPX compression and source distribution for also possible to disable UPX compression and source distribution for