LightAPI

Description
Bukkit library for edit light levels

Features
- Edit light levels in minecraft world

Current supported platforms
- CraftBukkit/Spigot (1.14.1 - 1.19)

Current supported light engines
- Vanilla engine (1.14.1 - 1.19)
- Starlight engine (1.17.1 - 1.19)

How to use
Very simple.
If you want to edit light level (with deferred policy):
After calling this function, your request is added to the queue and will be executed after a while with automatic sending to all clients (by default, after 1 tick).

If you want more control, you can use:
Using the following parameters, you can:
- lightFlags: choose which lighting layer to make changes on, as well as combine them;
- editPolicy: choose a edit policy (apply changes right now, apply immediately taking into account the state of the server, or apply deferred (by default 1 tick)).
- sendPolicy: choose a policy for sending lighting data to clients (send separate packets for each change or combine the same chunks within an interval (by default 2 tick)).
- callback: get execution result codes about completed stages.

If this is not enough for you, then you can use IBukkitExtension to get a Handler class.
With this class, you get "raw" access to library elements.

Commands
- /lightapi - main command

Known issues
- (ALL) Custom lighting levels have no protection from in-game minecraft mechanics. Therefore, the light may disappear if a regular block is placed/broken nearby (within a radius of one block) or will it just happen.
- (STARLIGHT) After unloading chunks, some custom lighting levels disappear from unloaded chunk.
- (STARLIGHT) There may be problems with the IMMEDIATE edit policy set.
- (STARLIGHT) At a random moment in time, the server may crash for unknown reasons.
- GitHub

Configuration
Default configuration:
general:
debug - enables debug messages.
enable-metrics - enables bStats metrics.
enable-compatibility-mode - enables compatibility mode, where instead of editing lighting data, the plugin places blocks of light. Does not support Skylight editing. Works only with 1.17+.
force-enable-legacy - enables support for legacy plugins (from ru.beykerykt.lightapi namespace).
specific-handler-path - the path for forced loading of the handler.
handlers.* - a list of platforms and their paths to the HandlerFactory.
BukkitBackgroundService:
corePoolSize - The number of threads allocated for internal tasks.
BukkitScheduledChunkObserver:
tick-period - The delay in server ticks before queue processing.
BukkitScheduledLightEngine:
relight-strategy - A strategy for recalculating lighting. The values can be as follows: DEFERRED - recalculation is performed after ALL changes are applied. FORWARD - recalculation is performed after EACH change.
tick-period - The delay in server ticks before queue processing.
max-time-ms-in-per-tick - The maximum time (in milliseconds) allocated for processing requests for each tick.
max-iterations-in-per-tick - The maximum number of processed requests per tick.

Example usage
- BeYkeRYkt's bukkit-example plugin
- ???

Maven
https://jitpack.io/#BeYkeRYkt/LightAPI
subproject: lightapi-bukkit-common
Special thanks
- Qveshn ( @bottomdumber) - for continuous support for Legacy version
- and other contributors who create a pull requests and report errors found.

Source code
https://github.com/BeYkeRYkt/LightAPI
License is MIT

Metrics
Plugin uses the bStats metrics.
Privacy policy
bStats license