README.md

BismuthLib

A simple client-side colored light mod/library for Fabric. Can load information about block light colors from resourcepacks and calculate color for blocks that don't have json-specified colors.

How to add light to blocks:

BismuthLib use resourcepacks to add color light to blocks. You can add custom blocks from both mod resources and simple resourcepack.

To add blocks you need to use this resource path:

assets/bismuthlib/lights/<your_file>.json

To keep files clear it is better to name them like mod_id.json, examples:

• minecraft.json;
• betterend.json;
• edenring.json.

Internal json structure should look like this:

{
	"block_id_1": {
		"color": "...",
		"radius": "..."
	},
	"block_id_2": {
		"color": "...",
		"radius": "..."
	},
	"block_id_3": {}
}

Both "color" and "radius" tags are required. If there are no any tags ("block_id_3" in example above) light will be removed from that block.

Json files can override each other if they have same name. You can also override values in other json files if they will be loaded after file with values that you want to override.

Color can be:

• String color representation (examples: "ffffff" = white, "ff0000" = red);
• "provider=" - this will use block color provider (block color in mojmap) to colorize block. Index is a layer index (for most blocks it is zero)
• Jsom Object - this will be used as a state map, example:

"color": {
	"power=0": "ff0000",
	"power=1": "00ff00",
	"power=2": "0000ff",
	"power=3": "ffffff"
}

Each state in map is defined with properties that will have light, if block have other properties - they will get light automatically if state has same properties in table. For example if block with "power" property has "waterlogged" property, and we specified only power - all states will get light based on power (independently of waterlogged). This is useful if block have many properties, and you don't want to add all variation.

Radius can be:

• Integer value, example: "radius": 3;
• Jsom Object - this will be used as a state map, see description above.

You can combine state maps for both color and radius, in that case light will be added to states that have both radius and color.

Examples

Vanilla Blocks Example

Simple light

Will just add color to block (to all states of block)

"minecraft:beacon": {
	"color": "9cf2ed",
	"radius": 15
}

Light with different radius

Can be used for blocks that have active and passive states (furnaces, lamps, etc.):

"minecraft:blast_furnace": {
	"color": "ed5d0a",
	"radius": {
		"lit=true": 13
	}
}

Example for different radius values:

"minecraft:respawn_anchor": {
	"color": "8308e4",
	"radius": {
		"charges=1": 3,
		"charges=2": 7,
		"charges=3": 11,
		"charges=4": 15
	}
}

Light with different colors

Provider light:

"minecraft:oak_leaves": {
	"color": "provider=0",
	"radius": 3
}

Value after = is provider index. For most bloks it is zero, but some blocks can have more than one index layer.

States light:

"minecraft:black_candle": {
	"color": {
		"lit=true,candles=1": "ff0000",
		"lit=true,candles=2": "ffff00",
		"lit=true,candles=3": "00ffff",
		"lit=true,candles=4": "00ff00"
	},
	"radius": {
		"lit=true,candles=1": 3,
		"lit=true,candles=2": 6,
		"lit=true,candles=3": 9,
		"lit=true,candles=4": 12
	}
}