diff --git a/README.md b/README.md index 2eb7970e..1fcabc4a 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,16 @@ 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. + - 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 | + | ------- | ---------------------------------------------------------------------------------------------- | + | 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. | -1. Create a new markdown file in `~/whisky-book/src/game-support` with the name of the game +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: ``` Metal Gear Solid V: The Phantom Pain -> mgs-5.md @@ -76,3 +84,5 @@ Documentation for Whisky. 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. + +**Please do not ping Isaac for general support or requests to view your PR. He is a busy person, has likely seen what you have said/submitted, and will reply when he can.** diff --git a/src/game-support/lethal-company.md b/src/game-support/lethal-company.md index 15476392..0f01a52a 100644 --- a/src/game-support/lethal-company.md +++ b/src/game-support/lethal-company.md @@ -2,6 +2,11 @@ {{#template ../templates/rating.md status=Gold date=04/16/24 installs=Yes opens=Yes}} +## Sluggish Gameplay Fix + +- Open Settings +- Change `Frame rate cap:` to anything other than `VSync`. + > [!NOTE] > If you want to use mods with Lethal Company, consider following the [r2modman](https://docs.getwhisky.app/game-support/r2modman.html) guide to install the mod launcher. > Don't forget to follow the instructions to enable BepInEx if you are using that mod. diff --git a/src/paths.md b/src/paths.md index 9c692bee..8ffd2b4b 100644 --- a/src/paths.md +++ b/src/paths.md @@ -9,6 +9,8 @@ Whisky installs files to the following locations: | Logs | `~/Library/Logs/com.isaacmarovitz.Whisky` | | WhiskyCmd | `/usr/local/bin/whisky` | +Note that you may need to press `⌘ + Shift + .` to view hidden files, and that `com.isaacmarovitz.Whisky` may show up as a folder simply titled `Whisky`. + # Uninstalling Whisky If you're looking to do a complete uninstall, remove the following files and folders: