/LethalDungeon

A complete unity project template dungeon for Lethal Company

Primary LanguageC#MIT LicenseMIT

Lethal Dungeon

A complete unity project which contains all of the pieces required to make a dungeon for Lethal Company. It contains class stubs required to spawn scrap, turrets, etc but does not include any of Lethal Companies Definition code.

You will need to fork and rename this projects naming to make a newly named dungeon from it. I might have time to build an automation process for this in the future but it isn't pressing.

This template demonstrates

  • A properly setup dungeon flow which contains an entrance and some number of fire exits
  • Fire exit blockers
  • Hazard placement (Turrets and Landmines)
  • Scrap placement
  • Enemy Vent spawners placement
  • Kill player triggers (falling to your death)
  • Storage locker placement

How to build and install

  • Pull this repo to a folder to work in
  • Grab the DunGen plugin from here: https://assetstore.unity.com/packages/tools/utilities/dungen-15682
  • Place the DunGen folder into the projects Assets folder, do not replace anything as the .meta files need to be maintained as they are
  • Open the Unity project in unity 2022.3.9f1
  • Run from the drop down "Lethal Dungeon/Build Dungeon Bundle". This will generate the bundle into Assets\DungeonBundles
  • Grab the bundle "exampledungeon" for later
  • In your lethal company folder where BepinEx is create a folder called "LethalDungeon" in BepInEx\plugins
  • Copy "Plugin\Prebuilt\LethalDungeon.dll" into the "LethalDungeon"
  • Copy "exampledungeon" into the "LethalDungeon"
  • Make sure to have LethalLib and HookGenPatcher installed into your BepInEx plugins
  • Run the game and close. You can now modify "BepInEx\config\LethalDungeon.cfg" to assign the dungeon to the moons you would like using the "Moons" setting

Checking how the dungeon will look before opening Lethal Company

In Unity open the GenerateDungeon scene and run it. From this you can see what it will look like in game minus the post process effects Lethal Company has.

Coming next

  • Steam valves
  • Breaker boxes
  • terminal and breaker controllable Large doors
  • Apparatus
  • Be able to detect how many fire exits are needed and updating the flow global params before generating
  • Create some automated process of generated a newly named dungeon

Dependencies

  • You will need a copy of the plugin DunGen to use this project. The files must be placed in Assets/DunGen. Do not replace the .meta files already in there.
  • LethalLib : https://github.com/EvaisaDev/LethalLib

Special Thanks

  • Badhamknibbs for the SCP dungeon which helped me understand how to build the BepinEx plugin.
  • LethalLib for giving us the tools to get things into the game!
  • The Lethal Company modding Community at large!

Attributions and licenses

The plugin is based on Badhamknibbs SCP dungeon code which can be found here: https://github.com/Badhamknibbs/SCPCB_DunGen_LC

The code of this mod is provided under the MIT license (see license file)