Yariazen.PlateUp.ModBuildUtilities 1.13.0

dotnet add package Yariazen.PlateUp.ModBuildUtilities --version 1.13.0
                    
NuGet\Install-Package Yariazen.PlateUp.ModBuildUtilities -Version 1.13.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Yariazen.PlateUp.ModBuildUtilities" Version="1.13.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Yariazen.PlateUp.ModBuildUtilities" Version="1.13.0" />
                    
Directory.Packages.props
<PackageReference Include="Yariazen.PlateUp.ModBuildUtilities" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Yariazen.PlateUp.ModBuildUtilities --version 1.13.0
                    
#r "nuget: Yariazen.PlateUp.ModBuildUtilities, 1.13.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Yariazen.PlateUp.ModBuildUtilities@1.13.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Yariazen.PlateUp.ModBuildUtilities&version=1.13.0
                    
Install as a Cake Addin
#tool nuget:?package=Yariazen.PlateUp.ModBuildUtilities&version=1.13.0
                    
Install as a Cake Tool

PlateUp! Mod Build Utilities

Installation

PlateUp! Mod Build Utilities are available as a NuGet package. You can install it by adding the following line to your project file. Ensure to replace Version="0.0.0" with the version you intend to use.

<ItemGroup>
    <PackageReference Include="Yariazen.PlateUp.ModBuildUtilities" Version="0.0.0" />
</ItemGroup>

Or it can be found directly on NuGet at Yariazen.PlateUp.ModBuildUtilities

Settings

These settings are intended to be adjusted to your specific setup. The defaults are set to work with the default PlateUp! installation.

Settings Type Default Description
EnableModDeployLocal Bool true Automatically deploy to your Mods directory
EnableGameDebugging Bool true Automatically attach your IDE debugger
EnableAutoGameReferences Bool true Automatically references PlateUp! DLLs
EnableAutoWorkshopReferences Bool true Automatically references Workshop DLLs
EnableAutoLocalModsReferences Bool true Automatically references Local DLLs
EnableDocumentation Bool false Generate XML documentation
EnableAutoPDB Bool false Generate PDB files
Blacklist ItemGroup List of DLLs to exclude from auto reference
AdditionalDLLs ItemGroup List of DLLs to include for deployment

Properties

These properties are used internally by the build utilities. They should not be adjusted unless you have a specific reason to do so.

Properties Type Description
SteamInstallDirectory String Location your Steam Client is installed
GamePath String Location PlateUp! is installed
AssemblyReferencePath String Location PlateUp! DLLs are located
WorkshopPath String Location Steam Workshop mods are located
ModsPath String Location local mods are installed
BuildDir String Location the IDE exports DLLs

Examples

Reference Blacklist

By default most of PlateUp! DLLs are automatically references in your project. You can blacklist specific DLLs by adding them to the Blacklist ItemGroup. The following example also shows the current defaults for the Blacklist ItemGroup.

<ItemGroup>
    <Blacklist Include="$(AssemblyReferencePath)\System.Buffers.dll"/>
    <Blacklist Include="$(AssemblyReferencePath)\Microsoft.Extensions.Logging.Abstractions.dll"/>
    <Blacklist Include="$(AssemblyReferencePath)\Mono.Posix.dll" />
    <Blacklist Include="$(AssemblyReferencePath)\Mono.Security.dll" />
    <Blacklist Include="$(AssemblyReferencePath)\System.Memory.dll" />
    <Blacklist Include="$(AssemblyReferencePath)\System.Runtime.CompilerServices.Unsafe.dll" />
</ItemGroup>

Additional DLLs

By default the only DLL that is deployed to your Mods directory is the one generated by your project. You can add additional DLLs to the deployment by adding them to the AdditionalDLLs ItemGroup.

<ItemGroup>
    <AdditionalDLLs Include="$(BuildDir)\0Harmony.dll"/>
    <AdditionalDLLs Include="$(BuildDir)\Semver.dll"/>
    <AdditionalDLLs Include="$(BuildDir)\UniverseLib.dll"/>
</ItemGroup>
There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.13.0 509 8/26/2024
1.12.0 445 6/24/2024
1.11.5 831 1/15/2024
1.10.21 1,373 6/29/2023
1.9.0 1,181 6/12/2023
1.8.3 1,614 4/7/2023
1.7.26 1,277 3/18/2023
1.6.16 1,498 1/28/2023
1.5.6 1,172 1/11/2023
1.4.16 1,178 1/3/2023
1.4.5 1,324 1/2/2023
1.4.4 1,267 1/2/2023
1.4.2 1,220 1/2/2023
1.4.1 1,375 1/2/2023
1.4.0 1,446 1/2/2023
1.3.0 1,418 1/2/2023