STS2.RitsuLib 0.2.26

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package STS2.RitsuLib --version 0.2.26
                    


                    

                
NuGet\Install-Package STS2.RitsuLib -Version 0.2.26
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="STS2.RitsuLib" Version="0.2.26" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="STS2.RitsuLib" Version="0.2.26" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="STS2.RitsuLib" />
                    


                            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 STS2.RitsuLib --version 0.2.26
                    


                    

                
#r "nuget: STS2.RitsuLib, 0.2.26"
#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 STS2.RitsuLib@0.2.26
#: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=STS2.RitsuLib&version=0.2.26
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=STS2.RitsuLib&version=0.2.26
                    


                            Install as a Cake Tool

STS2-RitsuLib

Shared framework library for Slay the Spire 2 mods.

Chinese README: README.zh.md

RitsuLib is maintained as a practical authoring library. API growth is demand-driven and focused on the patterns used by the bundled mods.

The library exists alongside BaseLib and currently does not conflict with it.

Documentation site (Valaxy, bilingual): https://sts2-ritsulib.ritsukage.com/

Optional analyzers

Companion Roslyn package for RitsuLib-style mods (localization keys, Mod*Template usage, registration attributes): STS2-ModAnalyzers-RitsuLib (NuGet: STS2.ModAnalyzers.RitsuLib).

Mod Settings

RitsuLib includes a settings UI layer for player-editable values.

  • register pages explicitly with RitsuLibFramework.RegisterModSettings(...)
  • bind controls to ModDataStore instead of introducing a separate configuration backend
  • source labels and descriptions from I18N or game-native LocString
  • keep RitsuLib settings registration independent from BaseLib's config-page registry and file paths

Mod settings guide: https://sts2-ritsulib.ritsukage.com/guide/mod-settings

Debug Compatibility Mode

debug_compatibility_mode defaults to off. In that state, patched systems keep vanilla behavior.

When the master toggle is on, the settings page exposes per-feature compatibility fallbacks. Sub-toggles default to on.

Sub-setting Effect when enabled
LocTable missing keys Resolve to placeholder LocString values and log one [Localization][DebugCompat] warning per key
Invalid unlock epochs Skip invalid epoch grants and log one [Unlocks][DebugCompat] warning per stable key
THE_ARCHITECT missing dialogue Inject empty Lines entries for ModContentRegistry characters when vanilla provides no dialogue

Disabling a sub-toggle removes only that fallback.

Windows settings path:

%appdata%\SlayTheSpire2\steam\<user_id>\mod_data\com.ritsukage.sts2-RitsuLib\settings.json

Runtime bundle (multi-API, interim)

End users who want one mod folder that picks the correct RitsuLib build for the running game should install the GitHub asset STS2-RitsuLib.<version>.variant-pack.zip (not the per-compat *.github.zip files). Extract it under mods/STS2-RitsuLib/: the root STS2-RitsuLib.dll is a small loader; real builds live under lib/<api-version>/ with the same assembly name as today. Downstream mods keep declaring dependencies: ["STS2-RitsuLib"] and continue to reference NuGet (STS2.RitsuLib / STS2.RitsuLib.Compat.*) unchanged. This path is expected to be temporary until first-party workshop / per-branch installs make separate DLLs straightforward.

License

MIT

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  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. 
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.27 0 5/8/2026
0.2.26 50 5/7/2026
0.2.25 78 5/6/2026
0.2.24 62 5/6/2026
0.2.23 76 5/5/2026
0.2.21 83 5/3/2026
0.2.19 90 5/1/2026
0.2.18 82 5/1/2026
0.2.17 92 4/30/2026
0.2.15 104 4/29/2026
0.2.14 100 4/29/2026
0.2.13 104 4/29/2026
0.2.12 98 4/29/2026
0.2.11 101 4/28/2026
0.2.10 98 4/28/2026
0.2.9 105 4/27/2026
0.2.8 99 4/27/2026
Loading failed