Inital Commit

.gitignore

@@ -0,0 +1,2 @@
+book
+.idea

book.toml

@@ -0,0 +1,22 @@
+[book]
+authors = ["Isaac Marovitz"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Whisky Documentation"
+
+[preprocessor.alerts]
+
+[preprocessor.template]
+
+[output.html]
+default-theme = "dark"
+git-repository-url = "https://github.com/Whisky-App/Whisky"
+git-repository-icon = "fa-github"
+input-404 = "not-found.md"
+
+[output.html.print]
+enable = false
+
+[output.html.fold]
+enable = true

src/SUMMARY.md

@@ -0,0 +1,18 @@
+# Summary
+
+- [Guide](./guide.md)
+- [Common Issues](./common-issues.md)
+- [What's Where?](./paths.md)
+- [Whisky vs. CrossOver](./cx.md)
+- [Game Support](./game-support/README.md)
+  - [Cities: Skylines II](./game-support/cities-skylines-2.md)
+  - [Counter-Strike 2](./game-support/counter-strike-2.md)
+  - [Diablo IV (Battle.net)](./game-support/diablo-4-battle-net.md)
+  - [Diablo IV (Steam)](./game-support/diablo-4-steam.md)
+  - [Elden Ring](./game-support/elden-ring.md)
+  - [Elite Dangerous](./game-support/elite-dangerous.md)
+  - [Horizon Zero Dawn](./game-support/horizon-zero-dawn.md)
+  - [Persona 3 Reload](./game-support/p3r.md)
+  - [Palworld](./game-support/palworld.md)
+  - [Skyrim SE](./game-support/skyrim-se.md)
+  - [Star Wars Jedi: Fallen Order](./game-support/sw-fallen-order.md)

src/common-issues.md

@@ -0,0 +1,11 @@
+
+## 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.|

src/cx.md

@@ -0,0 +1,22 @@
+## Whisky or CrossOver?
+
+There are a lot of questions about which is better, here's an easy chart:
+
+| Feature                  | Whisky | CrossOver |
+|--------------------------|--------|-----------|
+| Entirely Open-Source     | ✅      | ❌         |
+| Free Updates Forever     | ✅      | ❌         |
+| MSync                    | ✅      | ✅         |
+| ESync                    | ✅      | ✅         |
+| DirectX 12 Support       | ✅      | ✅         |
+| Automated Installation   | ❌      | ✅         |
+| Denuvo Support           | ❌      | ✅         |
+| EA App Support           | ❌      | ✅         |
+| Battle.net Support       | ❌      | ✅         |
+| Ubisoft Connect Support  | ❌      | ✅         |
+| OOTB GStreamer Support   | ❌      | ✅         |
+| Wine 9 Support           | ❌      | ✅         |
+| Proper Technical Support | ❌      | ✅         |
+| Future Updates to Wine   | ❌      | ✅         |
+
+TLDR; CrossOver supports more apps than Whisky, and provides a more seamless user experience when Wine doesn't want to work out of the box. Which ever is best will depend on your needs and use case. 

src/game-support/README.md

@@ -0,0 +1,30 @@
+# Game Support
+
+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. 
+
+### 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
+- [Cities: Skylines II](./game-support/cities-skylines-2.md)
+- [Counter-Strike 2](./game-support/counter-strike-2.md)
+- [Diablo IV (Battle.net)](./game-support/diablo-4-battle-net.md)
+- [Diablo IV (Steam)](./game-support/diablo-4-steam.md)
+- [Elden Ring](./game-support/elden-ring.md)
+- [Elite Dangerous](./game-support/elite-dangerous.md)
+- [Horizon Zero Dawn](./game-support/horizon-zero-dawn.md)
+- [Persona 3 Reload](./p3r.md)
+- [Palworld](./game-support/palworld.md)
+- [Skyrim SE](./game-support/skyrim-se.md)
+- [Star Wars Jedi: Fallen Order](./game-support/sw-fallen-order.md)

src/game-support/cities-skylines-2.md

@@ -0,0 +1,23 @@
+# Cities: Skylines 2
+
+{{#template ../templates/rating.md status=Bronze date=11/28/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Install in Steam as normal
+- Go back to Whisky, and press File > Kill All Bottles
+- On your bottle click `Winetricks...`
+- Install the following tricks in the following order\
+  `dotnet48 win10`
+
+> [!NOTE]
+> This will require user interaction and will likely take a rather long time to complete
+
+- Follow the instructions to patch your game [here](https://github.com/manolz1/cities2-gptk-fix)
+- Start Cities: Skylines 2 from Steam as normal
+
+> [!WARNING]
+> - Tabbing out will cause the game to become unresponsive and require it to be restarted. Do **not** change window focus while playing.
+> - Subsequent launches may fail to open the Paradox Launcher. This can be resolved temporarily by deleting the `Paradox Interactive` folder in `Program Files`. Reinstalling the launcher may also be required.
+
+{{#template ../templates/steam.md id=949230}}

src/game-support/counter-strike-2.md

@@ -0,0 +1,16 @@
+# Counter-Strike 2
+
+{{#template ../templates/rating.md status=Silver date=10/24/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Install in Steam as normal
+- Right-click > Properties...
+- Add `-nojoy` as launch option
+
+> [!IMPORTANT]
+> This will disable controller input, but improves the FPS from 10 -> 100
+
+- Start CS2 from Steam as normal
+
+{{#template ../templates/steam.md id=730}}

src/game-support/diablo-4-battle-net.md

@@ -0,0 +1,14 @@
+# Diablo IV - Battle.net Version
+
+{{#template ../templates/rating.md status=Silver date=07/13/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Go to Config
+    - Change Windows Version to 19042 (Make sure to press enter to submit the change)
+    - Change Enhanced Sync mode to `ESync`
+- Install Battle.net
+- On the Battle.net login screen, press the cog icon in the top right. Click on `Advanced`, and disable `Use hardware acceleration when available`
+- Go back to Whisky. Click on `File` > `Kill All Bottles`
+- Restart Battle.net
+- Login and install Diablo IV as normal

src/game-support/diablo-4-steam.md

@@ -0,0 +1,15 @@
+# Diablo IV - Steam Version
+
+{{#template ../templates/rating.md status=Silver date=07/13/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Go to Config
+    - Change Windows Version to 19042 (Make sure to press enter to submit the change)
+    - Change Enhanced Sync mode to `ESync`
+- Install in Steam as normal
+- Install Diablo IV as normal
+- Delete `dstorage.dll` at `Program Files(x86)/steam/steamapps/common/Diablo IV`
+- Start Diablo IV as normal
+
+{{#template ../templates/steam.md id=2344520}}

src/game-support/elden-ring.md

@@ -0,0 +1,16 @@
+# Elden Ring
+
+{{#template ../templates/rating.md status=Silver date=07/13/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Install in Steam as normal
+- In Whisky, find `elden_ring.exe` in the Program list and press `Show in Finder`
+- Rename `start_protected_game.exe` to something else, and rename `elden_ring.exe` to `start_protected_game.exe`
+
+> [!IMPORTANT]
+> This will disable online play features
+
+- Start Elden Ring from Steam as normal
+
+{{#template ../templates/steam.md id=1245620}}

src/game-support/elite-dangerous.md

@@ -0,0 +1,14 @@
+# Elite Dangerous
+
+{{#template ../templates/rating.md status=Bronze date=01/12/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Install Steam
+- Install Elite Dangerous
+- Follow setup instructions here: https://github.com/rfvgyhn/min-ed-launcher#steam
+- Modify `gamesettings.json` in `users/crossover/AppData/Local/min-ed-launcher` and add the following line\
+  `"gameStartDelay": 5,`
+- Run Elite Dangerous as normal
+
+{{#template ../templates/steam.md id=359320}}

src/game-support/horizon-zero-dawn.md

@@ -0,0 +1,15 @@
+# Horizon Zero Dawn
+
+{{#template ../templates/rating.md status=Silver date=08/09/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Install Horizon Zero Dawn as normal
+- On your bottle click `Config` then `Open Registry Editor`
+- Navigate to `HKEY_LOCAL_MACHINE > Hardware > Description > System > CentralProcessor > 0`
+- Double-click to edit the `~MHz` key
+- Change the base to `Decimal` and type the value `1100`
+- Press `OK`, then close the Registry Editor
+- Start Horizon Zero Dawn as normal
+
+{{#template ../templates/steam.md id=1151640}}

src/game-support/p3r.md

@@ -0,0 +1,20 @@
+# Persona 3 Reload
+
+{{#template ../templates/rating.md status=Gold date=02/04/24 installs=Yes opens=Yes}}
+
+## Setup
+
+While the latest update of Persona 3 Reload is not playable,
+the initial release is. This version is still downloadable using
+the following steps.    
+
+- In Whisky, right-click Steam and add `-console` to the arguments
+- Relaunch Steam, and click on the `Console` tab
+- Run the following command `download_depot 2161700 2161701 8645735232972037477`
+- Wait for download to finish
+- Open the reported download location in Finder.
+- Right-click on the game in Steam and browse local files
+- Replace the main installation files with the ones you just downloaded
+- Right-click on the game in Steam and disable automatic updates
+
+{{#template ../templates/steam.md id=2161700}}

src/game-support/palworld.md

@@ -0,0 +1,16 @@
+# Palworld
+
+{{#template ../templates/rating.md status=Silver date=11/28/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Install in Steam as normal
+- Right-click > Properties...
+- Add `-dx12` as launch option
+- Start Palworld from Steam as normal
+- When prompted about incompatible drivers, click `No`
+
+> [!NOTE]
+> Some small graphical issues remain, such as black eye shaders, however the game is fully playable.
+
+{{#template ../templates/steam.md id=1623730}}

src/game-support/skyrim-se.md

@@ -0,0 +1,19 @@
+# Skyrim SE
+
+{{#template ../templates/rating.md status=Silver date=08/09/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Install in Steam as normal
+- In Whisky, find `SkyrimSELauncher.exe` in the Program list and press `Show in Finder`
+- Rename `SkyrimSELauncher.exe` to something else, and rename `SkyrimSE.exe` to `SkyrimSELauncher.exe`
+- On your bottle click `Winetricks...`
+- Install the following tricks in the following order\
+  `dotnet48 vcrun2019 dxvk1103 d3dx11_43 d3dcompiler_43 d3dcompiler_47 faudio`
+
+> [!NOTE]
+> This will require user interaction and will likely take a rather long time to complete
+
+- Start Skyrim from Steam as normal
+
+{{#template ../templates/steam.md id=489830}}

src/game-support/sw-fallen-order.md

@@ -0,0 +1,10 @@
+# Star Wars Jedi: Fallen Order
+
+{{#template ../templates/rating.md status=Gold date=07/17/23 installs=Yes opens=Yes}}
+
+## Setup
+
+- Install in Steam as normal
+- In Whisky, find `SwGame-Win64-Shipping.exe` in the Program list and run it
+
+{{#template ../templates/steam.md id=1172380}}

src/guide.md

@@ -0,0 +1,39 @@
+# A Hitchhiker's Guide to Whisky
+
+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)
+2. Move Whisky to your Applications folder
+3. Open Whisky
+4. Follow on-screen instructions
+
+**Everything is now installed!**
+
+## 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.
+
+1. Press the plus button in the top right-hand corner
+2. Give your bottle a name, and select the Windows version you want
+3. Hit `Create` and wait a few seconds. When your bottle is ready, it'll appear in the list on the left-hand side
+
+## Installing your first program
+
+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
+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
+5. Select the file and press `Open`
+
+Whisky will then open and run the program. It may take a few seconds for the window to appear, so be patient.
+
+## 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.
+
+## 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.

src/paths.md

@@ -0,0 +1,8 @@
+## What's where?
+
+| 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`                                            |

src/templates/rating.md

@@ -0,0 +1 @@
+Status: [[#status]] | Last Tested: [[#date]] | Installs: [[#installs]] | Opens: [[#opens]]

src/templates/steam.md

@@ -0,0 +1,10 @@
+<br/>
+<iframe 
+    frameborder="0" 
+    width="100%"
+    height="200" 
+    scrolling="no"
+    allowtransparency="true"
+    style="color-scheme: normal; background-color: transparent;"
+    src="https://store.steampowered.com/widget/[[#id]]">
+</iframe>