From 7f9f2346d097471da6d517eb762143b4c5de3f41 Mon Sep 17 00:00:00 2001 From: Raphtalia Date: Fri, 26 Jul 2024 10:21:24 +0000 Subject: [PATCH] Update Setup --- Setup.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Setup.md b/Setup.md index 7271f45..e25ff95 100644 --- a/Setup.md +++ b/Setup.md @@ -1,6 +1,6 @@ This guide is to setup DungeonGenerationPlus into your Unity project and interior mod. [See here](https://git.touhou.dev/Raphtalia/DungeonGenerationPlus_LethalCompany_Mod/wiki/Quick-Setup) to setting up multiple main paths. -### Setting up the plugin in your Unity project +## Setting up the plugin in your Unity project Download the `DunGenPlus.dll` through Thunderstore or through this Github repository. Drag and drop the `.dll` file into your interior Unity project. This mod also requires the [LethalLevelLoader](https://thunderstore.io/c/lethal-company/p/IAmBatby/LethalLevelLoader/) plugin to be installed in your Unity project. With just those simple steps, the mod is installed. You can now setup and use this mod's features. @@ -8,7 +8,7 @@ This goes without saying, this mod also requires the DungeonGenerationPlus mod t If you'd like to use this mod's API and callback features, reference the same `DunGenPlus.dll` file in your code project thing what do you call that? -### Setting up the DunGenExtender asset +## Setting up the DunGenExtender asset Inside the Project tab, right click to open the Assets tab. Select `Create/DunGenExtender` to create the `DunGenExtender` asset. Inside that asset, reference the `DungeonFlow` that will be linked to this Extender asset. Finally, set it's AssetBundle name to the same one as your interior's asset, `DungeonFlow` or `ExtendedDungeonFlow` whichever it may be. @@ -26,7 +26,7 @@ After any of the two previous steps, verify that the Extender was registered by ![](https://i.imgur.com/yVUBkPj.png) -### Setting up the API Callbacks +## Setting up the API Callbacks After your interior is selected but before it is generated, a shallow copy of the DunGenExtender's properties is passed to an event caller thing. You can register a function call to this event caller thing to modify the properties before they are used. This is useful if you have configs for your dungeon's generation. The following is a code example of how to register a function call and how you may want to use it.