Skip to content

Commit 1fc4232

Browse files
authored
Update Readme, Lethal Company, paths (#23)
* Add Status descriptions and note about Discord Pings Add descriptions from the Docs and note about pinging Isaac * Update lethal-company.md Add fix for sluggish gameplay * Update README.md Fix numbering error * Update paths.md Add note for finding logs
1 parent b370eb2 commit 1fc4232

File tree

3 files changed

+18
-1
lines changed

3 files changed

+18
-1
lines changed

Diff for: README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,16 @@ Documentation for Whisky.
2626
- Ensure proper grammar, capitalization, spelling, spacing, and general professionalism. Jokes and such are allowed, but lets prioritize helping others before all else.
2727
- Ensure accuracy. Don't upload misleading information, false reports, guesses, or improper research.
2828
- 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.
29+
- 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:
30+
31+
| Status | Description |
32+
| ------- | ---------------------------------------------------------------------------------------------- |
33+
| Gold | Game works out-of-the-box with no issues and/or requires minimal workarounds. |
34+
| Silver | Game requires some workarounds, but they are simple and/or there are minor in-game issues |
35+
| Bronze | Game is very difficult to get working and/or has severe in-game issues that limit playability. |
36+
| Garbage | Game does not work at all. |
2937

30-
1. Create a new markdown file in `~/whisky-book/src/game-support` with the name of the game
38+
1. Create a new markdown file in `~/whisky-book/src/game-support` with the name of the game.
3139
- Format your file in all lowercase, using only alphabetical, numerical, and dash characters, and use abbreviations where possible. i.e:
3240
```
3341
Metal Gear Solid V: The Phantom Pain -> mgs-5.md
@@ -76,3 +84,5 @@ Documentation for Whisky.
7684
6. Sit back, wait for PR reviews, and make changes as necessary.
7785

7886
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.
87+
88+
**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 for: src/game-support/lethal-company.md

+5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
{{#template ../templates/rating.md status=Gold date=04/16/24 installs=Yes opens=Yes}}
44

5+
## Sluggish Gameplay Fix
6+
7+
- Open Settings
8+
- Change `Frame rate cap:` to anything other than `VSync`.
9+
510
> [!NOTE]
611
> 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.
712
> Don't forget to follow the instructions to enable BepInEx if you are using that mod.

Diff for: src/paths.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Whisky installs files to the following locations:
99
| Logs | `~/Library/Logs/com.isaacmarovitz.Whisky` |
1010
| WhiskyCmd | `/usr/local/bin/whisky` |
1111

12+
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`.
13+
1214
# Uninstalling Whisky
1315

1416
If you're looking to do a complete uninstall, remove the following files and folders:

0 commit comments

Comments
 (0)