LiLaC API

Documentation of the public LiLaC API.

Adding dependency

LiLaC doesn't have a maven repository. You can install it from Modrinth Maven or Curse Maven.

LiLaC API is shipped as a separate JAR file from the LiLaC implementation, which can be embedded inside other JARs. Use one of modCompileOnly, modCompileOnlyApi, modImplementation configurations in gradle to add a dependency on LiLaC API JAR. The API JAR is not the main file.

To load the LiLaC implementation at runtime, add the main LiLaC JAR to the modLocalRuntime or modRuntimeOnly configuration. I have no idea what the difference is, maybe ask it in the Fabric discord. I use modLocalRuntime.

Which configuration

Disclaimer: I'm not a Gradle expert.

Configuration	When to use	LiLaC API available at
`modCompileOnly`	When you only use those parts of LiLaC API, which are only called by LiLaC (for example, the resource loader API)	Compile time
`modCompileOnlyApi`	Same as `modCompileOnly`, but use this, if your code exposes part of LiLaC API	Compile time
`modImplementation`	When you directly use LiLaC API annotated with `@RequiresImplementation`	Compile time and runtime

`fabric.mod.json`

If you use LiLaC API, you should add it to one of the dependencies blocks. LiLaC API provides lilac-api, and LiLaC (implementation) provides lilac and lilac-api.

Some guidelines what to put in which dependency block

Scenario	What to put in which dependency block	What to embed
You use LiLaC API unconditionally (required dependency)	Put `lilac` in `depends`	Nothing
You use LiLaC API conditionally (optional dependency)	Put `lilac-api` in `depends`	LiLaC API JAR
You only use those parts of LiLaC API, which are only called by LiLaC	Put `lilac-api` in `recommends` or `suggests`	Nothing

If you want LiLaC to call your API, then go to you probably want LiLaC as a required dependency.

It is recommended to add a dependency on the minor version of LiLaC (API) to avoid crashes caused by breaking changes in LiLaC. This way, Fabric will refuse to load likely incompatible mods.
For example, "lilac": "~1.0.0-beta.2" means >=1.0.0-beta.2 <1.1.0