Skip to content

lassombra/SteamRemote

Repository files navigation

Contributors Forks Stargazers Issues MIT License

Steam Remote

Table of Contents
  1. About The Project
  2. Building
  3. Packaging
  4. License

About The Project

This mod is intended to introduce a remote control compatibility to the S060. This can be used as an example for adding remote control capability to other steam engines using CCL. In fact, the remote control component being added in this mod may be distributed at a later date as a CCL plugin as well for simple implementation.

Options:

  • Apply to S282 - Defaults to false - if true, then the 282 will also recieve the remote module
  • Add Wireless MU - Defaults to true - if true, then both the 060 and 282 will receive the ability to use the wireless MU (Wireless MU also synchs CylinderCocks if the sender and receiver are both steam locomotives.

Building

Building the project requires some initial setup, after which running dotnet build will do a Debug build or running dotnet build -c Release will do a Release build.

References Setup

After cloning the repository, some setup is required in order to successfully build the mod DLLs. You will need to create a new Directory.Build.targets file to specify your local reference paths. This file will be located in the main directory, next to MOD_NAME.sln.

Below is an example of the necessary structure. When creating your targets file, you will need to replace the reference paths with the corresponding folders on your system. Make sure to include semicolons between each of the paths and no semicolon after the last path. Also note that any shortcuts you might use in file explorer—such as %ProgramFiles%—won't be expanded in these paths. You have to use full, absolute paths.

<Project>
	<PropertyGroup>
		<ReferencePath>
			C:\Program Files (x86)\Steam\steamapps\common\Derail Valley\DerailValley_Data\Managed\
		</ReferencePath>
		<AssemblySearchPaths>$(AssemblySearchPaths);$(ReferencePath);</AssemblySearchPaths>
	</PropertyGroup>
</Project>

Line Endings Setup

It's recommended to use Git's autocrlf mode on Windows. Activate this by running git config --global core.autocrlf true.

Packaging

To package a build for distribution, you can run the package.ps1 PowerShell script in the root of the project. If no parameters are supplied, it will create a .zip file ready for distribution in the dist directory. A post build event is configured to run this automatically after each successful Release build.

Linux: pwsh ./package.ps1 Windows: powershell -executionpolicy bypass .\package.ps1

Parameters

Some parameters are available for the packaging script.

-NoArchive

Leave the package contents uncompressed in the output directory.

-OutputDirectory

Specify a different output directory. For instance, this can be used in conjunction with -NoArchive to copy the mod files into your Derail Valley installation directory.

License

Source code is distributed under the MIT license. See LICENSE for more information.

About

Enable Remote Control for Steam Engines in Derail Valley

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors