CustomStoryLogs

A Mod Library for use with Lethal Company.

Allows you to add custom story logs to the terminal, and in world interactables to unlock them.

This is my first mod intended for use by other people as a library, so the code is inconsistent and messy. Any feed back and help is very welcome!

Logs can be added with code, or through a text/json file created with my Log Builder tool!

Using the Log Builder

Fill out all the box in the Log Builder, add as many logs as you need.

Once you have everything filled out, click export to generate the json data (it will give you something similar to the below example), and then click copy text.

{
    "username": "Yorimor",
    "modname": "ExampleLog",
    "version": "1.2.3",
    "logs": {
        "0": {
            "name": "Example - May 12",
            "text": "This is an example log, created with the log builder!\n\n:D",
            "moon": "71 Gordion",
            "position": {
                "X": "-28",
                "Y": "-2",
                "Z": "-15"
            },
            "rotation": {
                "X": "0",
                "Y": "0",
                "Z": "0"
            }
        }
    }
}

In your own mods files create the following folders <Your Mod Folder>/BepInEx/plugins/CustomStoryLogs/logs/

In the logs folder create a new .txt or .json file (name it anything you like) and paste the json data into the file and save it.

And that's it! My mod will automatically load the logs and place them in game for you!

Using the library through code

Add a story log:

// public static int RegisterCustomLog(string modGUID, string logName, string text, bool unlocked=false, bool hidden=false)
int myLogID = CustomStoryLogs.CustomStoryLogs.RegisterCustomLog(YOUR_MOD_GUID, "Log Name - May 09", "test\nunlocked\nnot hidden");

The function returns an integer which is used to uniquely identify the new log. It is created from a hash of your mods GUID and the first word in the log name.

The first word in the log name is also used as the keyword for opening the log, e.g. to open Bridge collapse - Mar 19 you would type view bridge.

The log ID is used below to create an interactable pickup in world. Alternatively you can call CustomStoryLogs.CustomStoryLogs.UnlockStoryLogOnServer(logID) to unlock the log through code instead of a pickup.

You can also define if the log is already unlocked or hidden the terminal list.

Add an interactable:

// public static void RegisterCustomLogCollectable(string modGUID, int logID, string planetName, Vector3 position, Vector3 rotation, int modelID=0)
CustomStoryLogs.CustomStoryLogs.RegisterCustomLogCollectable(YOUR_MOD_GUID, "71 Gordion", new Vector3(-28,-2,-15), Vector3.zero);

This spawns the interactable on the Company moon just in front of the ship. Interactable objects are removed when leaving the moon.

Using a custom model

You can register a prefab as a new model, and use it for collectables. Any custom models will require a CollisionBox component to be attached, as this will be used for the interaction.

Follow the asset bundling guide on lethal.wiki to make and load your own assets

// public static int RegisterCustomLogModel(GameObject customModel)
int modelID = CustomStoryLogs.CustomStoryLogs.RegisterCustomLogModel(myModel);

// Then use this ID for any of the collectables you want to use the new model
CustomStoryLogs.CustomStoryLogs.RegisterCustomLogCollectable(YOUR_MOD_GUID, "71 Gordion", new Vector3(-28,-2,-15), Vector3.zero, modelID);

Planned Features

• Improve docs
• Events for when a log is collected
• Add custom log views, instead of having it all under sigurd
• Ability to use custom model/game objects for the pickup Done!
• Add logs from text/json files Done!

Credits

• Noah E. for helping so much in creating the Log Builder
• Xilophor's LethalNetworkAPI and Project Template
• Evaisa's LethaLib
• Model used: https://elbolilloduro.itch.io/exploration-objects

v1.4.3 - Added debug log message for created log IDs

v1.4.2 - Added config to enable/disable the placement tool

v1.4.1 - Added in game placement tool

v1.3.2 - Fix for already collected log events not being called on game/save reload

v1.3.2 - Now checks for scene names as well as planet names. Added check for invalid directories.

v1.3.1 - Added Events, and a way to change log text

v1.2.1 - Added ability to use custom models

v1.1.1 - Added ability to load logs from json/txt files

v1.0.3 - Minor changes, added some debug logs

v1.0.2 - Changed register methods to be static

v1.0.1 - Fixed rotation not being applied

v1.0.0 - Initial Release