Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
"isRequired": "true",
"defaultValue": ""
},
"RimworldDLL": {
"RimworldDir": {
"type": "parameter",
"datatype": "text",
"replaces": "Assembly-CSharp.dll",
"replaces": "RimworldDir",
"isRequired": "false",
"defaultValue": ""
},
Expand Down Expand Up @@ -73,20 +73,13 @@
"isRequired": "false",
"defaultValue": "true"
},
"AssemblyDir": {
"type": "derived",
"valueSource": "RimworldDLL",
"valueTransform": "BaseDirectory",
"replaces": "AssemblyDir",
"description": "The directory containing the RimWorld DLL"
},
"assemblyExists": {
"RimworldDirExists": {
"type": "generated",
"generator": "regexMatch",
"datatype": "bool",
"parameters": {
"pattern": "[a-zA-Z0-9]",
"source": "RimworldDLL"
"source": "RimworldDir"
}
}
},
Expand Down Expand Up @@ -157,6 +150,12 @@
{
"path": "Source/MyRimWorldMod.csproj"
},
{
"path": "Source/Directory.Build.props"
},
{
"path": "Source/Directory.Build.targets"
},
{
"path": "Source/MyRimWorldMod.cs"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?xml version="1.0" encoding="utf-8"?>
<Project>
<PropertyGroup>
<Configurations>1.5;1.6;1.7</Configurations>
<Configuration Condition="'$(Configuration)' == ''">1.6</Configuration>
<RimWorldVersion>$(Configuration)</RimWorldVersion>
<UsingWaylith Condition="'$(RimWorldVersion)' == '1.5' OR '$(RimWorldVersion)' == '1.6'">false</UsingWaylith>
<UsingWaylith Condition="'$(RimWorldVersion)' != '1.5' AND '$(RimWorldVersion)' != '1.6'">true</UsingWaylith>
<TargetFramework Condition="!'$(UsingWaylith)'">net472</TargetFramework>
<TargetFramework Condition="'$(UsingWaylith)'">net10.0</TargetFramework>
<DefineConstants>$(DefineConstants);v$(RimWorldVersion)</DefineConstants>
<OutputPath>$([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)'))/../$(RimWorldVersion)/Assemblies</OutputPath>
<!-- MSB3052: allow 1.5/1.6 style def names -->
<!-- MSB3246: skip native dlls -->
<NoWarn>$(NoWarn);MSB3246;MSB3052</NoWarn>
<!-- Deterministic builds are suprisingly involved, and requires the 10.0 sdk to be installed to reliably work. This can still target older framework versions -->
<Deterministic>true</Deterministic>
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
<IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
<!-- This avoids leaking the full path in debug symbols -->
<DeterministicSourcePaths>true</DeterministicSourcePaths>
<PathMap>$([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)'))=./</PathMap>
<DebugSymbols>true</DebugSymbols>
<DebugType>portable</DebugType>

<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<CopyLocalLockFileAssemblies>false</CopyLocalLockFileAssemblies>
<LangVersion>latest</LangVersion>
<IsPackable>false</IsPackable>
<GenerateDependencyFile>false</GenerateDependencyFile>
<DefineConstants>TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
<PublicizeAll>false</PublicizeAll>
<Optimize>false</Optimize>
</PropertyGroup>

<ItemGroup>
<!-- required for the DeterministicSourcePaths option -->
<SourceRoot Include="$(MSBuildThisFileDirectory)/"/>
</ItemGroup>
</Project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Use Krafs.Rimworld.Ref in mod projects while letting the IDE display real method bodies
instead of stubs when navigating or decompiling.

Copy this file as Directory.Build.targets next to your .csproj or in any parent directory.
SDK-style projects auto-import the first Directory.Build.targets they find - place accordingly.

Example uses:
- Place in root folder of all your mod projects, and every one will import this.
- Set RimWorldDirectory in your .csproj pointing to different RimWorld installs for different versions.

If Krafs.Rimworld.Ref is referenced, these targets compare its version to the locally installed
RimWorld version. If they match, the NuGet reference is removed and local assemblies are used.

To ignore patch version differences, set UseStrictRimWorldVersionComparison to false
(equivalent to e.g. 1.6.*), allowing local assemblies even if the patch number differs.

The RimWorld directory is detected from standard Steam install paths, but can be set manually
via RimWorldDirectory.

To see logs from these targets, build with detailed verbosity or higher:
dotnet build -v:detailed
-->

<Project>
<!-- User settings (can be defined in csproj) -->
<PropertyGroup>
<SteamModsDirectory Condition="'$(SteamModsDirectory)'==''"></SteamModsDirectory>
<!-- Path to RimWorld root folder (optional, overrides auto-detection) -->
<RimWorldDirectory Condition="'$(RimWorldDirectory)'==''"></RimWorldDirectory>

<!-- Require exact patch match? Set to false for wildcard match -->
<UseStrictRimWorldVersionComparison Condition="'$(UseStrictRimWorldVersionComparison)'==''">false</UseStrictRimWorldVersionComparison>

<!-- Run this logic? Example: only enable in Debug builds -->
<EnableLocalRimWorldReferences Condition="'$(EnableLocalRimWorldReferences)'==''">true</EnableLocalRimWorldReferences>
<EnablePublicizer Condition="'$(EnablePublicizer)'==''">false</EnablePublicizer>
</PropertyGroup>

<PropertyGroup Condition="'$(RimWorldDirectory)' != ''">
<RimWorldDirectory>$([System.String]::Copy('$(RimWorldDirectory)').Trim())</RimWorldDirectory>
</PropertyGroup>
<PropertyGroup Condition="'$(SteamModsDirectory)' != ''">
<SteamModsDirectory>$([System.String]::Copy('$(SteamModsDirectory)').Trim())</SteamModsDirectory>
</PropertyGroup>

<!-- Auto-detect RimWorld directory from known install locations -->
<PropertyGroup>
<!-- Windows: per-user install -->
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(USERPROFILE)\AppData\Local\Steam\steamapps\common\RimWorld')">
$(USERPROFILE)\AppData\Local\Steam\steamapps\common\RimWorld
</RimWorldDirectory>

<!-- Windows: all users -->
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(MSBuildProgramFiles32))\Steam\steamapps\common\RimWorld')">
$(MSBuildProgramFiles32)\Steam\steamapps\common\RimWorld
</RimWorldDirectory>

<!-- Linux: default -->
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(HOME)/.local/share/Steam/steamapps/common/RimWorld')">
$(HOME)/.local/share/Steam/steamapps/common/RimWorld
</RimWorldDirectory>

<!-- Linux: legacy -->
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(HOME)/.steam/steam/steamapps/common/RimWorld')">
$(HOME)/.steam/steam/steamapps/common/RimWorld
</RimWorldDirectory>

<!-- macOS -->
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(HOME)/Library/Application Support/Steam/steamapps/common/RimWorld')">
$(HOME)/Library/Application Support/Steam/steamapps/common/RimWorld
</RimWorldDirectory>

<!-- Relative RimWorld/Mods -->
<RimWorlProbeFile Condition="!'$(UsingWaylith)'">RimWorldWin64.exe</RimWorlProbeFile>
<RimWorlProbeFile Condition="'$(UsingWaylith)'">RimWorld.exe</RimWorlProbeFile>
<RimWorldDirectoryProbe Condition="'$(RimWorldDirectory)'==''">$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)'))</RimWorldDirectoryProbe>
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(RimWorldDirectoryProbe)$(RimWorlProbeFile)') ">$(RimWorldDirectoryProbe)</RimWorldDirectory>
<RimWorldDirectoryProbe Condition="'$(RimWorldDirectory)'==''">$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)/../'))</RimWorldDirectoryProbe>
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(RimWorldDirectoryProbe)$(RimWorlProbeFile)') ">$(RimWorldDirectoryProbe)</RimWorldDirectory>
<RimWorldDirectoryProbe Condition="'$(RimWorldDirectory)'==''">$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)/../../'))</RimWorldDirectoryProbe>
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(RimWorldDirectoryProbe)$(RimWorlProbeFile)') ">$(RimWorldDirectoryProbe)</RimWorldDirectory>
<RimWorldDirectoryProbe Condition="'$(RimWorldDirectory)'==''">$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)/../../../'))</RimWorldDirectoryProbe>
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(RimWorldDirectoryProbe)$(RimWorlProbeFile)') ">$(RimWorldDirectoryProbe)</RimWorldDirectory>
<RimWorldDirectoryProbe Condition="'$(RimWorldDirectory)'==''">$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)/../../../../'))</RimWorldDirectoryProbe>
<RimWorldDirectory Condition="'$(RimWorldDirectory)'=='' AND Exists('$(RimWorldDirectoryProbe)$(RimWorlProbeFile)') ">$(RimWorldDirectoryProbe)</RimWorldDirectory>
</PropertyGroup>

<!-- Normalize path + set version file path -->
<PropertyGroup Condition="'$(RimWorldDirectory)' != ''">
<RimWorldDirectory>$([System.String]::Copy('$(RimWorldDirectory)').Trim())</RimWorldDirectory>
<RimWorldDirectory>$([MSBuild]::NormalizeDirectory('$(RimWorldDirectory)'))</RimWorldDirectory>
<RimWorldVersionFile Condition="Exists('$(RimWorldDirectory)Version.txt')">$(RimWorldDirectory)Version.txt</RimWorldVersionFile>
</PropertyGroup>

<!-- Auto-detect Rimworld's steam mods location -->
<PropertyGroup Condition="'$(RimWorldDirectory)' != '' AND '$(SteamModsDirectory)' == ''">
<SteamModsDirectoryProbe>$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)/workshop'))</SteamModsDirectoryProbe>
<SteamModsDirectory Condition="'$(SteamModsDirectory)'=='' AND Exists('$(SteamModsDirectoryProbe)') ">$(SteamModsDirectoryProbe)</SteamModsDirectory>
<SteamModsDirectoryProbe>$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)/../workshop'))</SteamModsDirectoryProbe>
<SteamModsDirectory Condition="'$(SteamModsDirectory)'=='' AND Exists('$(SteamModsDirectoryProbe)') ">$(SteamModsDirectoryProbe)</SteamModsDirectory>

<SteamModsDirectorySuffix>workshop/content/294100</SteamModsDirectorySuffix>
<SteamModsDirectoryProbe>$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)/$(SteamModsDirectorySuffix)'))</SteamModsDirectoryProbe>
<SteamModsDirectory Condition="'$(SteamModsDirectory)'=='' AND Exists('$(SteamModsDirectoryProbe)') ">$(SteamModsDirectoryProbe)</SteamModsDirectory>
<SteamModsDirectoryProbe>$([MSBuild]::NormalizeDirectory('$(MSBuildProjectDirectory)/../$(SteamModsDirectorySuffix)'))</SteamModsDirectoryProbe>
<SteamModsDirectory Condition="'$(SteamModsDirectory)'=='' AND Exists('$(SteamModsDirectoryProbe)') ">$(SteamModsDirectoryProbe)</SteamModsDirectory>
<SteamModsDirectoryProbe>$([MSBuild]::NormalizeDirectory('$(RimWorldDirectory)/../../$(SteamModsDirectorySuffix)'))</SteamModsDirectoryProbe>
<SteamModsDirectory Condition="'$(SteamModsDirectory)'=='' AND Exists('$(SteamModsDirectoryProbe)') ">$(SteamModsDirectoryProbe)</SteamModsDirectory>
</PropertyGroup>

<PropertyGroup Condition="'$(SteamModsDirectory)' != ''">
<SteamModsDirectory>$([System.String]::Copy('$(SteamModsDirectory)').Trim())</SteamModsDirectory>
<SteamModsDirectory Condition="'$(SteamModsDirectory)' != ''">$([MSBuild]::NormalizeDirectory('$(SteamModsDirectory)'))</SteamModsDirectory>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Krafs.Rimworld.Ref" Version="$(RimWorldVersion).*-*" />
</ItemGroup>

<ItemGroup Condition="!'$(UsingWaylith)' AND '$(SteamModsDirectory)' == ''">
<PackageReference Include="Lib.Harmony" version="2.4.*" />
</ItemGroup>
<ItemGroup Condition="'$(UsingWaylith)' AND '$(SteamModsDirectory)' == ''">
<PackageReference Include="Lib.Harmony" version="3.0.0-rc.3" />
</ItemGroup>

<ItemGroup Condition="'$(SteamModsDirectory)' != ''">
<Reference Include="0Harmony">
<HintPath>$(SteamModsDirectory)2009463077/$(RimWorldVersion)/Assemblies/0Harmony.dll</HintPath>
<Private>False</Private>
</Reference>
</ItemGroup>

<Target Name="LogRimWorldScriptSettings" BeforeTargets="ResolveLocalRimWorldVersion">
<Message Text="UsingWaylith: '$(UsingWaylith)'" Importance="high"/>
<Message Text="Steam Mods directory: '$(SteamModsDirectory)'" Importance="high"/>
<Message Text="RimWorld directory: '$(RimWorldDirectory)'" Importance="high"/>
<Message Text="Strict version comparison: $(UseStrictRimWorldVersionComparison)" Importance="high"/>
</Target>

<ItemGroup Condition="!'$(UsingWaylith)'">
<LocalRimWorldAssembly Include="$(RimWorldDirectory)*/Managed/*.dll" Visible="false"/>
</ItemGroup>
<ItemGroup Condition="'$(UsingWaylith)'">
<LocalRimWorldAssembly Include="$(RimWorldDirectory)*.dll" Visible="false"/>
</ItemGroup>

<!-- Capture Krafs.Rimworld.Ref package reference -->
<Target Name="GetRimRef" AfterTargets="ResolvePackageReferences" Condition="'@(PackageReference->WithMetadataValue('Identity','Krafs.Rimworld.Ref'))' != ''">
<ItemGroup>
<RimRefPackageReference Include="@(PackageReference)" Condition="'%(PackageReference.Identity)' == 'Krafs.Rimworld.Ref'"/>
</ItemGroup>
</Target>

<Target Name="ResolveLocalRimWorldVersion" Condition="'$(RimWorldVersionFile)' != ''">
<ReadLinesFromFile File="$(RimWorldVersionFile)">
<Output TaskParameter="Lines" ItemName="VersionFileLine"/>
</ReadLinesFromFile>

<PropertyGroup>
<RimWorldVersion>$([System.String]::Copy('%(VersionFileLine.Identity)').Split(' ')[0])</RimWorldVersion>
<RimWorldVersionMinor>$([System.String]::Copy('$(RimWorldVersion)').Split('.')[1])</RimWorldVersionMinor>
<RimWorldVersionPatch>$([System.String]::Copy('$(RimWorldVersion)').Split('.')[2])</RimWorldVersionPatch>
</PropertyGroup>

<Message Text="RimWorld version: $(RimWorldVersion)" Importance="high"/>
</Target>

<Target Name="ResolveRimRefVersion" DependsOnTargets="GetRimRef">
<PropertyGroup>
<RimRefVersion>%(RimRefPackageReference.Version)</RimRefVersion>
<RimRefVersionMinor>$([System.String]::Copy('$(RimRefVersion)').Split('.')[1])</RimRefVersionMinor>
<RimRefVersionPatch>$([System.String]::Copy('$(RimRefVersion)').Split('.')[2])</RimRefVersionPatch>
<RimRefVersionPatchComparable>$([System.String]::Copy('$(RimRefVersionPatch)').Split('-')[0])</RimRefVersionPatchComparable>
</PropertyGroup>

<Message Text="Krafs.Rimworld.Ref version: $(RimRefVersion)" Importance="high"/>
</Target>

<!-- Compare versions + decide whether to remove NuGet reference -->
<Target Name="RemoveRimRef" DependsOnTargets="ResolveLocalRimWorldVersion;ResolveRimRefVersion">
<PropertyGroup>
<MinorVersionsMatch Condition="'$(RimWorldVersionMinor)' == '$(RimRefVersionMinor)'">true</MinorVersionsMatch>
<IgnorePatchVersion Condition="'$(RimRefVersionPatchComparable)' == '*' OR '$(UseStrictRimWorldVersionComparison)' != 'true'">true</IgnorePatchVersion>
<PatchVersionsMatch Condition="'$(RimWorldVersionPatch)' == '$(RimRefVersionPatchComparable)' OR '$(IgnorePatchVersion)' == 'true'">true</PatchVersionsMatch>
<ShouldRemoveRimRef Condition="'$(MinorVersionsMatch)' == 'true' AND '$(PatchVersionsMatch)' == 'true'">true</ShouldRemoveRimRef>
<ShouldRemoveRimRef Condition="'$(ShouldRemoveRimRef)' != 'true'">false</ShouldRemoveRimRef>
</PropertyGroup>

<ItemGroup Condition="'$(ShouldRemoveRimRef)' == 'true'">
<PackageReference Remove="@(RimRefPackageReference)"/>
</ItemGroup>
</Target>

<!-- Swap in local RimWorld assemblies before assembly resolution -->
<Target Name="RemoveConflictingFrameworkReferenceAssemblies"
AfterTargets="GetReferenceAssemblyPaths"
BeforeTargets="ResolveAssemblyReferences"
DependsOnTargets="RemoveRimRef"
Condition="'$(EnableLocalRimWorldReferences)' == 'true'">
<ItemGroup Condition="'$(ShouldRemoveRimRef)' == 'true'">
<Reference Remove="@(LocalRimWorldAssembly->'%(Filename)')"/>
<Reference Include="@(LocalRimWorldAssembly)" Private="false"/>
</ItemGroup>
<Message Text="Local RimWorld referenced: $(ShouldRemoveRimRef)" Importance="high"/>
</Target>

<ItemGroup Condition="'$(EnablePublicizer)' == 'true'">
<PackageReference Include="Krafs.Publicizer" Version="2.3.2" />
</ItemGroup>
</Project>
Loading