ℹ️ Fork Information

This mod is a direct fork of erykczy's Colorful Lighting. Our main goal with this fork is to extend mod compatability for use in larger modpacks. If you find an incompatible mod, please report it on the GitHub Issues page.

❓ How It Works

This mod is built on top of Minecraft's vanilla lighting engine. It works by storing an extra set of data alongside the vanilla light levels, representing the color of the light in that block. When a light-emitting block is placed, the mod checks a list of configurable "emitters" to see if it should have a color. If it does, the color is propagated outwards, block by block, diminishing with distance, just like the vanilla engine.

When light passes through a semi-transparent block, the mod checks a list of "filters". These filters can change the color of the light passing through them. For example, red stained glass can be configured to filter out all but the red component of light. The amount of light that is blocked can also be configured.

To avoid performance issues, all of this light propagation is handled on a separate thread, which means it won't slow down your game. The mod also uses techniques like trilinear interpolation to smooth out the colors between blocks, creating a more natural look.

✨ Features

• Different blocks can emit different colors
• Light can change color when passing through certain blocks
• Emitted colors, and filtered colors can be customized in resource packs
• Supports block state changes.
• The mod is client side - you can play with it on ANY server while still experiencing colorful lighting!

🔗 Mod Compatability

• Embeddium Support: Embeddium is fully compatible and a REQUIREMENT.
• Starlight Support: Works seamlessly with Starlight.
• True Darkness Support: Compatible with True Darkness.
• Oculus Support: Most shader packs must be manually modified to support Colorful Lighting. By default, the Colored Light Engine is disabled when a shader is active.
• Dynamic Light Mods: Most Dynamic Light mods will simply not work. Lively Lighting is the only known working Dynamic Lighting Mod compatible with Colorful Lighting.
• Wakes: Reforged: No longer crashes and wakes now change in color depending on light color.
• Flywheel: Flywheel rendered objects near light will light up but won't have colored light. This is something we are working on for a future release.
• Distant Horizons: Lights rendered inside LODs will not have color. This is something we are working on for a future release.
• Flerovium: Held and dropped items will appear dark. This is something we are working on for a future release.
• AsyncParticles: Particles appear dark. This is something we are working on for a future release.
• Lively Lighting: Dynamic light sources will emit light with their respective color.
• Immersive Portals: Does not crash, but the light from the Nether will bleed into the Overworld when an immersive portal is being rendered. This may be fixed in the future.

🖼️ Resource Pack Tutorial

In your resourcepack's namespace folder (where folders like textures and models are located) create a light folder. There, you can create an emitters.json file, which defines what light colors blocks emit.

emitters.json

This file defines the color of light emitted by blocks. You can specify a simple color, or use a more complex objects to handle block states.

Simple Format

{
          "minecraft:torch": "vanilla",               // Same color used in Vanilla lighting
	"minecraft:glowstone": "#00FF00",           // color in hex
	"minecraft:red_candle": "red",              // Minecraft dye name
	"minecraft:redstone_lamp": [0,255,255],     // RGB array
	"minecraft:soul_torch": "purple;5",         // override light level emission value after ';' is a hex number from 0 to F (F = 15)
}

Block State Format

You can define different colors for different block states.

{
    "minecraft:furnace": {
        "default": "orange",
        "states": {
            "lit=true": "red",
            "lit=false": "#000000"
        }
    }
}

filters.json

This file defines how light is colored when passing through blocks (like stained glass). You can also specify light absorption (0-15), where 0 allows all light to pass and 15 blocks all light.

Simple Format

{
	"minecraft:red_stained_glass": "#00FF00", // color in hex
	"minecraft:green_stained_glass": "red",   // dye name
	"minecraft:glass": [ 0, 255, 255 ],       // RGB array
          "minecraft:oak_door": "white;5"           // light absorption (0=full pass, 15=blocked)
}

Block State Format

Similar to emitters, filters can also depend on block states.

{
    "minecraft:stained_glass_pane": {
        "default": "white",
        "states": {
            "waterlogged=true": "blue"
        }
    },
    "minecraft:oak_door": {
    "default": "white;15",
    "states": {
      "open=true": "white;0",
      "open=false": "white;15"
    }
}

entities.json

Define what light color entities emit (REQUIRES LIVELY LIGHTING).

{
	"minecraft:creeper": "#00FF00", // color in hex
	"minecraft:blaze": "orange"     // dye name
}

items.json

Define what light color held items emit (REQUIRES LIVELY LIGHTING).

{
	"minecraft:torch": "#00FF00",     // color in hex
	"minecraft:lava_bucket": "orange" // dye name
}

moon_phases.json

Define a seperate light intensity/vibrancy value for each moon phase.

{
  "0": 0.45,
  "1": 0.60,
  "2": 0.75,
  "3": 0.90,
  "4": 1.0,
  "5": 0.90,
  "6": 0.75,
  "7": 0.45
}

‼️ Working Shader Packs

• https://github.com/Waterpicker/Super-Duper-Vanilla

⚠️ Known Issues/Planned Fixes

• When two light sources are changed/removed near each other, it can sometimes leave behind some spots of lingering light. You can run /cl purge to reload the engine and remove the lingering light. This issue is actively being researched and will be fixed in the future
• Blocks with emissive textures don't properly propagate lighting outwards
• The lower part of doors render way darker than they should