Skip to content

BUILD_AND_DEPENDENCIES.md

Latest commit

 

History

History
90 lines (58 loc) · 3.31 KB

BUILD_AND_DEPENDENCIES.md

File metadata and controls

90 lines (58 loc) · 3.31 KB
Raw

Build And Dependencies

Build Command

Run from the repository root:

dotnet build Source/CameraPlus.csproj -c Release

The current project has no automated test project. Treat a clean build as the minimum check, then use in-game validation for camera, marker, label, and compatibility changes.

Outputs

Release builds write:

  • 1.6/Assemblies/CameraPlus.dll

The project also has a CopyToRimworld MSBuild target that runs when RIMWORLD_MOD_DIR is set. That target:

  • deletes 1.6/Assemblies/0Harmony.dll.
  • copies version folders, metadata, defs, languages, resources, sounds, textures, license, load folders, README, and README image assets into $(RIMWORLD_MOD_DIR)\CameraPlus.
  • zips that copied mod folder as $(RIMWORLD_MOD_DIR)\CameraPlus.zip.

On macOS with a Unix shell, MSBuild still prints Windows-style path separators in the target body because the project file uses backslashes.

Dependency Update Baseline

During this prep pass on 2026-05-15:

  • The project was pinned to Krafs.Rimworld.Ref 1.6.4518.
  • NuGet reported 1.6.4633 as the latest stable package.
  • NuGet's flat-container index listed 1.6.4817-beta as the latest package overall.
  • The project was updated to Krafs.Rimworld.Ref 1.6.4817-beta to compile against the newest known RimWorld 1.6 API surface before the larger review.
  • dotnet build Source/CameraPlus.csproj -c Release succeeded after the update.

Primary package source:

  • https://www.nuget.org/packages/Krafs.Rimworld.Ref
  • https://api.nuget.org/v3-flatcontainer/krafs.rimworld.ref/index.json

Package References

Current top-level package references in Source/CameraPlus.csproj:

  • Brrainz.RimWorld.CrossPromotion 1.1.2
  • Krafs.Rimworld.Ref 1.6.4817-beta
  • Lib.Harmony 2.3.6, with ExcludeAssets="runtime"
  • Microsoft.NETCore.Platforms 7.0.4
  • Microsoft.NETFramework.ReferenceAssemblies.net472 1.0.3
  • TaskPubliciser 1.0.3

Lib.Harmony is a compile-time package here. The runtime Harmony dependency is provided by the RimWorld Harmony mod declared in About/About.xml.

Publicised RimWorld Reference

Source/CameraPlus.csproj contains two custom targets:

  • MyCode, before UpdateReferences, publicises $(PkgKrafs_Rimworld_Ref)\ref\net472\Assembly-CSharp.dll into Assembly-CSharp_publicised.dll, then adds the publicised assembly as a reference.
  • UpdateReferences, after ResolveLockFileReferences, removes the original non-publicised Assembly-CSharp.dll reference.

This is central to the codebase. Many patches and helpers access non-public RimWorld members through the publicised assembly.

Version Metadata

Directory.Build.props owns:

  • ModName
  • ModFileName
  • Repository
  • ModVersion
  • ProjectGuid

The PostBuildAction target writes ModVersion into:

  • About/About.xml at //ModMetaData/modVersion
  • About/Manifest.xml at //Manifest/version

RimWorld Payload Files

RimWorld loads common content from the root and per-version assemblies through LoadFolders.xml.

Important payload directories:

  • About: RimWorld metadata, manifest, preview, Steam id.
  • Defs: sound defs for snapback.
  • Languages: keyed translations for settings and marker tags.
  • Textures: marker/editor UI textures loaded through ContentFinder.
  • Sounds: snapback audio clips.
  • Resources: platform-specific Unity asset bundles.