Derail Valley Multiplayer

A Derail Valley mod that adds multiplayer.

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Roadmap
3. How to install
4. Building
5. Contributing
6. License

About The Project

Multiplayer is a Derail Valley mod that adds multiplayer to the game, allowing you to play with your friends.

It works by having one player host a game, and then other players can join that game.

Roadmap

For a list of planned features, see the project board.
The mod will be released on Nexus once it's ready.

How to install

1. Install Unity Mod Manager(UMM)
2. Uninstall all your existing mods
3. Download the newest zip from the releases and yeet it into UMM

Building

Before building, make sure you have .NET 7, PowerShell 7, Visual Studio, and Unity 2019.4.40f1 installed. You'll also need the Unity Hub in order to open Unity.

1. Clone the repository to a memorable location.
2. Open the Unity Hub, click Open, then select the MultiplayerAssets folder. This should open Unity 2019.4.40f1. Make sure that it is this version exactly, otherwise things will break.
3. In Unity, go to the top and click Multiplayer > Build Assets and Scripts.
4. Create a file called Directory.Build.Targets in the root of your extracted zip, open it and paste the following:

   <Project>
       <PropertyGroup>
           <DvInstallDir>C:\Program Files (x86)\Steam\steamapps\common\Derail Valley</DvInstallDir>
           <UnityInstallDir>C:\Program Files\Unity\Hub\Editor\2019.4.40f1\Editor</UnityInstallDir>
           <ReferencePath>
               $(DvInstallDir)\DerailValley_Data\Managed\;
               $(DvInstallDir)\DerailValley_Data\Managed\UnityModManager\;
               $(UnityInstallDir)\Data\Managed\
           </ReferencePath>
           <AssemblySearchPaths>$(AssemblySearchPaths);$(ReferencePath);</AssemblySearchPaths>
       </PropertyGroup>
   </Project>
   

   This will specify where the references that are needed to build the mod are located. IMPORTANT! Make sure that the file paths DvInstallDir and UnityInstallDir are the same as wherever you have your installs.

5. Open the Multiplayer.sln file in Visual Studio, then go to Build > Build Solution. This will build the dll file into the build folder. It should also automatically package the mod into your DV mod folder, so you should now be able to open Derail Valley.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create.
Any contributions you make are greatly appreciated!
If you're new to contributing to open-source projects, you can follow this guide.

License

Code is distributed under the Apache 2.0 license.
See LICENSE for more information.