WishUtil 0.1.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package WishUtil --version 0.1.1
                    
NuGet\Install-Package WishUtil -Version 0.1.1
                    
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="WishUtil" Version="0.1.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="WishUtil" Version="0.1.1" />
                    
Directory.Packages.props
<PackageReference Include="WishUtil" />
                    
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 WishUtil --version 0.1.1
                    
#r "nuget: WishUtil, 0.1.1"
                    
#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 WishUtil@0.1.1
                    
#: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=WishUtil&version=0.1.1
                    
Install as a Cake Addin
#tool nuget:?package=WishUtil&version=0.1.1
                    
Install as a Cake Tool

Wish Util

This library provides utilities necessary for creating custom Wishes.

Creating your Wish

First, you need to make your custom Wish object by inheriting from CustomQuest.

The constructor will need to pass in a name that serves as your Wish's in-game ID, as well as LocalisedStrings for the Wish's display name and location.

Your object will also need to override 3 properites:

  • GiveAtStart tells the game whether or not to assign the Wish to the player on startup.
  • QuestType defines what type of Wish this is: Hunt, Gather, etc.
    • You can use one of the default quest types by calling GetQuestType.GetType.
    • Alternatively, you can submit a custom type using GetQuestType.BuildCustomType. You will need to provide a LocalisedString for the type's display name, the type's text color, as well as 4 Sprites for the various icons.
      • You can find examples for these icons in the Resources folder of this mod's Git project (link in Thunderstore).
  • GetDescription gives the textual description of the Wish, as shown in the Task journal.

Adding your Wish to Silksong

After you've created your Wish, you need to add it to the game. In the Start method of your mod, create an instance of your Wish and use QuestData.AddQuest to add it to WishUtil's custom Wish list.

You should probably store the Wish as a variable in your mod for ease of reference, but you can find it by name using QuestData.GetQuest.

Interacting with your Wish in Silksong

With your Wish now in the game, you can manipulate it in your HarmonyPatches. CustomQuest currently has 3 methods you can call to change your Wish's status:

  • Accept() adds the Wish to the Task journal. You can skip this part if you set GiveAtStart to true.
  • Update() signals the player that they have progressed the Wish.
  • Complete() tells the game to log the Wish as completed.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
0.2.0 68 2/24/2026
0.1.2 113 1/4/2026
0.1.1 67 1/4/2026