SteamModReference 0.1.0
See the version list below for details.
dotnet add package SteamModReference --version 0.1.0
NuGet\Install-Package SteamModReference -Version 0.1.0
<PackageReference Include="SteamModReference" Version="0.1.0" />
<PackageVersion Include="SteamModReference" Version="0.1.0" />
<PackageReference Include="SteamModReference" />
paket add SteamModReference --version 0.1.0
#r "nuget: SteamModReference, 0.1.0"
#:package SteamModReference@0.1.0
#addin nuget:?package=SteamModReference&version=0.1.0
#tool nuget:?package=SteamModReference&version=0.1.0
Steam-Mod-Reference
MSBuild tasks/props/targets that let a .NET project reference DLLs shipped inside Steam Workshop mods , by downloading them via SteamCMD at build time.
No SteamCMD credentials are required - all downloads are anonymous, which is sufficient for public workshop items
Game agnostic but tested on Rimworld
Requirements
On linux/ github
sudo dpkg --add-architecture i386
sudo apt update
sudo apt install libc6:i386
It also requires net10 SDK installed. Your mods can target whatever they want → mono, net461 etc
NOT TESTED ON WINDOWS WHATSOEVER
Usage
<PropertyGroup>
<SteamModAppId>294100</SteamModAppId>
<SteamModDefaultAssemblies>1.6/Assemblies/*.*;Assemblies/*.*</SteamModDefaultAssemblies>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="SteamModReference" Version="0.1.0" PrivateAssets="all" />
</ItemGroup>
<ItemGroup>
<SteamModReference Include="2872901762" />
</ItemGroup>
| Metadata | Meaning |
|---|---|
Include |
Workshop item id. Required |
Assemblies |
Path/glob under the mod's content root to find dll(s). Omit to use $(SteamModDefaultAssemblies). |
AllowDuplicates |
true to force-reference even if an assembly of the same name is already referenced. Default false. |
Properties
| Property | Default | Meaning |
|---|---|---|
SteamModAppId |
294100 (RimWorld) |
Steam AppId the workshop ids belong to. |
SteamModDefaultAssemblies |
1.6/Assemblies/*.*;Assemblies/*.* |
Ordered, ;-separated fallback patterns tried when an item has no Assemblies metadata. First pattern that matches ≥1 dll wins. |
SteamModIntermediateDir |
$(BaseIntermediateOutputPath)steam\ |
Where steamcmd + downloaded workshop content is staged. |
SteamModForceRedownload |
false |
Escape hatch to bust the cache (not yet wired to actual skip-logic - see PLAN.md). |
SteamModCleanRemovesToolCache |
false |
dotnet clean always clears staged mod content + manifest. Set true to also remove the cached steamcmd binary itself on clean (fully-from-scratch reset, re-downloads steamcmd next build). |
Clean behavior
dotnet clean (and VS "Clean") normally only touches the SDK's own obj/bin outputs -
it has no idea about the workshop content staged under $(SteamModIntermediateDir).
This package hooks AfterTargets="Clean" so that running clean also removes:
- staged workshop mod content (
.../steam/steamapps/workshop) - the manifest file (once Phase 3 incrementality lands - see PLAN.md)
The cached steamcmd tool binary itself is left alone by default (set SteamModCleanRemovesToolCache=true to remove that too).
Repo layout
src/ the MSBuild task assembly (net472 + net8.0)
build/ props/targets shipped to direct consumers
buildTransitive/ thin pass-through for transitive consumers
tests/ConsumerSample/ a project that consumes the package, for local testing
PLAN.md what's implemented vs. still to do
License
MIT
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.