Modding

Example mods

Working example mods to learn from.

Updated 21 November 2026

Complete example mods that come with the game's docs. Each one is a working mod: copy it, change it, learn from it.

  • Ban Hammer: The host can ban players (kept out when they try to join). Console: ban, unban, bans.
  • Berry Jam: Adds berry jam (crafted from blueberries and a clay pot) and lets rope stack to 50.
  • Burst Bench: A Burst-compiled job: console burst.bench times it against the same loop in plain C# and says whether Burst ran it.
  • Example Pack: Every example mod in one install: a modpack is a mod with nothing in it but other mods to install. Uninstalling it removes the mods it installed (ones you already had stay).
  • Hello Mod: Code mod tour: lifecycle logs, console commands hello / hello.ping / hello.beacon / hello.stats, host-player messages, a network prefab, game events and world data.
  • Jam Bread: Bread with berry jam. Needs the Berry Jam mod.
  • Town Life: NPCs carry lanterns about in the evening, tell you about animals nearby, and pigs follow anyone holding a carrot.
  • Trader Compass: Wandering traders near you show on the compass. Range on Settings ▸ Mods. Console: traders.
  • Volcano Island: A new world type (New World > World): an island with a volcano, a crater lake, ash fields and lava-tube caves. Viggo sells sulfur.
  • Waypoint Map: M opens a map of the world in the game's own style; click for waypoints (Shift+click: shared with everyone). Waypoints show on the compass.

Mod.props

The code examples' project files import this shared file. Put it one folder above the example's folder.

<Project>
  <!--
    Shared build settings for the example code mods (each .csproj imports this).

    Builds bin/<ModFolder>/ = the mod's DLL + mod.json: copy that folder into the game's Mods folder.

    GameManaged = the game's managed DLLs:
      - a game build:  "<game folder>/Seeds & Circuits_Data/Managed"   (has everything)
      - the editor:    the project's Library/ScriptAssemblies (the default), plus
                       UnityManaged = "<Unity>/Editor/Data/Managed/UnityEngine" for Unity's own modules.

      dotnet build -c Release -p:GameManaged="C:/Games/Seeds & Circuits/Seeds & Circuits_Data/Managed"
  -->
  <PropertyGroup>
    <TargetFramework>netstandard2.1</TargetFramework>
    <LangVersion>9</LangVersion>
    <Nullable>disable</Nullable>
    <OutputPath>bin/$(ModFolder)/</OutputPath>
    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
    <GenerateDependencyFile>false</GenerateDependencyFile>
    <DebugType>portable</DebugType>
    <GameManaged Condition="'$(GameManaged)' == ''">$(MSBuildThisFileDirectory)../../../Library/ScriptAssemblies</GameManaged>
    <UnityManaged Condition="'$(UnityManaged)' == '' and Exists('C:/Program Files/Unity/Hub/Editor/6000.6.3f1/Editor/Data/Managed/UnityEngine')">C:/Program Files/Unity/Hub/Editor/6000.6.3f1/Editor/Data/Managed/UnityEngine</UnityManaged>
    <!-- No Unity installed: a game build's Managed folder has Unity's modules too. -->
    <UnityManaged Condition="'$(UnityManaged)' == ''">$(GameManaged)</UnityManaged>
  </PropertyGroup>
  <ItemGroup>
    <!-- Private=false: the game already has these, so the mod folder only gets the mod's own DLL. -->
    <Reference Include="$(GameManaged)/SeedsAndCircuits.*.dll" Private="false" />
    <Reference Include="$(GameManaged)/Unity.*.dll" Private="false" />
    <Reference Include="$(GameManaged)/UnityEngine.UI.dll" Private="false" />
    <!-- Harmony (patching the game's methods): in a game build's Managed folder, else the project's Plugins. -->
    <Reference Include="$(GameManaged)/0Harmony.dll" Condition="Exists('$(GameManaged)/0Harmony.dll')" Private="false" />
    <Reference Include="$(MSBuildThisFileDirectory)../../../Assets/Plugins/Harmony/0Harmony.dll" Condition="!Exists('$(GameManaged)/0Harmony.dll')" Private="false" />
    <!-- Unity's modules (UnityEngine.*.dll; not the UnityEngine.dll facade, which duplicates them). -->
    <Reference Include="$(UnityManaged)/UnityEngine.*.dll" Exclude="$(UnityManaged)/UnityEngine.UI.dll" Private="false" />
  </ItemGroup>
  <ItemGroup>
    <None Include="mod.json" CopyToOutputDirectory="PreserveNewest" />
  </ItemGroup>

  <!--
    ModBurst=true (in the .csproj): also compile the mod's [BurstCompile] jobs to native code with Unity's Burst compiler,
    into bin/<ModFolder>/Burst/lib_burst_mod.dll (Windows x64). The game loads it before the mod's code, so the jobs run
    as fast as the game's own. Needs Unity installed (UnityEditorData = "<Unity>/Editor/Data").
    BurstManaged = player builds of the game's and Unity packages' DLLs (Unity.Collections...): a game's Managed folder,
    or the project's Library/Bee/PlayerScriptAssemblies (there after a player build); the editor's compiled scripts have
    editor-only safety checks in them.
  -->
  <PropertyGroup>
    <UnityEditorData Condition="'$(UnityEditorData)' == '' and Exists('C:/Program Files/Unity/Hub/Editor/6000.6.3f1/Editor/Data')">C:/Program Files/Unity/Hub/Editor/6000.6.3f1/Editor/Data</UnityEditorData>
    <BurstManaged Condition="'$(BurstManaged)' == '' and Exists('$(MSBuildThisFileDirectory)../../../Library/Bee/PlayerScriptAssemblies')">$(MSBuildThisFileDirectory)../../../Library/Bee/PlayerScriptAssemblies</BurstManaged>
    <BurstManaged Condition="'$(BurstManaged)' == ''">$(GameManaged)</BurstManaged>
  </PropertyGroup>
  <Target Name="ModBurst" AfterTargets="Build" Condition="'$(ModBurst)' == 'true'">
    <Error Condition="!Exists('$(UnityEditorData)/Tools/Burst/Client/bcl/bcl.dll')"
           Text="ModBurst needs Unity 6000.6.3f1's Burst compiler: pass -p:UnityEditorData=&quot;&lt;Unity&gt;/Editor/Data&quot;." />
    <PropertyGroup>
      <BurstEngine>$(UnityEditorData)/PlaybackEngines/WindowsStandaloneSupport</BurstEngine>
      <BurstWork>$(MSBuildProjectDirectory)/$(BaseIntermediateOutputPath)burst</BurstWork>
    </PropertyGroup>
    <ItemGroup>
      <BurstArg Include="--platform=Windows" />
      <BurstArg Include="--target=X64_SSE2" />
      <BurstArg Include="--target=AVX2" />
      <BurstArg Include="--target-framework=NetFramework" />
      <BurstArg Include="--key-folder=$(BurstEngine)" />
      <BurstArg Include="--decode-folder=$(BurstWork)/decode" />
      <BurstArg Include="--temp-folder=$(BurstWork)/temp" />
      <BurstArg Include="--cache-directory=$(BurstWork)/cache" />
      <BurstArg Include="--output=$(BurstWork)/out/lib_burst_mod" />
      <BurstArg Include="--root-assembly=$(MSBuildProjectDirectory)/$(OutDir)$(AssemblyName).dll" />
      <BurstArg Include="--include-root-assembly-references=false" />
      <BurstArg Include="--assembly-folder=$(MSBuildProjectDirectory)/$(OutDir)" />
      <BurstArg Include="--assembly-folder=$(BurstEngine)/Variations/mono/Managed" />
      <BurstArg Include="--assembly-folder=$(BurstManaged)" />
      <BurstArg Include="--assembly-folder=$(GameManaged)" Condition="'$(GameManaged)' != '$(BurstManaged)'" />
      <!-- The player's Mono class libraries, not the netstandard reference assemblies: jobs are looked up by their
           signature as the player resolves it (System.IntPtr in mscorlib). -->
      <BurstArg Include="--assembly-folder=$(UnityEditorData)/MonoBleedingEdge/lib/mono/unityjit-win32" />
      <BurstArg Include="--assembly-folder=$(UnityEditorData)/MonoBleedingEdge/lib/mono/unityjit-win32/Facades" />
    </ItemGroup>
    <RemoveDir Directories="$(BurstWork)/out" />
    <MakeDir Directories="$(BurstWork)/out;$(BurstWork)/temp" />
    <WriteLinesToFile File="$(BurstWork)/burst.rsp" Lines="@(BurstArg)" Overwrite="true" />
    <Exec Command="&quot;$(UnityEditorData)/DotNetSdk/dotnet.exe&quot; &quot;$(UnityEditorData)/Tools/Burst/Client/bcl/bcl.dll&quot; &quot;@$(BurstWork)/burst.rsp&quot;"
          WorkingDirectory="$(BurstWork)" StandardOutputImportance="low" />
    <Error Condition="!Exists('$(BurstWork)/out/lib_burst_mod.dll')" Text="Burst made no library (does the mod have [BurstCompile] jobs?)." />
    <Copy SourceFiles="$(BurstWork)/out/lib_burst_mod.dll" DestinationFolder="$(OutDir)Burst" />
  </Target>
</Project>