Skip to content

Commit 77dfaab

Browse files
committed
update readme with metrics
1 parent 5fd3171 commit 77dfaab

File tree

3 files changed

+40
-0
lines changed

3 files changed

+40
-0
lines changed

README.MD

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,51 @@ reference implementation.
1414
- [FalsePatternLib 1.2.0+](https://github.com/FalsePattern/FalsePatternLib)
1515
- [UniMixins 0.1.11+](https://github.com/LegacyModdingMC/UniMixins)
1616

17+
## Performance
18+
19+
The main performance improvement comes from the fact that the lighting engine is evaluated "lazily", thus it is able to batch more lighting updates
20+
into a single pass.
21+
22+
Here are some simple to understand values, generated via profiling a pre-set test case:
23+
24+
<details>
25+
<summary>Test Case</summary>
26+
27+
- World Type: Default
28+
- World Seed: 123
29+
- Game Mode: Creative
30+
- Render Distance: 16
31+
32+
Profiler is started right before clicking Create New World, and stopped after 10 seconds of flying in a straight line in creative mode.
33+
34+
Without Lumi, the active server time spent in lighting engine is 34% of the total active server time (not counting when the server thread is sleeping).
35+
36+
With Lumi, this fraction goes down to 13%, or an approximately 2.5x performance increase over vanilla.
37+
38+
</details>
39+
40+
<details>
41+
<summary>Flame Graphs</summary>
42+
43+
Horizontal axis is time, vertical axis is the call stack. The blue highlighted parts are calls to the lighting engine update method.
44+
45+
![Flame Graph Without Lumi](docs/Flame_No_Lumi.png)
46+
47+
![Flame Graph With Lumi](docs/Flame_Yes_Lumi.png)
48+
49+
</details>
50+
1751
## Incompatibilities
1852

1953
- [ArchaicFix](https://github.com/embeddedt/ArchaicFix): Config Change Needed
2054
- As both mods replace the same parts of code, naturally you will need to set `enablePhosphor` to `false` in the
2155
ArchaicFix config.
56+
- [CoreTweaks](https://github.com/makamys/CoreTweaks): Config Change Needed
57+
- The `fix_heightmap_range` feature is already implemented in Lumi's lighting engine. Set it to `false` in the
58+
CoreTweaks config.
59+
60+
Both of these configs will be automatically modified by Lumi automatically when you launch the game, so you shouldn't even
61+
need to edit the config files manually.
2262

2363
## Authors
2464

docs/Flame_No_Lumi.png

191 KB
Loading

docs/Flame_Yes_Lumi.png

218 KB
Loading

0 commit comments

Comments
 (0)