Skip to content

Commit

Permalink
docs: update documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
ishland committed Jun 30, 2024
1 parent 60dc965 commit f32da22
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ These directories aren't git repositories in the traditional sense:
- If it says something like `212 commits ahead, 207 commits behind`, then type `git fetch` to update

## Adding Patches
Adding patches to is very simple:
Adding patches is very simple:

1. Make changes
2. `cd` into the directory you want to add a patch to
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# ScalableLux
A Fabric mod based on Starlight that improves the performance of light updates in Minecraft.
This is done by taking advantage of multiple CPU cores in parallel.

## Why does this fork exist?
- Starlight is no longer maintained as a mod [since Mar 8, 2024](https://github.com/PaperMC/Starlight/commit/cca03d62da48e876ac79196bad16864e8a96bbeb).
- The performance of vanilla lighting engine is still a bottleneck for high-performance chunk generation.
- Starlight's "stateless" design allows for parallel light updates.
This is critical for allowing the chunk system to scale beyond 25 worker threads.

## What does this fork do?
- Contains all the performance improvements from Starlight with additional bug fixes.
- Optionally allows for parallel light updates, bringing significant performance improvement in high-speed
world generation and heavy light updates scenarios.

## Building and setting up

#### Initial setup
Expand Down

0 comments on commit f32da22

Please sign in to comment.