z_mirror/BottleneckLite

git clone https://git.raiguard.me/z_mirror/BottleneckLite

Caleb HeuerRemove hard line wraps6b8f25c

trunk
branchesnew-styletrunkall refs →
2.7 KiB59 linesraw

shield shield shield

Bottleneck Lite

Bottleneck Lite is a mod for Factorio that helps you find bottlenecks in your factory. It is inspired by the Bottleneck mod, but takes advantage of newer API features to eliminate all runtime overhead and improve responsiveness.

Download on the Mod Portal.

Features

Bottleneck Lite adds "indicators" to every crafting machine and mining drill, allowing you to quickly determine its status.

The indicators will be colored according to these statuses:

  • Disabled (red)
  • Full output (yellow)
  • Idle (red)
  • Insufficient input (red)
  • Low power (yellow)
  • No minable resources (red)
  • No power (red)
  • Working (green)

The colors are freely customizable in the mod settings menu. To hide an indicator entirely, set Alpha (A) to zero. Other settings include indicator size, whether or not they will glow in the dark, and whether or not they will be drawn on mining drills.

NOTE: Because of the way the mod works, all settings are under the Startup tab in the mod settings menu, and any changes require restarting Factorio to take effect.

Features

Compared to Bottleneck

Bottleneck Lite, in comparison to Bottleneck, has no runtime scripting. The indicators are added to the actual sprites of each entity, and are tinted based on the working visualisations property. This means that Bottleneck Lite can scale infinitely, and will instantly respond to changes in entity status regardless of how many entities there are.

Pros

  • Zero runtime overhead
  • Instant responsiveness regardless of scale
  • Indicators can glow in the dark
  • Significantly fewer settings (some might consider this a con)

Cons

  • Changing settings requires restarting Factorio
  • No hotkey to toggle the indicators - enabling/disabling them is a setting, and so requires a restart
  • Only one style of indicator (no alert, cross, stop, minus, or 3D variants)
  • No indicators on labs

Compatibility

For mod authors - if you don't want an indicator to show on your entity for some reason, add bottleneck_ignore = true to its prototype and BNL will ignore it.

Screenshots

1[![shield](https://img.shields.io/badge/Ko--fi-Donate%20-hotpink?logo=kofi&logoColor=white)](https://ko-fi.com/raiguard)
2[![shield](https://img.shields.io/badge/Crowdin-Translate-brightgreen)](https://crowdin.com/project/raiguards-factorio-mods)
3[![shield](https://img.shields.io/badge/dynamic/json?color=orange&label=Factorio&query=downloads_count&suffix=%20downloads&url=https%3A%2F%2Fmods.factorio.com%2Fapi%2Fmods%2FBottleneckLite)](https://mods.factorio.com/mod/BottleneckLite)
4
5# Bottleneck Lite
6
7Bottleneck Lite is a mod for Factorio that helps you find bottlenecks in your factory. It is inspired by the [Bottleneck](https://mods.factorio.com/mod/Bottleneck) mod, but takes advantage of newer API features to eliminate _all_ runtime overhead and improve responsiveness.
8
9[Download on the Mod Portal.](https://mods.factorio.com/mod/BottleneckLite)
10
11## Features
12
13Bottleneck Lite adds "indicators" to every crafting machine and mining drill, allowing you to quickly determine its status.
14
15The indicators will be colored according to these statuses:
16
17- Disabled (red)
18- Full output (yellow)
19- Idle (red)
20- Insufficient input (red)
21- Low power (yellow)
22- No minable resources (red)
23- No power (red)
24- Working (green)
25
26The colors are freely customizable in the mod settings menu. To hide an indicator entirely, set Alpha (A) to zero. Other settings include indicator size, whether or not they will glow in the dark, and whether or not they will be drawn on mining drills.
27
28**NOTE:** Because of the way the mod works, all settings are under the `Startup` tab in the mod settings menu, and any changes require restarting Factorio to take effect.
29
30## Features
31
32## Compared to [Bottleneck](https://mods.factorio.com/mod/Bottleneck)
33
34Bottleneck Lite, in comparison to Bottleneck, has _no runtime scripting_. The indicators are added to the actual sprites of each entity, and are tinted based on the working visualisations property. This means that Bottleneck Lite can scale infinitely, and will instantly respond to changes in entity status regardless of how many entities there are.
35
36### Pros
37
38- Zero runtime overhead
39- Instant responsiveness regardless of scale
40- Indicators can glow in the dark
41- Significantly fewer settings (some might consider this a con)
42
43### Cons
44
45- Changing settings requires restarting Factorio
46- No hotkey to toggle the indicators - enabling/disabling them is a setting,
47  and so requires a restart
48- Only one style of indicator (no alert, cross, stop, minus, or 3D variants)
49- No indicators on labs
50
51## Compatibility
52
53For mod authors - if you don't want an indicator to show on your entity for some reason, add `bottleneck_ignore = true` to its prototype and BNL will ignore it.
54
55## Screenshots
56
57![](screenshots/demo-screenshot.png)
58
59![](screenshots/demo-screenshot-night.png)