trebossalol / toiletleechisreal

A Lethal Company mod which implements a fully custom enemy, the Toilet Leech, into the game.

IMPORTANT!

LC-ExampleEnemy is taking the place of ToiletLeechIsReal as the example enemy! Please use that project instead as the base/example for your enemy! The guide however does not exist in that repo, but is instead ported over for the Lethal Company Modding Wiki.

Toilet Leech Is Real

Note

This project is still a WIP. See the progress at the bottom of this page

This repository contains the full source code for the Toilet Leech enemy for Lethal Company, including the Unity project which can be used to make an asset bundle. This project is designed to be used as a template/reference for creating your own modded enemy, and even comes with a guide! The guide explains the asset bundle side of Toilet Leech, as it is not as straight forward as the coding side. The code of this project can be found under the src directory, and as you can see, there doesn't need to be much code for a custom enemy.

Setting Up The Project For Development

After copying this repo for yourself, run SETUP-PROJECT.py (make sure you have Python installed) to copy all the DLL files from the game files that the C# project and the Unity project depend on. However, make sure you have https://thunderstore.io/c/lethal-company/p/Evaisa/HookGenPatcher/ installed and ran the game at least once with it so it can generate a few files. That should be all the required setup for this project, and now you can move to coding AI or making your own 3D models for your custom enemy. Good luck! And make sure you read the guide!

AboutAssets.md Resource Progress

Note

Contributions are welcome! This will help new modders get started with making custom enemies, so it would be super awesome if you contributed your knowledge and shared some useful resources! Feel free to open an issue or ping me on discord under the toilet leech post or DM me! This resource could possibly find its way to the Lethal Company Modding Wiki.

• Blender resources
  • Basics
  • Modeling
  • Materials & texturing, UV Unwrapping
  • Rigging
  • Animation
  • How to export model for Unity
  • Common issues and how to fix them
• Unity resources
  • What are asset bundles?
  • How to add stuff to asset bundles
  • Building asset bundles
  • How Toilet Leech is configured
  • Importing fbx models (your model from blender)
  • What are prefabs
  • Referencing our AI script in a prefab

Mod Progress

• Mod builds, enemy works in game, even if the AI is super basic
• All enemy components are there (right click shows enemy name, enemy info page gets added to terminal)
• More complex, interesting AI
  • gets in front of player if close, might decide to attack at any point
  • likes music?
  • 2 or 3 spit attacks used in short succession: enemy gets exhausted and the head gets smaller and it will be at its weakest. A good moment to flush the toilet
  • and more...
• Enemy attacks
  • head swing attack
  • spit attack: will slow player movement
  • suck attack: will suck players who are stuck or get too close
  • fire attack????

Credits

Evaisa - https://github.com/EvaisaDev/LethalCompanyUnityTemplate
Bug issue template taken and modified from https://github.com/LethalModding/Radar_Ident_QuickSwitch
...and everyone who has helped with this project!