Update setup instructions with nuget stuff

This commit is contained in:
Ricardo 2021-12-31 14:20:03 +01:00 committed by GitHub
parent dbbc95e32c
commit 3878038cf3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,12 +1,15 @@
# NomaiVR Development Setup
- Install Unity 2019.4.27
:warning: These are instructions on how to set up NomaiVR for mod development, not for installing / playing. If you just want to install NomaiVR to play Outer Wilds in VR, follow the [instructions in the main readme](https://github.com/Raicuparta/nomai-vr#installation).
- Install Unity 2019.4.27;
- [Download the Outer Wilds Mod Manager](https://outerwildsmods.com/) and install it anywhere you like;
- Install OWML using the Mod Manager;
- Clone NomaiVR's source;
- Create the file `NomaiVR/NomaiVR.csproj.user` in your favorite text editor;
```xml
<!-- NomaiVR/NomaiVR.csproj.user -->
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
@ -22,16 +25,14 @@
- Edit the entry `<GameDir>` to point to the directory where Outer Wilds is installed;
- Edit the entry `<OwmlDir>` to point to your OWML directory (it is installed inside the Mod Manager directory);
- Edit the entry `<UnityEditor>` to point to your Unity 2019.4.27 editor executable;
- Download the [AssemblyPublicizer](https://github.com/Raicuparta/AssemblyPublicizer/releases) and extract the exe anywhere;
- Drag the file `OuterWilds\OuterWilds_Data\Managed\Assembly-CSharp.dll` and drop it on top of `AssemblyPublicizer.exe`;
- Confirm that it generated a new file `OuterWilds\OuterWilds_Data\Managed\publicized_assemblies\Assembly-CSharp_publicized.dll`;
- Open Unity and import the project under `Unity`, some dependencies should be downloaded
- When asked about VR support select `Legacy VR`
- Close Unity when the project has finished importing
- Open Unity and import the project under `Unity`, some dependencies should be downloaded;
- When asked about VR support select `Legacy VR`;
- Close Unity when the project has finished importing;
- Open the project solution file `NomaiVR.sln` in Visual Studio;
- If needed, right click `References` in the Solution Explorer > Manage NuGet Packages > Update OWML to fix missing references;
- If needed, right click `References` in the Solution Explorer > Manage NuGet Packages > Update OWML to fix missing references (some other broken references will be fixed in a later step;
- In the same place, check that the Outer Wilds Game Libs Nuget is updated.
After doing this you should compile a release build from Visual Studio (the configuration to select is `OWML`), it'll let unity compile the support project and assetbundles and then compile the mod.
After doing this you should compile a release build from Visual Studio (the configuration to select is `OWML`), it'll let Unity compile the support project and assetbundles and then compile the mod.
The project references should now be working. When you build the solution, the dll and json files will be copied to `[Mod Manager directory]/OWML/NomaiVR`. If this process is successful, you should see the mod show up in the Mod Manager.
The available build configurations are: