JPOGTrex 🦖

This repository contains the full source code for the JPOGTrex for Lethal Company, including the Unity project which can be used to build its asset bundle.
The guide I followed for this project can be found here.
A video Tutorial can be found here.

[!NOTE]
The wiki page might be slightly out of date regarding how the JPOGTrex prefab is constructed.

[!NOTE]
I do not own any of the Assets nor made them myself. The models, animations and some of the audio clips were made by: Blue Tongue Entertainment, which was closed down in 2011.
I also got some sounds for the T-Rex from the game: Primal Carnage: Extinction.

Dependencies ✅

You need to install the following dependencies for this mod to work in the game (these are not installed by the setup script):

• LethalLib for registering and adding our enemy.
  • LethalLib depends on HookGenPatcher.

If you didn't run the setup script you will also need to, in the Plugin directory where our plugin code is, run dotnet tool restore on the command-line to install the rest of the dependencies.
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!

Thunderstore Packages 📦

We have configured JPOGTrex.csproj to build a Thunderstore package to /Plugin/Thunderstore/Packages/ using tcli each time we make a release build of our mod. A release build can be done for example from the command-line like this: dotnet build -c release. This will use configuration options from thunderstore.toml, so configure it for your own mod! Do note that we have not included a way to upload your mod to thunderstore via tcli in this project.

Trouble shooting 🛠️

This section is mostly for myself to check how things should be made, or what to check if something isn't working as intended.
It should give some tips when encountering problems in this project or your own.

General

• Don't forget to replace the build dll into: "UnityProject\Assets\Plugins" so the game object has all scripts and properties it needs available
• Don't forget to add the prefab or other assets to the assetbundle in Unity
• Important events or manipulation of the model should be handles with networking. e.g. [ServerRpc] > [ClientRpc] > method()
  • If not done correctly it could cause syncing issues e.g. the body of the player being grabbed by the enemy for one player but laying on the ground for the other
• Hit registration should be done server side: "[ServerRpc] > method()", to prevent latency of "[ServerRpc] > [ClientRpc] > method()" effecting the hit registration.

Animations

• Most animation in this project are started from the "any event". I am not sure if this is best practice, but it makes animating a lot easier.
• Coroutine can be can be used to execute code over frames. Usefull for waiting on animaitons to finish or executing logic at certain points during the animations.
• Enabling "Has Exit Time" makes animation B wait for animation A to finish in a transition of A > B.
• The T-Rex has a "mouthGrip" transform which is bind to the "mouthBone" of the model.
  • This way the mouthGrip's transform location can be updated in the code with the mouthBone's transform location, making the mouthGrip match the position of the T-Rex's mouth during animations.

Credits 🗣️

• EvaisaDev - LethalLib
• Lordfirespeed - reference tcli usage in LethalLib
• Xilophor - csproj files taken from Xilo's mod templates
• XuuXiao - porting LC-ExampleEnemy for LC v50
• nomnomab - Lethal Company Project Patcher - used for the Unity Project
• AlbinoGeek - issue template
• HENDRIX-ZT2 & AdventureT - creating the blender plugin: jpog-blender that is able to read ".tmd" files from the game: Jurassic Park: Operation Genisis
• Primal Carnage: Extinction - I use some of the sounds from their T-Rex