Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
hahayupgit authored Jul 11, 2024
2 parents 42cb3e2 + e298ac2 commit 9229358
Show file tree
Hide file tree
Showing 40 changed files with 278 additions and 27 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/mdbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ 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>
Expand All @@ -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.
Expand Down
23 changes: 23 additions & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@
- [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)
Expand All @@ -31,6 +34,7 @@
- [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)
Expand All @@ -49,6 +53,7 @@
- [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)
Expand All @@ -60,6 +65,7 @@
- [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)
Expand All @@ -76,6 +82,8 @@
- [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)
- [Night Runners Prologue](./game-support/nr-prologue.md)
- [Out of Action DEMO](./game-support/out-of-action-demo.md)
Expand All @@ -86,30 +94,45 @@
- [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)
- [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)
- [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)
- [Ultra Street Fighter IV](./game-support/usf4.md)
- [Under Night In-Birth II Sys:Celes](./game-support/uni2.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)
- [Your Only Move Is Hustle](./game-support/yomi-hustle.md)
- [Wolfenstein: The New Order](./game-support/wolfenstein-new-order.md)
- [Wolfenstein: The Old Blood](./game-support/wolfenstein-old-blood.md)
<!-- script:Generate End -->
4 changes: 2 additions & 2 deletions src/common-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
5 changes: 4 additions & 1 deletion src/game-support/ac-directors-cut.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
1 change: 1 addition & 0 deletions src/game-support/armored-core-6.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
{{#template ../templates/rating.md status=Gold installs=Yes opens=Yes}}

## Setup

- Disable DXVK

{{#template ../templates/steam.md id=1888160}}
2 changes: 1 addition & 1 deletion src/game-support/blitzkrieg-2-anthology.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 9 additions & 0 deletions src/game-support/call-of-cthulhu-dcote.md
Original file line number Diff line number Diff line change
@@ -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}}
9 changes: 9 additions & 0 deletions src/game-support/coj-bound-in-blood.md
Original file line number Diff line number Diff line change
@@ -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}}
5 changes: 4 additions & 1 deletion src/game-support/coj-gunslinger.md
Original file line number Diff line number Diff line change
@@ -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}}
9 changes: 9 additions & 0 deletions src/game-support/coj.md
Original file line number Diff line number Diff line change
@@ -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}}
3 changes: 3 additions & 0 deletions src/game-support/cyberpunk-2077.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
4 changes: 3 additions & 1 deletion src/game-support/deep-rock-galactic.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
9 changes: 9 additions & 0 deletions src/game-support/deus-ex-goty.md
Original file line number Diff line number Diff line change
@@ -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}}
9 changes: 9 additions & 0 deletions src/game-support/greedfall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# GreedFall
<!-- script:Aliases [] -->

{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}

> [!WARNING]
> Crashes instantly.
{{#template ../templates/steam.md id=606880}}
3 changes: 2 additions & 1 deletion src/game-support/gw2.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

{{#template ../templates/rating.md status=Gold installs=Yes opens=Yes}}

## Setup
## Setup

- Enable DXVK in Bottle Configuration

### Direct
Expand Down
12 changes: 1 addition & 11 deletions src/game-support/horizon-zero-dawn.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
# Horizon Zero Dawn
<!-- script:Aliases [] -->

{{#template ../templates/rating.md status=Silver 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/rating.md status=Platinum installs=Yes opens=Yes}}

{{#template ../templates/steam.md id=1151640}}
10 changes: 10 additions & 0 deletions src/game-support/in-sound-mind.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# In Sound Mind
<!-- script:Aliases [] -->

{{#template ../templates/rating.md status=Gold installs=Yes opens=Yes}}

## Setup

- Enable V-Sync as the game without it speed ups the movement innaturally.

{{#template ../templates/steam.md id=1119980}}
2 changes: 1 addition & 1 deletion src/game-support/lotf-2014.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Lords Of The Fallen (2014)
<!-- script:Aliases [] -->

{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}

> [!WARNING]
> Crashes instantly.
Expand Down
2 changes: 1 addition & 1 deletion src/game-support/mb-wfas.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Mount & Blade: With Fire & Sword
<!-- script:Aliases [] -->

{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}

> [!WARNING]
> Freezes after showing a Bing logo with a black screen.
Expand Down
7 changes: 4 additions & 3 deletions src/game-support/metro-exodus.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@

{{#template ../templates/rating.md status=Bronze installs=Yes opens=Yes}}

> [!NOTE]
> Enhanced Edition won't open due to the lack of DXR 1.1 (DirectX 12's Raytracing) support. The standard one runs well.
## Setup

- Install the standard version rather than the Enhanced Edition. Otherwise it won't open due to the lack of DXR 1.1 (DirectX 12's Raytracing) support.

> [!WARNING]
> There is an issue with setting higher resolution, including native when it is already lowered. Then a screen resolution can be restored to native only in the config file as the game does not show anything above the actually lowered screen resolution. It can be done via `user.cfg` which is located in the game installation directory, not in the Windows' `Documents` like mentioned elsewhere. Also colorful normal maps appear sometimes on metal and wooden surfaces and within some particles types. Changing audio output in macOS turns the game's audio off. It is required to restart the game then.
> There is an issue with setting higher resolution, including native when it is already lowered. Then a screen resolution can be restored to native only in the config file as the game does not show anything above the actually lowered screen resolution. It can be done via `user.cfg` which is located in the game installation directory, not in the Windows' `Documents` like mentioned elsewhere. Also colorful normal maps appear sometimes on also random surfaces and within some particles types. Changing audio output in macOS turns the game's audio off. It is required to restart the game then. A system cursor appears sometimes in the "Sam's Story" DLC.
{{#template ../templates/steam.md id=412020}}
9 changes: 9 additions & 0 deletions src/game-support/necrovision-lost-company.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# NecroVisioN: Lost Company
<!-- script:Aliases [] -->

{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}

> [!WARNING]
> The game does not launch while Pain Editor crashes instantly.
{{#template ../templates/steam.md id=46250}}
9 changes: 9 additions & 0 deletions src/game-support/necrovision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# NecroVision
<!-- script:Aliases [] -->

{{#template ../templates/rating.md status=Silver installs=Yes opens=Yes}}

> [!NOTE]
> Some UI elements are not positioned propely and they are cut by the screen edge a little.
{{#template ../templates/steam.md id=7860}}
6 changes: 6 additions & 0 deletions src/game-support/plague-tale-innocence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# A Plague Tale: Innocence
<!-- script:Aliases [] -->

{{#template ../templates/rating.md status=Platinum installs=Yes opens=Yes}}

{{#template ../templates/steam.md id=752590}}
11 changes: 11 additions & 0 deletions src/game-support/rtcw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Return to Castle Wolfenstein
<!-- script:Aliases [
"RTCW"
] -->

{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}

> [!WARNING]
> The game stops with a black screen window when loading and displays [Could Not Load OpenGL Subsystem](https://steamcommunity.com/app/9010/discussions/0/540740501210124263/) error.
{{#template ../templates/steam.md id=9010}}
Loading

0 comments on commit 9229358

Please sign in to comment.