diff --git a/Dev-Debug-Window.md b/Dev-Debug-Window.md new file mode 100644 index 0000000..62869f8 --- /dev/null +++ b/Dev-Debug-Window.md @@ -0,0 +1,38 @@ +The Dev Debug Window is a window you can open inside of Lethal Company. It can do some of the following things: + +- Generate any dungeon on any moon +- Edit DungeonFlow (i.e. dungeon generation) values +- Add DunGenPlus to any dungeon +- Edit DunGenPlus values + +This allows interior devs to quickly iterate on their dungeons that would otherwise be impossible in the Unity Editor or annoying in game. + +![](https://i.imgur.com/PjVteJj.png) + +# How to Open + +After loading Lethal Company once with this mod installed, the config for Dungeon Generation Plus will be generated. Inside of `dev.ladyalice.dungenplus.cfg`, set the `Enable Dev Debug Tools` config to true. After that config is set, simply press LeftAlt + M while inside the ship to open the window. Only useable if you are alone in the ship. The window automatically closes if any player joins the session. + +I also highly recommend you to set `BepInEx.cfg` `Logging.Console.LogLevels` to `All`. This will enable the Debug messages to appear in the console where most of the DunGenPlus generation messages can be found. + +# Controls + +Hold down Middle Mouse while moving the mouse to drag the screen around. + +# Panels + +### Main + +Where some of the generic dungeon generator values (i.e. seed) can be set. You can also set the level (moon) in this panel, which in turn sets the dungeon's length multiplier. GenerateAsync also exists so you can see the dungeon generate tile by tile. + +### DunFlow + +Where some of the `DungeonFlow's` values (i.e. length, nodes, lines) can be set. + +### Plus+ + +Where some of the `DunGenPlusExtender` values (from DunGenPlus) can be set. You can also create a `DunGenPlusExtender` asset for any dungeon. You can also diable/enable the asset on the dungeon, allowing you to toggle DunGenPlus's involvement in the dungeon generation process. + +### Assets + +Where some of the assets' values (i.e. Archetypes, TileSets, Tiles, MainPathExtenders) can be edited. These assets are used throughout the DunFlow and Plus+ panels, but you only directly edit their values in this panel. \ No newline at end of file