Skip to content

Commit

Permalink
Add reference to VS "start" button in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Raicuparta committed Jan 12, 2020
1 parent 1b834bc commit 4d67e58
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
![NomaiVR](logo.png)

# NomaiVR - Outer Wilds VR Mod

![NomaiVR](logo.png)

The aim of this mod is to enable VR mode in Outer Wilds, and eventually fix the problems that come with forcing VR in a game that's obviously not prepared for it.

## YOU WILL HAVE A BAD TIME

While the game is playable at a surprisingly decent level, a lot of things range from mildly glitchy to completely broken. Expect low performance, crashes, blue screen, house fires, big explosions visibe from space. Have a look at the [currently open issues](https://github.com/Raicuparta/NomaiVR/issues) to have an idea of some of the stuff that needs fixing.

## Installation

Easy way:

* [Follow the instructions to install Vortex and the Outer Wilds Mod Manager](https://www.nexusmods.com/outerwilds/mods/1);
* [Install the mod through Vortex](https://www.nexusmods.com/outerwilds/mods/7);
* Run the game through Vortex.

Manually:

* [Download OWML](https://github.com/amazingalek/owml/releases);
* [Follow the instalation instructions](https://github.com/amazingalek/owml#installation);
* [Download a release](https://github.com/Raicuparta/NomaiVR/releases);
Expand All @@ -37,7 +40,12 @@ If your desired contribution doesn't fit one of the existing issues, create an i
* Go to "Debug" and change (if needed) "Working Directory" to **OWML's directory** (no need to change anything else);
* In the top menu go to "Project" > "Unload Project", and then "Project" > "Reload Project".

After doing this, the project references should be working. If for some reason they're not, you'll have to set everything manually. To fix the build paths and automatically copy the files to OWML, edit the "Build Events" in the properties menu. To fix the references, right-click "References" in the Solution Explorer > "Add Reference", and add all the missing DLLs (references with yello warning icon).
After doing this, the project references should be working. When you build the solution, the dll and json files will be copied to `OWML/NomaiVR`, so you can start the game and test right away. Pressing "Start" on Visual Studio will start the game through OWML.

If for some reason none of this is working, you might have to set everything manually:

* To fix the build paths and automatically copy the files to OWML, edit the "Build Events" in the properties menu.
* To fix the references, right-click "References" in the Solution Explorer > "Add Reference", and add all the missing DLLs (references with yello warning icon).

## Help / Discuss development / Tell me about your day

Expand Down

0 comments on commit 4d67e58

Please sign in to comment.