Merge remote-tracking branch 'upstream/main' into pr/35

.github/workflows/lint.yml

@@ -1,3 +1,5 @@
+name: Check linting
+
 on:
   push:
   pull_request:

.github/workflows/mdbook.yml

@@ -23,6 +23,8 @@ jobs:
       GITHUB_ACTIONS: true
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: actions/setup-node@v4
         with:
           node-version: latest

README.md

@@ -47,11 +47,11 @@ Documentation for Whisky.
    Star Wars Jedi: Fallen Order -> sw-fallen-order.md
    Geometry Wars 3: Dimensions Evolved -> gw3-dimensions-evolved.md
    ```
-2. Add the following template to your markdown file. Ensure the date is properly formatted, leaving zeroes if the month or day is a single digit.
+2. Add the following template to your markdown file.
    ```
    # <Full Game Name Here>
 
-   {{#template ../templates/rating.md status=<status> date=<DD>/<MM>/<YY> installs=<Yes/No> opens=<Yes/No>}}
+   {{#template ../templates/rating.md status=<status> installs=<Yes/No> opens=<Yes/No>}}
    ```
    If your game is a Steam game, add this text at the **bottom** of the page. You can find the Steam ID of a game by going to it's Steam page. It will be the number in the URL bar between `/app/` and `/<game name>/`.
    ```
@@ -61,7 +61,7 @@ Documentation for Whisky.
    ```
    # Star Wars Jedi: Fallen Order
 
-   {{#template ../templates/rating.md status=Gold date=07/17/23 installs=Yes opens=Yes}}
+   {{#template ../templates/rating.md status=Gold installs=Yes opens=Yes}}
    
    ## Setup
    
@@ -74,9 +74,9 @@ Documentation for Whisky.
    <img width="815" alt="Screenshot 2024-04-16 at 10 06 11 PM" src="https://github.com/Whisky-App/whisky-book/assets/161992562/d7d61b1a-5d02-4961-8ff5-b953c2a2fbe1">  
 3. Run the `generate` script with `./scripts/generate.mjs` to update `SUMMARY.md`.
    This will also make the game appear in the sidebar of the book.
-4. Create a pull request detailing the changes you made. Ensure that it's consise, yet readable and coherent.
+4. Run `./scripts/lint.mjs` to ensure that your changes are properly formatted.
+5. Create a pull request detailing the changes you made. Ensure that it's consise, yet readable and coherent.
    - You will need to create a fork of `whisky-book` and push your changes there before creating a PR. Once you've done that, then you can submit a PR to merge your fork with `main`.
-5. Run `./scripts/lint.mjs` to ensure that your changes are properly formatted.
 6. Sit back, wait for PR reviews, and make changes as necessary.
 
 Have any questions about this process or anything Whisky-related? Stop by the [Discord](https://discord.gg/CsqAfs9CnM) and ask us a question! We're more than happy to help.

book.toml

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

src/SUMMARY.md

@@ -14,12 +14,16 @@
   - [Armored Core VI: Fires of Rubicon](./game-support/armored-core-6.md)
   - [Battle Brothers](./game-support/battle-brothers.md)
   - [Betrayer](./game-support/betrayer.md)
+  - [Bioshock Infinite \(Steam\)](./game-support/bioshock-infinite.md)
   - [Blasphemous 2](./game-support/blasphemous-2.md)
   - [Blitzkrieg 2 Anthology](./game-support/blitzkrieg-2-anthology.md)
   - [Buckshot Roulette](./game-support/buckshot-roulette.md)
+  - [Call of Cthulhu: Dark Corners of the Earth](./game-support/call-of-cthulhu-dcote.md)
   - [Call of Cthulhu](./game-support/call-of-cthulhu.md)
   - [Cities: Skylines 2](./game-support/cities-skylines-2.md)
+  - [Call of Juarez: Bound in Blood](./game-support/coj-bound-in-blood.md)
   - [Call of Juarez: Gunslinger](./game-support/coj-gunslinger.md)
+  - [Call of Juarez](./game-support/coj.md)
   - [Content Warning](./game-support/content-warning.md)
   - [Contraband Police](./game-support/contraband-police.md)
   - [Control](./game-support/control.md)
@@ -31,10 +35,12 @@
   - [Dead Space \(2023\)](./game-support/dead-space-2023.md)
   - [Deadlink](./game-support/deadlink.md)
   - [Deep Rock Galactic](./game-support/deep-rock-galactic.md)
+  - [Deus Ex: Game of the Year Edition](./game-support/deus-ex-goty.md)
   - [Diablo IV \(Battle.net\)](./game-support/diablo-4-battle-net.md)
   - [Diablo IV \(Steam\)](./game-support/diablo-4-steam.md)
   - [Dishonored 2](./game-support/dishonored-2.md)
   - [Dishonored](./game-support/dishonored.md)
+  - [Don't Starve](./game-support/dont-starve.md)
   - [Dorfromantik](./game-support/dorfromantik.md)
   - [Dying Light 2](./game-support/dying-light-2.md)
   - [Elden Ring](./game-support/elden-ring.md)
@@ -47,57 +53,90 @@
   - [Forgive Me Father 2](./game-support/forgive-me-father-2.md)
   - [Fortnite](./game-support/fortnite.md)
   - [Friends vs Friends](./game-support/friends-vs-friends.md)
+  - [Guilty Gear -Strive-](./game-support/ggst.md)
+  - [GreedFall](./game-support/greedfall.md)
   - [Grand Theft Auto V](./game-support/gta-5.md)
   - [Guild Wars 2](./game-support/gw2.md)
   - [Geometry Wars 3: Dimensions Evolved](./game-support/gw3-dimensions-evolved.md)
   - [Half-Life 1](./game-support/half-life-1.md)
   - [Half-Life 2](./game-support/half-life-2.md)
+  - [Half Sword Demo](./game-support/half-sword.md)
   - [Hellblade: Senua's Sacrifice](./game-support/hellblade.md)
   - [Hitman: Contracts](./game-support/hitman-3-c.md)
   - [Hearts of Iron III](./game-support/hoi-3.md)
   - [Horizon Zero Dawn](./game-support/horizon-zero-dawn.md)
+  - [Homeworld 3](./game-support/hw-3.md)
+  - [In Sound Mind](./game-support/in-sound-mind.md)
   - [JoJo's Bizarre Adventure: All-Star Battle R](./game-support/jjba-asbr.md)
   - [Kingdom Come: Deliverance](./game-support/kcd.md)
   - [Kenshi](./game-support/kenshi.md)
   - [Kingsway](./game-support/kingsway.md)
+  - [The King of Fighters XV](./game-support/kof15.md)
   - [LEGO Star Wars III: The Clone Wars](./game-support/lego-sw-iii-clone-wars.md)
   - [LEGO Star Wars: The Skywalker Saga](./game-support/lego-sw-skywalker-saga.md)
   - [Lethal Company](./game-support/lethal-company.md)
+  - [Lords Of The Fallen \(2014\)](./game-support/lotf-2014.md)
   - [Manor Lords](./game-support/manor-lords.md)
   - [Mount & Blade: With Fire & Sword](./game-support/mb-wfas.md)
   - [Metro 2033 Redux](./game-support/metro-2033-rx.md)
+  - [Metro Exodus](./game-support/metro-exodus.md)
   - [Metro: Last Light Redux](./game-support/metro-ll-rx.md)
   - [Metal Gear Solid V: The Phantom Pain](./game-support/mgs-5.md)
   - [Monster Hunter World: Iceborne](./game-support/monster-hunter-world-iceborne.md)
+  - [NecroVisioN: Lost Company](./game-support/necrovision-lost-company.md)
+  - [NecroVision](./game-support/necrovision.md)
   - [Neon White](./game-support/neon-white.md)
+  - [NIMBY Rails](./game-support/nimby-rails.md)
+  - [Night Runners Prologue](./game-support/nr-prologue.md)
+  - [Out of Action DEMO](./game-support/out-of-action-demo.md)
   - [Overwatch 2](./game-support/overwatch-2.md)
   - [Persona 3 Reload](./game-support/p3r.md)
   - [Persona 4 Golden](./game-support/p4g.md)
   - [Palworld](./game-support/palworld.md)
+  - [Paradise Lost](./game-support/paradise-lost.md)
   - [People Playground](./game-support/people-playground.md)
   - [Phasmophobia](./game-support/phasmophobia.md)
+  - [A Plague Tale: Innocence](./game-support/plague-tale-innocence.md)
   - [PowerWash Simulator](./game-support/powerwash-simulator.md)
   - [Prey \(2017\)](./game-support/prey-2017.md)
   - [Quake II](./game-support/quake2.md)
   - [r2modman](./game-support/r2modman.md)
   - [Rain World](./game-support/rain-world.md)
   - [Risk of Rain 2](./game-support/risk-of-rain-2.md)
   - [Risk of Rain Returns](./game-support/risk-of-rain-returns.md)
+  - [Return to Castle Wolfenstein](./game-support/rtcw.md)
   - [Ruiner](./game-support/ruiner.md)
   - [Satisfactory](./game-support/satisfactory.md)
   - [Sekiro: Shadows Die Twice](./game-support/sekiro.md)
   - [Skyrim SE](./game-support/skyrim-se.md)
+  - [Sniper: Ghost Warrior 2](./game-support/sniper-gw-2.md)
+  - [Sniper: Ghost Warrior](./game-support/sniper-gw.md)
+  - [S.T.A.L.K.E.R.: Clear Sky](./game-support/stalker-clear-sky.md)
   - [Stardew Valley](./game-support/stardew-valley.md)
   - [Stronghold Crusader HD](./game-support/stronghold-crusader-hd.md)
+  - [Star Wars: Battlefront II \(Classic, 2005\)](./game-support/sw-battlefront2-2005.md)
   - [Star Wars Jedi: Fallen Order](./game-support/sw-fallen-order.md)
   - [Star Wars: Squadrons](./game-support/sw-squadrons.md)
   - [Tom Clancy's Rainbow Six Siege \(Steam\)](./game-support/tcr6s.md)
+  - [Tom Clancy's Splinter Cell Blacklist \(Steam\)](./game-support/tcscb.md)
+  - [Thief II: The Metal Age](./game-support/thief-2.md)
+  - [Thief: Deadly Shadows](./game-support/thief-3.md)
+  - [Thief Gold](./game-support/thief-gold.md)
+  - [Tomb Rider \(2013\)](./game-support/tomb-rider-2013.md)
+  - [Trackmania](./game-support/trackmania.md)
   - [The Stanley Parable: Ultra Deluxe](./game-support/tsp-ud.md)
   - [Turbo Overkill](./game-support/turbo-overkill.md)
   - [Ultrakill](./game-support/ultrakill.md)
   - [Undertale](./game-support/undertale.md)
+  - [Under Night In-Birth II Sys:Celes](./game-support/uni2.md)
+  - [Ultra Street Fighter IV](./game-support/usf4.md)
   - [The Vanishing of Ethan Carter](./game-support/vanishing-of-ethan-carter.md)
   - [Warframe](./game-support/warframe.md)
+  - [The Witcher: Enhanced Edition Director's Cut](./game-support/witcher.md)
+  - [The Witcher 2: Assassins of Kings Enhanced Edition](./game-support/witcher2.md)
   - [The Witcher 3: Wild Hunt](./game-support/witcher3.md)
   - [The Wolf Among Us](./game-support/wolf-among-us.md)
-<!-- script:Generate End -->
+  - [Wolfenstein: The New Order](./game-support/wolfenstein-new-order.md)
+  - [Wolfenstein: The Old Blood](./game-support/wolfenstein-old-blood.md)
+  - [Your Only Move Is Hustle](./game-support/yomi-hustle.md)
+<!-- script:Generate End -->

src/common-issues.md

@@ -5,8 +5,8 @@ Several things can lead to a program not working. The most common reasons are li
 
 | Problem                                                                  | Solution                                                                                                                                                                                                                                                                                                                                                                                                                             |
 |--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| My game stops downloading right before it's finished. | You are most likely downloading a game with `MSync` enabled. Restarting Steam should fix this and your download should continue. You can also fix this issue by switch to `ESync` whenever downloading a game.                                                                                                                                                                                                                       |
-| 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.                                                                                                                |
+| My game stops downloading right before it's finished.                    | You are most likely downloading a game with `MSync` enabled. Restarting Steam should fix this and your download should continue. You can also fix this issue by switch to `ESync` whenever downloading a game.                                                                                                                                                                                                                       |
+| 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 only supported in Rosetta in macOS Sequoia and later. Games using these instructions will not work in macOS Sonoma.                                                                                                                                             |
 | 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/game-support/ac-directors-cut.md

@@ -5,8 +5,11 @@
 
 {{#template ../templates/rating.md status=Bronze installs=Yes opens=Yes}}
 
+## Setup
+
+- Run DX9 version of the game as DX10 version does not render part of the player and NPCs
+
 > [!WARNING]
 > The game suffers from a severe heartbeat-like sound stuttering. Also it's performance is quite poor.
-> DX10 version does not render part of the player and NPCs. DX9 version renders fine.
 
 {{#template ../templates/steam.md id=15100}}

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

@@ -8,6 +8,7 @@
 {{#template ../templates/rating.md status=Gold installs=Yes opens=Yes}}
 
 ## Setup
+
 - Disable DXVK
 
 {{#template ../templates/steam.md id=1888160}}

src/game-support/betrayer.md

@@ -9,4 +9,4 @@
 > [!WARNING]
 > Audio is glitchy - sounds like a mix of original audio quality with 8-bit version of it.
 
-{{#template ../templates/steam.md id=243120}}
+Here is the [Betrayer Steam link](https://store.steampowered.com/app/243120/Betrayer/) as the preview won't be loaded for an unavailable game.

src/game-support/bioshock-infinite.md

@@ -0,0 +1,8 @@
+# Bioshock Infinite (Steam)
+<!-- script:Aliases [] -->
+
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
+
+Bioshock Infinite is currently **unplayable** in Whisky.
+
+{{#template ../templates/steam.md id=8870}}

src/game-support/blitzkrieg-2-anthology.md

@@ -3,7 +3,7 @@
 
 {{#template ../templates/rating.md status=Silver installs=Yes opens=Yes}}
 
-> [!NOTE]
+> [!WARNING]
 > Map Editor does not render map preview but rectangular window artifacts.
 > Audio stutters during intro movies.
 > There may be issue with exiting. Sometimes it is helpful to use the Activity Monitor and Force Quit if in-game button won't help.

src/game-support/call-of-cthulhu-dcote.md

@@ -0,0 +1,9 @@
+# Call of Cthulhu: Dark Corners of the Earth
+<!-- script:Aliases [] -->
+
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+
+> [!WARNING]
+> Launcher works but the game crashes just after entering the fullscreen.
+
+{{#template ../templates/steam.md id=22340}}

src/game-support/coj-bound-in-blood.md

@@ -0,0 +1,9 @@
+# Call of Juarez: Bound in Blood
+<!-- script:Aliases [] -->
+
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+
+> [!WARNING]
+> Opens with a black screen and crashes instantly.
+
+{{#template ../templates/steam.md id=21980}}

src/game-support/coj-gunslinger.md

@@ -1,6 +1,9 @@
 # Call of Juarez: Gunslinger
 <!-- script:Aliases [] -->
 
-{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+
+> [!WARNING]
+> Opens with a black screen and crashes instantly.
 
 {{#template ../templates/steam.md id=204450}}

src/game-support/coj.md

@@ -0,0 +1,9 @@
+# Call of Juarez
+<!-- script:Aliases [] -->
+
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+
+> [!WARNING]
+> DX9 crashes when hitting Escape during a gameplay while DX10 version when selecting "New Game" in the main menu. Repeating this shortcut also changes the mode back. Moreover `ChromEd.exe` editor does not work. The game can change it's presentation from fullscreen to windowed mode and vice versa switching between windows.
+
+{{#template ../templates/steam.md id=3020}}

src/game-support/cyberpunk-2077.md

@@ -3,4 +3,7 @@
 
 {{#template ../templates/rating.md status=Platinum installs=Yes opens=Yes}}
 
+> [!WARNING]
+> Don't set the `Intel Xe Super Sampling` in `Settings` -> `Graphics` as it slowdowns the rendering of intro movies and screens hugely.
+
 {{#template ../templates/steam.md id=1091500}}

src/game-support/deep-rock-galactic.md

@@ -3,6 +3,8 @@
 
 {{#template ../templates/rating.md status=Silver installs=Yes opens=Yes}}
 
-When using a controller, both analog sticks look and move at the same time. The UI takes double clicks to interact. I was not able to find any servers or join any games. Solo missions work perfectly. The game runs well in DX12 mode.
+Requires Wine configuration change to "Automatically caputure the mouse in full-screen windows" to be checked, then the mouse works properly in gameplay and menus.
+
+When using a controller, both analog sticks look and move at the same time. I was not able to find any servers or join any games. Solo missions work perfectly. The game runs well in DX12 mode.
 
 {{#template ../templates/steam.md id=548430}}

src/game-support/deus-ex-goty.md

@@ -0,0 +1,9 @@
+# Deus Ex: Game of the Year Edition
+<!-- script:Aliases [] -->
+
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+
+> [!WARNING]
+> The game starts windowed and shows a black screen regardless of initial configuration you set in the settings wizard.
+
+{{#template ../templates/steam.md id=6910}}

src/game-support/dishonored.md

@@ -5,4 +5,4 @@
 
 The game runs with constant stutters.
 
-{{#template ../templates/steam.md id=205100}}
+{{#template ../templates/steam.md id=217980}}

src/game-support/dont-starve.md

@@ -0,0 +1,10 @@
+# Don't Starve
+<!-- script:Aliases [] -->
+
+{{#template ../templates/rating.md status=Silver installs=Yes opens=Yes}}
+
+> [!NOTE]
+> This game has a native macOS port but it is not available on every store, i.e. GOG.
+> Sound is stuttering a little.
+
+{{#template ../templates/steam.md id=219740}}

src/game-support/fallout-4.md

@@ -3,16 +3,8 @@
 
 {{#template ../templates/rating.md status=Silver installs=Yes opens=Yes}}
 
-The recent Next Gen update now allows the game to launch with audio enabled.
-
 ## Voices and Music Fix
-
-- Add all of the following libraries to the `Wine Configuration` panel.
-  - `x3audio1_6`
-  - `x3audio1_7`
-  - `xaudio2_6`
-  - `xaudio2_7`
-- Adjust your output speaker format in Audio MIDI Setup to reduce popping audio i.e. `48,000hz`
+- Install the `faudio` Winetrick to your bottle
 
 ## Mouse Fix
 - Add `bBackgroundMouse=1` under `[Controls]` in `<Your Bottle>/users/crossover/Documents/My Games/Fallout4/Fallout4.ini`

src/game-support/ggst.md

@@ -0,0 +1,8 @@
+# Guilty Gear -Strive-
+<!-- script:Aliases [] -->
+
+{{#template ../templates/rating.md status=Platinum installs=Yes opens=Yes}}
+
+
+
+{{#template ../templates/steam.md id=1384160}}