diff --git a/README.md b/README.md index 4903484..0c3dc9e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ -# TurtleSilicon +# TurtleSilicon TurtleSilicon Logo + +![Turtle WoW FPS on Apple Silicon](img/turtlesilicon-fps.png) A user-friendly launcher for Turtle WoW on Apple Silicon Macs, with one-click patching of winerosetta, rosettax87 and d9vk. +## Prerequisites + +Before you begin, ensure you have the following: + +* A working version of **CrossOver** installed (the trial version is sufficient). +* The **Turtle WoW Client** downloaded from the official website. + ## Credits All credit for the core translation layer `winerosetta` goes to **LifeisAwful**. This application is merely a Fyne-based GUI wrapper to simplify the patching and launching process. [https://github.com/Lifeisawful/winerosetta](https://github.com/Lifeisawful/winerosetta) @@ -15,6 +24,23 @@ All credit for the core translation layer `winerosetta` goes to **LifeisAwful**. * Experience a massive FPS increase: from around 20 FPS in unoptimized environments to **up to 200 FPS** (a 10x improvement!) in many areas. * **One-Click Patching:** Simplifies the setup process for both CrossOver and your Turtle WoW installation. +## Usage + +1. Launch `TurtleSilicon.app`. +2. **Set CrossOver Path**: + * If CrossOver is installed in the default location (`/Applications/CrossOver.app`), this path will be pre-filled. + * Otherwise, click "Set/Change" and navigate to your `CrossOver.app` bundle. +3. **Set TurtleWoW Directory Path**: + * Click "Set/Change" and select the folder where you have your Turtle WoW client files. +4. **Apply Patches**: + * Click "Patch TurtleWoW". + * Click "Patch CrossOver". + * Status indicators will turn green once patching is successful for each. +5. **Launch Game**: + * Once both paths are set and both components are patched, the "Launch Game" button will become active. Click it. + * Follow the on-screen prompts (you will need to enter your password in a new Terminal window for `rosettax87`). +6. **Enjoy**: Experience a significantly smoother Turtle WoW on your Apple Silicon Mac! + ## Build Instructions To build this application yourself, you will need: diff --git a/img/turtlesilicon-fps.png b/img/turtlesilicon-fps.png new file mode 100644 index 0000000..b327d32 Binary files /dev/null and b/img/turtlesilicon-fps.png differ