Merge pull request #96 from mattmaniak/precise-opens-flag

Precise "opens" flag requirements; fix minor typos

README.md

@@ -29,15 +29,17 @@ Documentation for Whisky.
    - Ensure proper grammar, capitalization, spelling, spacing, and general professionalism. Jokes and such are allowed, but lets prioritize helping others before all else.
    - Ensure accuracy. Don't upload misleading information, false reports, guesses, or improper research.
    - Cite your sources. Found a guide from somewhere else? Found a solution or other thing online? Provide a link in your page. This isn't a requirement that's going to get your PR rejected, but simply one that future-proofs things and ensures that if a game suddenly breaks, we can check our sources and see if there are any updates to the solutions found.
+   - Document the installation process and any errors that arise during the installation. If installation fails, set `installs=No` in the `Ratings` template.
+   - Document whether a program opens by setting `opens=Yes` in the `Ratings` template. A program is considered "open" if it launches the title screen or main menu. Dialog messages don't count as a program "opening".
    - Add status ratings to your game based on the following scale. We leave this up to general author interpretation, but please make sure you're still following these general guidelines:
 
     | Status   | Description                                                                                    |
     |----------|------------------------------------------------------------------------------------------------|
     | Platinum | Game without any defects and runs perfectly.                                                   |
     | Gold     | Game can be configured to run perfectly and without any defects.                               |
     | Silver   | Game requires some configuration to run and or has minor defects.                              |
-    | 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.                                                                     |
+    | Bronze   | Game is very difficult to get working and or has severe in-game issues that limit playability. |
+    | Garbage  | Game is unplayable.                                                                            |
 
 1. Create a new markdown file in `~/whisky-book/src/game-support` with the name of the game.
    - Format your file in all lowercase, using only alphabetical, numerical, and dash characters, and use abbreviations where possible. i.e:
@@ -57,7 +59,7 @@ Documentation for Whisky.
    ```
    {{#template ../templates/steam.md id=<steam_id>}}
    ```
-   Ensure that you're replacing the <> tags with the proper values in order to comply with the wiki layout. Below is an example of what [Star Wars Jedi: Fallen Order](https://docs.getwhisky.app/game-support/sw-fallen-order.html) will look like, and what it will look like on the wiki.
+   Ensure that you're replacing the `<>` tags with the proper values in order to comply with the wiki layout. Below is an example of what [Star Wars Jedi: Fallen Order](https://docs.getwhisky.app/game-support/sw-fallen-order.html) will look like, and what it will look like on the wiki.
    ```
    # Star Wars Jedi: Fallen Order
 

src/game-support/README.md

@@ -16,6 +16,4 @@ title is partially left to the article author, but some general guidelines apply
 | Gold     | Game can be configured to run perfectly and without any defects.                               |
 | Silver   | Game requires some configuration to run and or has minor defects.                              |
 | 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.                                                                     |
-
-
+| Garbage  | Game is unplayable.                                                                            |

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

@@ -9,6 +9,6 @@
 
 ## Setup
 
-- Disable DXVK
+- Disable DXVK.
 
 {{#template ../templates/steam.md id=1888160}}

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

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

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

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

src/game-support/coj-gunslinger.md

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

src/game-support/deadlink.md

@@ -1,7 +1,7 @@
 # Deadlink
 <!-- script:Aliases [] -->
 
-{{#template ../templates/rating.md status=Silver installs=Yes opens=Yes}} 
+{{#template ../templates/rating.md status=Silver installs=Yes opens=Yes}}
 
 Viewing an effect for the first time will cause the game to hang for a second. After a few minutes of gameplay stutters stop and the game runs perfectly.
 

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

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

src/game-support/fallout-3-goty.md

@@ -3,7 +3,7 @@
     "Fallout 3"
 ] -->
 
-{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
 
 > [!WARNING]
 > The game freezes completely during intro company movies and/or in the main menu.

src/game-support/greedfall.md

@@ -1,7 +1,7 @@
 # GreedFall
 <!-- script:Aliases [] -->
 
-{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
 
 > [!WARNING]
 > Crashes instantly.

src/game-support/lego-sw-iii-clone-wars.md

@@ -7,7 +7,7 @@
     "Lego Star Wars 3"
 ] -->
 
-{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}} 
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}} 
 
 > [!WARNING]
 > Opening scene is flashing a lot with some simply colored rectangles. In the middle of that, the game crashes.

src/game-support/lotf-2014.md

@@ -1,7 +1,7 @@
 # Lords Of The Fallen (2014)
 <!-- script:Aliases [] -->
 
-{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
 
 > [!WARNING]
 > Crashes instantly.

src/game-support/mb-wfas.md

@@ -1,7 +1,7 @@
 # Mount & Blade: With Fire & Sword
 <!-- script:Aliases [] -->
 
-{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
 
 > [!WARNING]
 > Freezes after showing a Bing logo with a black screen.

src/game-support/prey-2017.md

@@ -3,9 +3,9 @@
     "Prey 2017"
 ] -->
 
-{{#template ../templates/rating.md status=Gold installs=Yes opens=Yes}} 
+{{#template ../templates/rating.md status=Gold installs=Yes opens=Yes}}
 
-Main game and Mooncrash DLC running smoothly 
+Main game and Mooncrash DLC running smoothly.
 
 > [!NOTE]
 > Turning V-Sync off will fix any slowdowns that occur. Unfortunately, you may have some screen-tearing.

src/game-support/rtcw.md

@@ -3,7 +3,7 @@
     "RTCW"
 ] -->
 
-{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
 
 > [!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.

src/game-support/sniper-gw.md

@@ -1,7 +1,7 @@
 # Sniper: Ghost Warrior
 <!-- script:Aliases [] -->
 
-{{#template ../templates/rating.md status=Garbage installs=Yes opens=Yes}}
+{{#template ../templates/rating.md status=Garbage installs=Yes opens=No}}
 
 > [!WARNING]
 > Crashes instantly.

src/game-support/uni2.md

@@ -5,7 +5,7 @@
 
 ## Setup
 
-- In Whisky, install d3dx9 using winetricks.
+- In Whisky, install `d3dx9` using Winetricks.
 - Install in Steam as normal.
 
 Game works perfectly, but movies will not play.