Skip to content

Commit

Permalink
Some Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@DaXcess
DaXcess committed Nov 4, 2024
1 parent 1007309 commit e14ee36
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 15 deletions.
28 changes: 16 additions & 12 deletions Docs/Thunderstore/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<details>
<summary>Jumpscare</summary>

<img src="https://github.com/DaXcess/LCVR/blob/assets/pino.jpg?raw=true" />
<img src="https://github.com/DaXcess/LCVR/blob/assets/pino.jpg?raw=true" alt="Kitty" />
</details>
<br/>

Expand Down Expand Up @@ -45,7 +45,7 @@ The public key which can be used to verify the file is [9422426F6125277B82CC477D

### Bypassing integrity checks

To prevent completely destroying the game, this mod scans the game assembly and tries to detect whether it's using a supported version or not. If this check fails, the mod will assume that either the game was updated, or the game files have been corrupted, and will refuse to start the mod. You can disable this behaviour by passing `--lcvr-skip-checksum` to the game's launch options in Steam.
To prevent completely destroying the game, this mod scans the game assembly and tries to detect whether it's using a supported version or not. If this check fails, the mod will assume that either the game was updated, or the game files have been corrupted, and will refuse to start the mod. You can disable this behaviour by passing `--lcvr-skip-checksum=<version>` to the game's launch options in Steam, where `<version>` is the LCVR version being used.

### Discord Server

Expand All @@ -59,7 +59,9 @@ Here is a list of LCVR versions and which version(s) of Lethal Company it suppor

| LCVR | Lethal Company |
|-------------------|-------------------|
| v1.3.4 *(LATEST)* | V64 and V64.1 |
| v1.3.6 *(LATEST)* | V64 - V67 |
| v1.3.5 | V64 - V66 |
| v1.3.4 | V64 and V64.1 |
| v1.3.3 | V64 and V64.1 |
| v1.3.2 | V64 |
| v1.3.1 | V62 |
Expand All @@ -81,6 +83,8 @@ Here is a list of LCVR versions and which version(s) of Lethal Company it suppor
| v1.0.1 | V45 and V49 |
| v1.0.0 | V45 and V49 |

> LCVR versions from 1.3.6 and above also check hashes remotely, meaning newer Lethal Company versions might be supported even though they aren't listed here.
# Compatibility

Most mods should all work fine with LCVR, like interior mods, new moons, most items, etc. There's also a small handful of mods that have been explicitly made compatible with VR.
Expand Down Expand Up @@ -121,13 +125,13 @@ Go to the settings, then press "Change keybinds", and scroll all the way down to
# Main Menu

<img src="https://github.com/DaXcess/LCVR/blob/assets/main-menu.webp?raw=true" height="300" />
<img src="https://github.com/DaXcess/LCVR/blob/assets/main-menu.webp?raw=true" height="300" alt="The main menu in VR" />

The main menu is controlled by ray interactors. You can use any controller to point towards any UI element and click using the trigger button on the corresponding controller. In the main menu you also have access to a keyboard when you focus any input element, so that you can change your lobby name, tags, or change settings using the VR settings menu.

# The Terminal

<img src="https://github.com/DaXcess/LCVR/blob/assets/terminal.webp?raw=true" height="300" />
<img src="https://github.com/DaXcess/LCVR/blob/assets/terminal.webp?raw=true" height="300 alt="The terminal in VR" />

Since in VR you don't have access to a keyboard (under normal circumstances), the mod displays a virtual keyboard when you enter the terminal. You can use this keyboard to interact with the terminal like you would on PC.

Expand All @@ -139,7 +143,7 @@ You can exit the terminal by pressing the pause button or by clicking on the clo

LCVR features a bunch of new interactions that VR players can use to interact with the world around them, without having to use a boring invisible laser and a simple controller binding.

> All of the following interactions can be disabled individually inside the config
> All the following interactions can be disabled individually inside the config
- **Ship Lever**

Expand All @@ -151,7 +155,7 @@ LCVR features a bunch of new interactions that VR players can use to interact wi

- **Charging Station**

Hate being forced to stand in front of the charging station every time you charge an item? Well now you can just hold any item that has a battery, and just hold it up to the charging station. Voila, your item has now been charged. If you pull the item out too quickly though, the charger will not charge your item!
Hate being forced to stand in front of the charging station every time you charge an item? Well now you can just hold any item that has a battery, and just hold it up to the charging station. Voilà, your item has now been charged. If you pull the item out too quickly though, the charger will not charge your item!
_This interaction only works on the right hand. Putting your left hand inside the charger will make you just look like an idiot._

- **Ship Door**
Expand All @@ -177,7 +181,7 @@ LCVR features a bunch of new interactions that VR players can use to interact wi
_This interaction only works when you are using your pointer finger, a fist or flat hand will not work_

- **Doors**
Always had the issue where like a billion people tried to open the same door and it just keeps opening and closing and you can't get through? Well now you actually have to interact with the door handle to open and close the door. Is a door locked? Find out by trying to open the door and listen for the sound cue (or just notice that it doesn't open, whatever). To use a key on a door, interact with the door handle using your right hand while holding a key. Same thing for the lockpicker, however picking up the lockpicker when it is placed on a door also requires you to physically grab it. When the lockpicker is an item on the floor, it will behave normally, and can be picked up from a distance.
Always had the issue where like a billion people tried to open the same door, and it just keeps opening and closing, and you can't get through? Well now you actually have to interact with the door handle to open and close the door. Is a door locked? Find out by trying to open the door and listen for the sound cue (or just notice that it doesn't open, whatever). To use a key on a door, interact with the door handle using your right hand while holding a key. Same thing for the lockpicker, however picking up the lockpicker when it is placed on a door also requires you to physically grab it. When the lockpicker is an item on the floor, it will behave normally, and can be picked up from a distance.

- **Face**

Expand All @@ -186,13 +190,13 @@ LCVR features a bunch of new interactions that VR players can use to interact wi

### Muffle

Hate it when you die to a dog because your frantic screaming caused you to lure the canines towards your location? Just hold your hand in front of your mouth, and none of the enemies will be able to hear you anymore! As a bonus, anyone with the VR mod will now hear your voice muffled, as if you got snatched by a snare flea. However be warned, the longer you hold your hand in front of your mouth, the less you will be able to see _(only until a hard limit, you will not be completely blinded)_.
Hate it when you die to a dog because your frantic screaming caused you to lure the canines towards your location? Just hold your hand in front of your mouth, and none of the enemies will be able to hear you anymore! As a bonus, anyone with the VR mod will now hear your voice muffled, as if you got snatched by a snare flea. Be warned however, the longer you hold your hand in front of your mouth, the less you will be able to see _(only until a hard limit, you will not be completely blinded)_.

# VR additions

<div>
<img src="https://github.com/DaXcess/LCVR/blob/assets/shovel.webp?raw=true" height="250" />
<img src="https://github.com/DaXcess/LCVR/blob/assets/spray.webp?raw=true" height="250" />
<img src="https://github.com/DaXcess/LCVR/blob/assets/shovel.webp?raw=true" height="250" alt="Using the shovel in VR" />
<img src="https://github.com/DaXcess/LCVR/blob/assets/spray.webp?raw=true" height="250" alt="Using the spray paint in VR" />
</div>

This mod, in addition to adding VR and motion controls, also adds a few special interactions that you can perform in VR. At the time of writing, these currently are:
Expand All @@ -210,7 +214,7 @@ Hate having to just watch a flat screen where your fellow employees die to the h

_Since the company was a big fan of using Linux for the Device©, the colors look more gray when dead since they cheaped out on the HDR support._

You can teleport to other employees, like you would using the old spectator view, by using the **Interact** _(Default: Right Controller Trigger)_ button. This will cycle through each employee in the lobby that has not yet met their maker. Use this to quickly see how a fellow employee is going about their day, or to get unstuck if you have fallen into a pit.
You can teleport to other employees by using the **Interact** _(Default: Right Controller Trigger)_ button. This will cycle through each employee in the lobby that has not yet met their maker. Use this to quickly see how a fellow employee is going about their day, or to get unstuck if you have fallen into a pit.

_Since the Device© is making use of simulated consciousness, physical barriers like doors act like air, so you can walk right through them no problem!_

Expand Down
10 changes: 7 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ Here is a list of LCVR versions and which version(s) of Lethal Company it suppor

| LCVR | Lethal Company |
|-------------------|-------------------|
| v1.3.4 *(LATEST)* | V64 and V64.1 |
| v1.3.6 *(LATEST)* | V64 - V67 |
| v1.3.5 | V64 - V66 |
| v1.3.4 | V64 and V64.1 |
| v1.3.3 | V64 and V64.1 |
| v1.3.2 | V64 |
| v1.3.1 | V62 |
Expand All @@ -65,6 +67,8 @@ Here is a list of LCVR versions and which version(s) of Lethal Company it suppor
| v1.0.1 | V45 and V49 |
| v1.0.0 | V45 and V49 |

> LCVR versions from 1.3.6 and above also check hashes remotely, meaning newer Lethal Company versions might be supported even though they aren't listed here.
# For developers

If you want to make your mod compatible with LCVR, make sure to check out the [API documentation](Docs/API). While at the time of writing it doesn't contain much, this might be expanded more in the future.
Expand All @@ -83,7 +87,7 @@ Next up you'll need to grab a copy of some **Runtime Dependencies** and the [**A

> You can skip this part if you have taken the runtime dependencies from the releases page.
First of all start by installing Unity 2022.3.9f1, which is the Unity version that Lethal Company uses. Once you have installed the editor, create a new Unity project. If you are planning on adding prefabs to the mod, use the HDRP template and add the XR modules via the HDRP helper or by manually installing the Unity OpenXR plugins (Google is your friend). Otherwise you can just use the VR template.
First of all start by installing Unity 2022.3.9f1, which is the Unity version that Lethal Company uses. Once you have installed the editor, create a new Unity project. If you are planning on adding prefabs to the mod, use the HDRP template and add the XR modules via the HDRP helper or by manually installing the Unity OpenXR plugins (Google is your friend), otherwise you can just use the VR template.

Make sure you set the scripting backend to Mono, and not to Il2Cpp (Unity will warn you when you try to compile a VR game with Il2Cpp enabled). You can now build your dummy game. Once the game is built you can navigate to it's `<Project Name>_Data/Managed` directory. There you will need to extract the following files:

Expand All @@ -102,7 +106,7 @@ And from the `<Project Name>_Data/Plugins/x86_64` directory:

BepInEx is the modloader that LCVR uses to mod the game. You can download BepInEx from their [GitHub Releases](https://github.com/BepInEx/BepInEx/releases) (LCVR currently targets BepInEx 5.4.22).

To install BepInEx, you can follow their [Installation Gude](https://docs.bepinex.dev/articles/user_guide/installation/index.html#installing-bepinex-1).
To install BepInEx, you can follow their [Installation Guide](https://docs.bepinex.dev/articles/user_guide/installation/index.html#installing-bepinex-1).

## Installing the mod

Expand Down

0 comments on commit e14ee36

Please sign in to comment.