TC8Silk-SilkRoomUtils icon

SilkRoomUtils

Room loading utilities for Silksong (BepInEx).

Last updated 2 weeks ago
Total downloads 120
Total rating 0 
Categories Libraries Utility
Dependency string TC8Silk-SilkRoomUtils-0.0.23
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_Silksong-5.4.2304 icon
BepInEx-BepInExPack_Silksong

BepInEx modloader. Preconfigured and ready to use.

Preferred version: 5.4.2304

README

SilksongRooms: shareable room loader

This repo includes a template (content/SilksongRooms) that ships a reusable room loader and a tiny integrator. It lets any mod load room JSON files (*.room.json) and Unity AssetBundles.

Highlights:

  • Drop rooms in BepInEx/plugins/<YourMod>/Rooms/ and they get picked up automatically by the SilksongRooms plugin.
  • Other mods can register their own Rooms folders at runtime via a simple API.

Use from another mod:

using BepInEx;
using SilksongRooms._1;

[BepInDependency("io.github.silksongrooms__1")]
[BepInPlugin("your.guid.here", "Your Mod", "1.0.0")]
public class YourMod : BaseUnityPlugin
{
	private void Awake()
	{
		var myRooms = System.IO.Path.Combine(BepInEx.Paths.PluginPath, Info.Metadata.Name, "Rooms");
		RoomsApi.RegisterRoomsFolder(myRooms);
		// Or single file:
		// RoomsApi.RegisterRoomJson(System.IO.Path.Combine(myRooms, "my_room.room.json"));
	}
}