Skip to content
This repository has been archived by the owner on Apr 14, 2024. It is now read-only.

Commit

Permalink
Fix build and rebrand to Suyu (#16)
Browse files Browse the repository at this point in the history
* Update CMake settings
* Rebranding to Suyu
* Missing `catch2` in dependencies list.
* Pull from dev branch instead of master

---------

Co-authored-by: Marcin Mitura <[email protected]>
  • Loading branch information
shinra-electric and mavethee authored Mar 9, 2024
1 parent 85b5836 commit 4649dbd
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 41 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Build script for compiling Yuzu on Apple Silicon
## Build script for compiling Suyu on Apple Silicon

<img src="./assets/icons/yuzu_icon.png" width="20%" height="20%" align="right"/>
<img src="./assets/icons/suyu.png" width="20%" height="20%" align="right"/>

[🇵🇱 Szukasz Polskiego? Kliknij tutaj](README_pl_PL.md) [🇺🇸 You are reading English version](README.md)

This script will build and compile Yuzu for macOS on Apple Silicon.
This script will build and compile Suyu for macOS on Apple Silicon.

> [!WARNING]
> This script is provided for experimentation purposes.<br>
Expand All @@ -25,16 +25,16 @@ It is advised to run it from your home directory.
> On a base M1, building takes ~4mins (measured including gathering needed dependencies which differs depending on your internet speed)
> In case of any permission issues, run:
> ```
> chmod +x ./build_yuzu.sh
> chmod +x ./build_suyu.sh
> ```
> [!NOTE]
> Yuzu currently does not support a lot of required features.<br>
> Suyu currently does not support a lot of required features.<br>
> If a game you are trying to play uses these features, it will crash. <br>
> If you want to know what missing feature is causing the crash, run yuzu through Terminal:
> If you want to know what missing feature is causing the crash, run Suyu through Terminal:
>
> ```
> /Applications/yuzu.app/Contents/MacOS/yuzu
> /Applications/Suyu.app/Contents/MacOS/suyu
> ```
> The situation will get better in the future as MoltenVK adds support for more features.
Expand All @@ -60,19 +60,19 @@ git pull origin main
### 3. Copy the script to a location on your home directory:

```sh
ditto build_yuzu.sh $HOME/build_yuzu.sh
ditto build_suyu.sh $HOME/build_suyu.sh
```

### 4. Make the script executable:

```sh
chmod +x $HOME/build_yuzu.sh
chmod +x $HOME/build_suyu.sh
```

### 5. Run the build script:

```sh
$HOME/build_yuzu.sh
$HOME/build_suyu.sh
```

### 6. Enjoy!
Expand All @@ -81,7 +81,7 @@ Note: Remember to repeat STEP 2 for future script changes. </br>

## Special thanks to:

- Yuzu's macOS build instructions archived [here](https://web.archive.org/web/20240113191459/https://yuzu-emu.org/wiki/building-for-macos/)
- Suyu's macOS build instructions archived [here](https://web.archive.org/web/20240113191459/https://yuzu-emu.org/wiki/building-for-macos/)

...and ChatGPT with GitHub Copilot for making my drunkass shell coding public.

Expand Down
24 changes: 12 additions & 12 deletions README_pl_PL.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Skrypt kompilujący port Yuzu na systemy macOS
## Skrypt kompilujący port Suyu na systemy macOS

<img src="./assets/icons/yuzu_icon.png" width="20%" height="20%" align="right"/>
<img src="./assets/icons/suyu.png" width="20%" height="20%" align="right"/>

[🇵🇱 Czytasz polską wersje strony](README_pl_PL.md) [🇺🇸 Go to English version](README.md)

Ten skrypt pobierze wszystkie potrzebne rzeczy dla portu Yuzu na macOS.
Ten skrypt pobierze wszystkie potrzebne rzeczy dla portu Suyu na macOS.

Weź pod uwagę, żeby nie nastawiać się na wiele, w obecnym stanie nie jest to w pełni funkcjonalny port.

Expand All @@ -20,15 +20,15 @@ Preferowane odpalenie skryptu w katalogu domowym.
> W przypadku podstawowej konfiguracji na M1, kompilacja trwa ~4mins (pomiar zawiera również pobieranie potrzebnych plików do kompilacji, zależne od szybkości połączenia)
> W razie problemów z uprawnieniami:
> ```
> chmod +x ./build_yuzu.sh
> chmod +x ./build_suyu.sh
> ```
> [!NOTE]
> Obecnie yuzu nie wspiera wielu wymaganych funkcji jak na przykład Geometry Shaders lub Transform Feedback Buffers.
> Jeśli twoja gra używa niewspieranych funkcji, yuzu się scrashuje.
> Jeśli chcesz poznać szczegóły na temat crasha danej gry, odpal Yuzu za pomocą Terminala:
> Obecnie Suyu nie wspiera wielu wymaganych funkcji jak na przykład Geometry Shaders lub Transform Feedback Buffers.
> Jeśli twoja gra używa niewspieranych funkcji, Suyu się scrashuje.
> Jeśli chcesz poznać szczegóły na temat crasha danej gry, odpal Suyu za pomocą Terminala:
> ```
> /Applications/yuzu.app/Contents/MacOS/yuzu
> /Applications/Suyu.app/Contents/MacOS/Suyu
> ```
> Sytuacja może ulec zmianie w przyszłości, gdy tylko MoltenVK doda wspracie dla większej ilości funkcji.
Expand All @@ -54,19 +54,19 @@ git pull origin main
### 3. Skopiuj skrypt do swojego katalogu głównego:

```sh
ditto build_yuzu.sh $HOME/build_yuzu.sh
ditto build_suyu.sh $HOME/build_suyu.sh
```

### 4. Nadaj uprawnienia skryptowi:

```sh
chmod +x $HOME/build_yuzu.sh
chmod +x $HOME/build_suyu.sh
```

### 5. Uruchom skrypt:

```sh
$HOME/build_yuzu.sh
$HOME/build_suyu.sh
```

### 6. Enjoy!
Expand All @@ -75,7 +75,7 @@ Notka: Pamiętaj o powtórzeniu kroku drugiego co jakiś czas, aby mieć najaktu

## Podziękowania:

- Yuzu's macOS build instructions archived [here](https://web.archive.org/web/20240113191459/https://yuzu-emu.org/wiki/building-for-macos/)
- Suyu's macOS build instructions archived [here](https://web.archive.org/web/20240113191459/https://yuzu-emu.org/wiki/building-for-macos/)

...oraz ChatGPT wraz GitHub Copilot za pomoc w upublicznieniu tego syfu.

Expand Down
Binary file added assets/icons/suyu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/icons/yuzu_icon.png
Binary file not shown.
37 changes: 19 additions & 18 deletions build_yuzu.sh → build_suyu.sh
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ else

echo -e "${PURPLE}Fetching latest changes...${NC}"

git fetch origin master
git fetch origin dev

echo -e "${PURPLE}Removing existing submodules...${NC}"
git submodule deinit -f .
Expand All @@ -77,43 +77,44 @@ mkdir -p build && cd build
echo -e "${PURPLE}Running CMake...${NC}"

# Run CMake with specified options
cmake .. -GNinja -DCMAKE_BUILD_TYPE=RELEASE \
-DYUZU_USE_BUNDLED_VCPKG=OFF \
-DYUZU_TESTS=OFF \
-DENABLE_WEB_SERVICE=OFF \
-DENABLE_LIBUSB=OFF \
-DSDL_ARMNEON=ON \
-DENABLE_QT6=ON \
-DYUZU_USE_EXTERNAL_VULKAN_HEADERS=OFF

echo -e "${PURPLE}Building yuzu...${NC}"
cmake .. -GNinja \
-DCMAKE_BUILD_TYPE=RELEASE \
-DSUYU_USE_BUNDLED_VCPKG=OFF \
-DSUYU_TESTS=OFF \
-DENABLE_WEB_SERVICE=OFF \
-DENABLE_LIBUSB=OFF \
-DSDL_ARMNEON=ON \
-DENABLE_QT6=ON \
-DSUYU_USE_EXTERNAL_VULKAN_HEADERS=OFF

echo -e "${PURPLE}Building suyu...${NC}"

# Build Suyu using Ninja
ninja

# Check if the build was successful
if [ $? -eq 0 ]; then
echo -e "${GREEN}Build successful${NC}."
echo -e "${GREEN}Build successful.${NC}"

# Remove existing Suyu.app if it exists in /Applications
if [ -d "/Applications/yuzu.app" ]; then
if [ -d "/Applications/Suyu.app" ]; then
echo -e "${PURPLE}Removing existing Suyu.app in /Applications...${NC}"
rm -rf "/Applications/yuzu.app"
rm -rf "/Applications/Suyu.app"
fi

# Bundle dependencies and codesign
dylibbundler -of -cd -b -x bin/yuzu.app/Contents/MacOS/yuzu -d bin/yuzu.app/Contents/libs/
dylibbundler -of -cd -b -x bin/suyu.app/Contents/MacOS/suyu -d bin/suyu.app/Contents/libs/

echo -e "${PURPLE}Moving yuzu.app to /Applications...${NC}"
echo -e "${PURPLE}Moving Suyu.app to /Applications...${NC}"

# Move Suyu.app to /Applications
mv bin/yuzu.app /Applications/yuzu.app
mv bin/suyu.app /Applications/Suyu.app

echo -e "${PURPLE}Installation completed.${NC}"

# Remove build folder
cd "$HOME/suyu"
sudo rm -rf build
else
echo -e "${RED}Build failed${NC}. Please check the build output for errors."
echo -e "${RED}Build failed.${NC} Please check the build output for errors."
fi

0 comments on commit 4649dbd

Please sign in to comment.