mirror/HomeworldSDL
3
0
Fork 0
mirror of https://github.com/HomeworldSDL/HomeworldSDL.git synced 2025-10-29 19:45:21 +00:00
Code Issues Projects Releases Wiki Activity

docs: MacOS: Adding build instructions for macOS

Browse Source 
Consolidating macOS sections into one section on compilation instructions
This commit is contained in:
atsb 2023-12-20 19:59:15 +01:00 committed by Thibault Lemaire
parent 0a16ea5d12
commit 96f868beca
2 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Mac/BUILD.md Normal file
View File

@ -0,0 +1,17 @@
# Compiling Homeworld SDL on macOS
## Preparation
1. Copy SDL2.framework and SDL2_image.framework (download the .dmg files from the official github repo) and copy the .framework directories to the Mac directory.
2. Make a separate directory called 'includes' and create an 'SDL2' directory there with all the SDL2 header files. This is due to the game code using SDL2/ on Mac and not finding the header files in the frameworks from the commandline. Since this only affects kas2c and biggie and is only a development setup, it isn't an issue.
3. Execute the macOS kas2c and biggie shell scripts.
## Xcode
#### x86_64 / Apple Silicon (intel/amd 64-bit/arm64)
Open the Xcode project and build Homeworld (everything is pre-setup). Application bundles will be placed inside the DerviedData directory for Xcode (it will show you where).
After this, copy the Application bundles to your Applications/ directory.
This is a build readme, it will not cover the data. Ensure you have the data in the correct directories for macOS.

10
README.md
View File

@ -86,10 +86,6 @@ Open the game installation folder (usually `~/.wine/drive_c/Sierra/Homeworld`).
After installing the game, you should find the [required assets](#asset-checklist) in `~/.local/share/Steam/steamapps/common/Homeworld/Homeworld1Classic/Data`. Put them to `$ASSETS_FOLDER`.
##### macOS
To setup either the data from the original or remaster. Please place the data assets into 'Library/Application Support/Homeworld' or, if you are using Raider Retreat, place them in the same destination folder except to use 'Raider Retreat' instead of 'Homeworld'.
## Compiling from source
### Linux
@ -108,7 +104,7 @@ HW_Data=$ASSETS_FOLDER nix run 'git+https://gitlab.com/homeworldsdl/TenhauserGat
Nix will download everything it needs, build the HomeworldSDL source code, then run the resulting binary.
If you don't have Nix installed, please refer to [`Linux/BUILD.md`](Linux/BUILD.md).
If you don't have Nix installed, please refer to [`Linux/BUILD.md`](Linux/BUILD.md)
#### Game is slow/crashes
@ -127,7 +123,9 @@ meson setup --buildtype=release -Db_sanitize=none build.fast
### macOS
Go into the 'Mac' directory, and use the xcode project. Please note, you will need the SDL2.framework before you start. This can be found on the releases page of SDL's github repository as a .dmg file. Place this file into the same directory as the xcode project file and then proceed to build the engine.
Please refer to [`Mac/BUILD.md`](Mac/BUILD.md).
To setup either the data from the original or remaster. Please place the data assets into 'Library/Application Support/Homeworld' or, if you are using Raider Retreat, place them in the same destination folder except to use 'Raider Retreat' instead of 'Homeworld'.
[Nix]: https://nixos.org/nix/