You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: README.md
+11-1
Original file line number
Diff line number
Diff line change
@@ -26,8 +26,16 @@ Documentation for Whisky.
26
26
- Ensure proper grammar, capitalization, spelling, spacing, and general professionalism. Jokes and such are allowed, but lets prioritize helping others before all else.
- 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:
| 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. |
29
37
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.
31
39
- Format your file in all lowercase, using only alphabetical, numerical, and dash characters, and use abbreviations where possible. i.e:
32
40
```
33
41
Metal Gear Solid V: The Phantom Pain -> mgs-5.md
@@ -76,3 +84,5 @@ Documentation for Whisky.
76
84
6. Sit back, wait for PR reviews, and make changes as necessary.
77
85
78
86
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.**
- Change `Frame rate cap:` to anything other than `VSync`.
9
+
5
10
> [!NOTE]
6
11
> 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.
7
12
> Don't forget to follow the instructions to enable BepInEx if you are using that mod.
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
+
12
14
# Uninstalling Whisky
13
15
14
16
If you're looking to do a complete uninstall, remove the following files and folders:
0 commit comments