KellyBetty-COTL_JSONLoader icon

COTL JSONLoader

Lets you easily mod Cult of the Lamb using JSON files and the COTL API!

Last updated 4 months ago
Total downloads 5045
Total rating 0 
Categories Libraries
Dependency string KellyBetty-COTL_JSONLoader-0.1.1
Dependants 1 other package depends on this package

This mod requires the following mods to function

BepInEx-BepInExPack_CultOfTheLamb-5.4.2101 icon
BepInEx-BepInExPack_CultOfTheLamb

BepInEx pack for Cult of the Lamb. Preconfigured and ready to use.

Preferred version: 5.4.2101
xhayper-COTL_API-0.1.11 icon
xhayper-COTL_API

A library to easily interact with Cult of the Lamb

Preferred version: 0.1.11

README

A Cult of the Lamb modding API that lets you create mods using JSON and the COTL API, without the need for any coding or coding knowledge.

This mod is currently in beta. If you find any bugs, please contact me in the Cult of the Lamb Modding Server.

Installation

This mod’s only dependencies are BepInEx .

Installation (Mod Manager)

  1. Download and install r2modman or the Thunderstore Mod Manager.
  2. Install this mod and all of its dependencies with the help of the mod manager!

Installation (Manual)

  1. Download and install BepInExPack CultOfTheLamb and the COTL API.
  2. Place the contents of "COTL_JSONLoader.zip" in its own folder within the BepInEx/plugins folder.

How To Use

You can create JSON files to use with this mod with any text editor (even Notepad!). Aside from that, all you need to do is follow the guides and name your JSON files properly.

A JSON file for a custom Follower skin, for example, should have its name ending in _follower.json. A wrong name will make this mod ignore your file.

Your JSON files, along with the images you use, should be placed inside of the BepInEx/plugins folder in order for this mod to find them.

Creating Skins

This mod supports creating custom skins through JSON.

This mod tries to keep the process of creating skins with JSON as close to how it's done through the COTL API as possible. Thus, following the tutorial for creating skins through the API will still be extremely helpful for you when creating a skin with this mod.

COTL API's Skin Tutorial

There are two types of skins you can create: Player skins (for Lamb) and Follower skins.

Lamb Skins

For Player Skins (i.e. Lamb skins), your JSON file's name should end in _lamb.json.

Your file should look like this:

{
  "$schema": "https://raw.githubusercontent.com/KBMackenzie/COTL_JSONLoader/master/schema/lamb-skin.json",
  "name": "Example Skin",
  "imagePath": "ExampleSkin.png",
  "overrides": [
    {
      "name": "HeadBack",
      "rect": "0, 0, 128, 128"
    },
    {
      "name": "HeadBackDown",
      "rect": "128, 0, 128, 128"
    },
    {
      "name": "HeadBackDown_RITUAL",
      "rect": "0, 128, 128, 128"
    },
    {
      "name": "HeadBackDown_SERMON",
      "rect": "128, 128, 128, 128"
    },
    {
      "name": "HeadFront",
      "rect": "256, 0, 128, 128"
    },
    {
      "name": "HeadFrontDown",
      "rect": "256, 128, 128, 128"
    }
  ]
}

And here's an explanation of each field.

Field Description
name The name of your skin.
imagePath The path to your image (that is, your skin's spritesheet).
overrides The overrides for your skin. A full list of the available overrides for Player skins can be found in the COTL API's Skin documentation.

Follower Skins

For Follower Skins, your JSON file's name should end in _follower.json.

Your file should look like this:

{
  "$schema": "https://raw.githubusercontent.com/KBMackenzie/COTL_JSONLoader/master/schema/follower-skin.json",
  "name": "Example Follower",
  "imagePath": "ExampleFollower.png",
  "overrides": [
    {
      "name": "LEFT_ARM_SKIN",
      "rect": "0, 0, 128, 128"
    },
    {
      "name": "RIGHT_ARM_SKIN",
      "rect": "128, 128, 256, 256"
    }
  ],
  "colors": [
    [
      {
        "name": "LEFT_ARM_SKIN",
        "hex": "#FF0000"
      },
      {
        "name": "RIGHT_ARM_SKIN",
        "hex": "#FF0000"
      }
    ],
    [
      {
        "name": "LEFT_ARM_SKIN",
        "hex": "#0000FF"
      },
      {
        "name": "RIGHT_ARM_SKIN",
        "hex": "#0000FF"
      }
    ]
  ]
}
Field Description
name The name of your skin.
imagePath The path to your image (that is, your skin's spritesheet).
overrides The overrides for your skin. A full list of the available overrides for Follower skins can be found in the COTL API's Skin documentation.
colors The available colors for your Follower skin. You can add custom colors this way! All white pixels in your selected overrides will be replaced by the selected color. This mod supports using Hex codes for colors!

Scale and Offset

You can add a scale and offset field to any override in your skin. These fields are optional.
Note that offset uses game units, not pixels. Both require a string with two numbers separated by a comma.
Offset may be reversed from what you expect, so you may need to experiment with it. Skin parts can have different types, which may affect how offset works.

Here's an example of an override with both fields:

{
  "name": "LEFT_ARM_SKIN",
  "rect": "0, 0, 128, 128",
  "scale": "1.5, 1.5",
  "offset": "0.5, -0.5"
}

Changelog

  • 0.1.1 -- Added support for scale and offset.

  • 0.1.0 -- Initial upload.