Merge remote-tracking branch 'upstream/main'

README.md

@@ -3,11 +3,12 @@
 Documentation for Whisky.
 
 ### How to Contribute
+
 1. Install [rust](https://www.rust-lang.org/tools/install)
 2. Install mdbook and the required preprocessors
    ```
    cargo install mdbook
    cargo install mdbook-alerts
-   cargo isntall mdbook-template
+   cargo install mdbook-template
    ```
 3. You can preview changes to the book with `mdbook serve --open`

book.toml

@@ -10,9 +10,11 @@ title = "Whisky Documentation"
 [preprocessor.template]
 
 [output.html]
-default-theme = "dark"
+default-theme = "whisky"
+preferred-dark-theme = "whisky"
 git-repository-url = "https://github.com/Whisky-App/Whisky"
 git-repository-icon = "fa-github"
+edit-url-template = "https://github.com/Whisky-App/whisky-book/edit/main/{path}"
 input-404 = "not-found.md"
 
 [output.html.print]

src/SUMMARY.md

@@ -3,17 +3,32 @@
 - [Guide](./guide.md)
 - [Common Issues](./common-issues.md)
 - [What's Where?](./paths.md)
+- [WhiskyCmd](./whiskycmd.md)
 - [Whisky vs. CrossOver](./cx.md)
 - [Game Support](./game-support/README.md)
+  - [Armored Core VI: Fires of Rubicon](./game-support/armored-core-6.md)
+  - [Blasphemous 2](./game-support/blasphemous-2.md)
   - [Cities: Skylines II](./game-support/cities-skylines-2.md)
+  - [Control](./game-support/control.md)
   - [Counter-Strike 2](./game-support/counter-strike-2.md)
+  - [Cyberpunk 2077](./game-support/cyberpunk-2077.md)
+  - [Dark Souls III](./game-support/dark-souls-3.md)
   - [Diablo IV (Battle.net)](./game-support/diablo-4-battle-net.md)
   - [Diablo IV (Steam)](./game-support/diablo-4-steam.md)
+  - [Dorfromantik](./game-support/dorfromantik.md)
   - [Elden Ring](./game-support/elden-ring.md)
   - [Elite Dangerous](./game-support/elite-dangerous.md)
+  - [Grand Theft Auto V](./game-support/gta-5.md)
   - [Horizon Zero Dawn](./game-support/horizon-zero-dawn.md)
+  - [Kenshi](./game-support/kenshi.md)
+  - [Metal Gear Solid V: The Phantom Pain](./game-support/mgs-5.md)
+  - [Monster Hunter World: Iceborne](./game-support/monster-hunter-world-iceborne.md)
+  - [Overwatch 2](./game-support/overwatch-2.md)
   - [Persona 3 Reload](./game-support/p3r.md)
   - [Palworld](./game-support/palworld.md)
   - [r2modman](./game-support/r2modman.md)
+  - [Sekiro: Shadows Die Twice](./game-support/sekiro.md)
   - [Skyrim SE](./game-support/skyrim-se.md)
-  - [Star Wars Jedi: Fallen Order](./game-support/sw-fallen-order.md)
+  - [Star Wars Jedi: Fallen Order](./game-support/sw-fallen-order.md)
+  - [Star Wars: Squadron](./game-support/sw-squadrons.md)
+  - [Warframe](./game-support/warframe.md)

src/common-issues.md

@@ -1,11 +1,11 @@
 
-## Common Issues
+# Common Issues
 
 Several things can lead to a program not working. The most common reasons are listed below.
 
-|Problem|Solution|
-|-------|---------|
-|My game crashes due to "invalid instruction".|Your game is likely using [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) instructions. These are more common in console ports. AVX instructions are x86 specific, and Rosetta doesn't translate them. Unless you can find a way to disable or bypass them (check online), then your game won't work.|
-|I want to play a competitive multiplayer game, but it won't load.|Competitive multiplayer games, especially battle royales and other FPS games (like PUBG, Fortnite, Apex Legends, Valorant), often have some form of driver-level anti-cheat. These won't work under Wine.|
-|My DirectX 9 game has graphical issues, or doesn't work at all.|DirectX 9 games are handled through Wine's own `wined3d`. Whisky focuses on modern titles using DX11 or 12, and you may run into issues with DX9 games. CrossOver is a better choice in this scenario, as it runs on Wine 8 instead of Wine 7, and has a more up-to-date version of `wined3d`. If you're not sure what Graphics API your game is using, you can check on the [PCGamingWiki](https://www.pcgamingwiki.com/wiki/Home).|
-|My game crashes out of the box, or complains about missing dependencies.|Make sure to check Wine's [AppDB](https://appdb.winehq.org/) and [ProtonDB](https://www.protondb.com/), which can often provide information on the necessary workarounds or Winetricks you need to use to get your game running. If you can't find anything or you are unable to make it work, make an issue.|
+| Problem                                                                  | Solution                                                                                                                                                                                                                                                                                                                                                                                                                             |
+|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| My game crashes due to "invalid instruction".                            | Your game is likely using [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) instructions. These are more common in console ports. AVX instructions are x86 specific, and Rosetta doesn't translate them. Unless you can find a way to disable or bypass them (check online), then your game won't work.                                                                                                                |
+| I want to play a competitive multiplayer game, but it won't load.        | Competitive multiplayer games, especially battle royales and other FPS games (like PUBG, Fortnite, Apex Legends, Valorant), often have some form of driver-level anti-cheat. These won't work under Wine.                                                                                                                                                                                                                            |
+| My DirectX 9 game has graphical issues, or doesn't work at all.          | DirectX 9 games are handled through Wine's own `wined3d`. Whisky focuses on modern titles using DX11 or 12, and you may run into issues with DX9 games. CrossOver is a better choice in this scenario, as it runs on Wine 9 instead of Wine 7, and has a more up-to-date version of `wined3d`. If you're not sure what Graphics API your game is using, you can check on the [PCGamingWiki](https://www.pcgamingwiki.com/wiki/Home). |
+| My game crashes out of the box, or complains about missing dependencies. | Make sure to check Wine's [AppDB](https://appdb.winehq.org/) and [ProtonDB](https://www.protondb.com/), which can often provide information on the necessary workarounds or Winetricks you need to use to get your game running. If you can't find anything or you are unable to make it work, make an issue.                                                                                                                        |

src/cx.md

@@ -1,4 +1,4 @@
-## Whisky or CrossOver?
+# Whisky or CrossOver?
 
 There are a lot of questions about which is better, here's an easy chart:
 

src/game-support/README.md

@@ -3,29 +3,43 @@
 This is by no means an exhaustive list of games that run in Whisky.
 Neither is it an exhaustive list of fixes for games that need them.
 If a game you want to play isn't working and is missing from this list,
-be sure to contribute to these docs on GitHub. 
+be sure to contribute to these docs on GitHub.
 
 ### Categories Explained
+
 Game support status is rated on a scale. The placement of a particular
 title is partially left to the article author, but some general guidelines apply.
 
 | Status  | Description                                                                                    |
-|---------|------------------------------------------------------------------------------------------------|
+| ------- | ---------------------------------------------------------------------------------------------- |
 | Gold    | Game works out-of-the-box with no issues and/or requires minimal workarounds.                  |
 | Silver  | Game requires some workarounds, but they are simple and/or there are minor in-game issues      |
 | Bronze  | Game is very difficult to get working and/or has severe in-game issues that limit playability. |
 | Garbage | Game does not work at all.                                                                     |
 
 ### Index
+
+- [Armored Core VI: Fires of Rubicon](./armored-core-6.md)
+- [Blasphemous 2](./blasphemous-2.md)
 - [Cities: Skylines II](./cities-skylines-2.md)
+- [Control](./control.md)
 - [Counter-Strike 2](./counter-strike-2.md)
+- [Cyberpunk 2077](./cyberpunk-2077.md)
+- [Dark Souls III](./dark-souls-3.md)
 - [Diablo IV (Battle.net)](./diablo-4-battle-net.md)
 - [Diablo IV (Steam)](./diablo-4-steam.md)
+- [Dorfromantik](./dorfromantik.md)
 - [Elden Ring](./elden-ring.md)
 - [Elite Dangerous](./elite-dangerous.md)
+- [Grand Theft Auto V](./gta-5.md)
 - [Horizon Zero Dawn](./horizon-zero-dawn.md)
+- [Kenshi](./kenshi.md)
+- [Metal Gear Solid V: The Phantom Pain](./mgs-5.md)
+- [Monster Hunter World: Iceborne](./monster-hunter-world-iceborne.md)
+- [Overwatch 2](./overwatch-2.md)
 - [Persona 3 Reload](./p3r.md)
 - [Palworld](./palworld.md)
 - [r2modman](./r2modman.md)
+- [Sekiro: Shadows Die Twice](./sekiro.md)
 - [Skyrim SE](./skyrim-se.md)
-- [Star Wars Jedi: Fallen Order](./sw-fallen-order.md)
+- [Star Wars Jedi: Fallen Order](./sw-fallen-order.md)

src/game-support/armored-core-6.md

@@ -0,0 +1,8 @@
+# Armored Core VI: Fires of Rubicon
+
+{{#template ../templates/rating.md status=Gold date=08/09/23 installs=Yes opens=Yes}}
+
+## Setup
+- Disable DXVK
+
+{{#template ../templates/steam.md id=1888160}}

src/game-support/blasphemous-2.md

@@ -0,0 +1,5 @@
+# Blasphemous 2
+
+{{#template ../templates/rating.md status=Gold date=08/09/23 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=2114740}}

src/game-support/control.md

@@ -0,0 +1,5 @@
+# Control
+
+{{#template ../templates/rating.md status=Gold date=05/11/23 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=870780}}

src/game-support/cyberpunk-2077.md

@@ -0,0 +1,5 @@
+# Cyberpunk 2077
+
+{{#template ../templates/rating.md status=Gold date=04/11/23 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=1091500}}

src/game-support/dark-souls-3.md

@@ -0,0 +1,5 @@
+# Dark Souls III
+
+{{#template ../templates/rating.md status=Gold date=04/09/23 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=374320}}

src/game-support/dorfromantik.md

@@ -0,0 +1,5 @@
+# Dorfromantik
+
+{{#template ../templates/rating.md status=Gold date=29/09/23 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=1455840}}

src/game-support/gta-5.md

@@ -0,0 +1,7 @@
+# Grand Theft Auto V
+
+{{#template ../templates/rating.md status=Garbage date=09/10/23 installs=No opens=Yes}}
+
+Due to an issue with the Rockstar Launcher, Grand Theft Auto V is currently **unplayable** in Whisky.
+
+{{#template ../templates/steam.md id=271590}}

src/game-support/kenshi.md

@@ -0,0 +1,5 @@
+# Kenshi
+
+{{#template ../templates/rating.md status=Gold date=03/04/24 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=233860}}

src/game-support/mgs-5.md

@@ -0,0 +1,5 @@
+# Metal Gear Solid V: The Phantom Pain
+
+{{#template ../templates/rating.md status=Gold date=29/09/23 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=287700}}

src/game-support/monster-hunter-world-iceborne.md

@@ -0,0 +1,8 @@
+# Monster Hunter World: Iceborne
+
+{{#template ../templates/rating.md status=Gold date=12/10/23 installs=Yes opens=Yes}}
+
+- Do not enable DirectX 12, it will cause the game to crash.
+- A black screen may show instead of the Capcom logo.
+
+{{#template ../templates/steam.md id=1118010}}

src/game-support/overwatch-2.md

@@ -0,0 +1,5 @@
+# Overwatch 2
+
+{{#template ../templates/rating.md status=Garbage date=12/10/23 installs=Yes opens=No}}
+
+{{#template ../templates/steam.md id=2357570}}

src/game-support/sekiro.md

@@ -0,0 +1,5 @@
+# Sekiro: Shadows Die Twice
+
+{{#template ../templates/rating.md status=Gold date=05/09/23 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=814380}}

src/game-support/sw-squadrons.md

@@ -0,0 +1,5 @@
+# Star Wars: Squadrons
+
+{{#template ../templates/rating.md status=Gold date=05/11/23 installs=Yes opens=Yes}}
+
+{{#template ../templates/steam.md id=1222730}}

src/game-support/warframe.md

@@ -0,0 +1,9 @@
+# Warframe
+
+{{#template ../templates/rating.md status=Bronze date=16/11/23 installs=Yes opens=Yes}}
+
+## Setup
+- Go to Bottle Configuration -> Open Wine Configuration -> Libraries
+- Add `dwrite` library and set it to disabled
+
+{{#template ../templates/steam.md id=230410}}

src/guide.md

@@ -2,8 +2,7 @@
 
 Glad you're here. Here's how to get up and running in a breeze.
 
-1. Download Whisky
-    - Download the latest release [here](https://github.com/IsaacMarovitz/Whisky/releases)
+1. [Download Whisky](https://github.com/IsaacMarovitz/Whisky/releases)
 2. Move Whisky to your Applications folder
 3. Open Whisky
 4. Follow on-screen instructions
@@ -12,7 +11,9 @@ Glad you're here. Here's how to get up and running in a breeze.
 
 ## Making your first bottle
 
-Bottles are the bread and butter of Wine. Bottles are like little Windows filesystems, and they appear on your computer as a normal folder. In a bottle, you'll find programs, registry files, and everything else you need to install and configure your Windows 'machine'. Each bottle is self-contained and will only have the programs you installed in that bottle.
+Bottles are the bread and butter of Wine. Bottles are like little Windows filesystems, and they appear on your computer as a normal folder.
+In a bottle, you'll find programs, registry files, and everything else you need to install and configure your Windows 'machine'.
+Each bottle is self-contained and will only have the programs you installed in that bottle.
 
 1. Press the plus button in the top right-hand corner
 2. Give your bottle a name, and select the Windows version you want
@@ -22,7 +23,8 @@ Bottles are the bread and butter of Wine. Bottles are like little Windows filesy
 
 Programs are installed much like you would on a regular Windows machine.
 
-1. Download the program you want to run. It should be the *Windows* version (`.exe` or `.msi`); 64-bit programs are preferable
+1. Download the program you want to run. It should be the *Windows* version (`.exe` or `.msi`);
+   > 64-bit programs are preferable.
 2. Click on the bottle you want to install your program into
 3. Press the `Run...` button in the bottom right
 4. Navigate to where you downloaded your `.exe` or `.msi` file in Finder
@@ -32,8 +34,16 @@ Whisky will then open and run the program. It may take a few seconds for the win
 
 ## Configuring your bottle
 
-In the `Config` menu of your bottle, you can adjust a number of parameters, including the Windows version and build the number of your bottle, enable and disable the Metal HUD, configure ESync, and open Wine's many configuration tools like the Control Panel, Registry Editor, and Wine Configuration dialogues.
+In the `Config` menu of your bottle, you can adjust a number of parameters,
+including the Windows version and build the number of your bottle, enable and disable the Metal HUD,
+configure ESync, and open Wine's many configuration tools like the Control Panel, Registry Editor, and Wine Configuration dialogues.
 
 ## When should I make a new bottle?
 
-The usual convention is to limit a bottle to one game, as dependencies and such can get messy with more installed in one place. If a game requires more extensive configuration to get working, it's usually a good idea to keep it contained. Overal, trust your judgment and separate where it feels right.
+The usual convention is to limit a bottle to one game, as dependencies and such can get messy with more installed in one place.
+If a game requires more extensive configuration to get working, it's usually a good idea to keep it contained.
+Overall, trust your judgment and separate where it feels right.
+
+For Steam games, you can create one shared Windows game library that you use between all of your bottles.
+This helps keep your game installations detached from your bottle instances,
+so you won't have to re-download everything if your bottle mucks up.

src/not-found.md

@@ -0,0 +1,3 @@
+# We couldn't find that page
+
+Return [home](guide.md).

src/paths.md

@@ -1,8 +1,25 @@
-## What's where?
+# What's Where?
+
+Whisky installs files to the following locations:
 
 | Item      | Location                                                           |
 |-----------|--------------------------------------------------------------------|
 | GPTK      | `~/Library/Application Support/com.isaacmarovitz.Whisky/Libraries` |
 | Bottles   | `~/Library/Containers/com.isaacmarovitz.Whisky/Bottles`            |
 | Logs      | `~/Library/Logs/com.isaacmarovitz.Whisky`                          |
-| WhiskyCMD | `/usr/local/bin/whisky`                                            |
+| WhiskyCmd | `/usr/local/bin/whisky`                                            |
+
+# Uninstalling Whisky
+
+If you're looking to do a complete uninstall, remove the following files and folders:
+- `~/Library/Application Support/com.isaacmarovitz.Whisky`
+- `~/Library/Containers/com.isaacmarovitz.Whisky`
+- `~/Library/Logs/com.isaacmarovitz.Whisky`
+- `/usr/local/bin/whisky` (if it exists)
+- `/Applications/Whisky.app` (or wherever you have it installed)
+
+> [!NOTE]
+> This will not delete any bottles that have been created outside the default folder.
+> Make sure you delete those in app by `Right Clicking > Remove...` and selecting `Delete files from disk`.
+> If you forget to do this before deleting Whisky, or some of your bottles have become orphaned,
+> you can remove them manually in Finder.