[MOD 0.14.x] Bottleneck

[trold]

Type: Mod
Name: Bottleneck
Description: The mod decorates assembling machines with an indicator light, making it easier to identify bottlenecks in your factory
License: MIT
Version: 0.10.0
Release: 2016-06-11
Tested-With-Factorio-Version: 0.18.0
Category: Helper
Tags: User-Interface, Info
Download-Url: https://mods.factorio.com/api/downloads ... 0.10.5.zip
Website: https://github.com/troelsbjerre/Bottleneck

License

License
The MIT License (MIT)

Copyright (c) 2016 troelsbjerre

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Long description

Long description
The mod decorates assembling machines, furnaces, mining drill, pump jacks, and chemical plants with an indicator light, making it easier to identify bottlenecks in your factory:

• Green: currently doing stuff
• Yellow: not currently doing anything, limited by the output
• Red: not currently doing anything, limited by the input

The above colors are configurable through the settings menu, e.g., swap out yellow for blue for high contrast.

Hotkey to toggle lights: SHIFT + ALT + L

The mod configuration menu (Game menu -> mods) has the following options:

• Number of machines updated per game tick (Default is 40, i.e. 40 machines/tick * 60 ticks/second=2400 machines/second). This ensures that the mod uses the same amount of time per tick on a small factory as on a large one, but as the factory gets larger, the lights update less frequently. If your factory has 10000 machines, each light will only update roughly once every 4 seconds. Increasing the machines/tick value will improve this at the cost of CPU power.
• Change the style of each indicator light.
[img]https://raw.githubusercontent.com/troelsbjerre/Bottleneck/master/screenshots/red.png[/img] [img]https://raw.githubusercontent.com/troelsbjerre/Bottleneck/master/screenshots/green.png[/img] [img]https://raw.githubusercontent.com/troelsbjerre/Bottleneck/master/screenshots/mining.png[/img]

Version history

Version history
v0.10.5 2019.02.26:

• Version bump to 0.18

v0.10.0 2019.02.26:

• Version bump to 0.17 (not using any of the new faster API... sorry)

v0.9.3 2018.10.19:

• Korean localization (thanks to MasterBabol)

v0.9.2 2018.10.17:

• Japanese localization (thanks to shelaf)

v0.9.1 2017.12.22:

• Fixed bug introduced by 0.16 causing fluids not to be checked correctly (thanks to ochristi)
• German localization (thanks to ST-DDT)

v0.9.0 2017.12.15:

• 0.16 compatibility fix (thanks to ochristi)
• Changed logic for state tracking, to avoid light flickering (some machines would show as yellow for a tick per cycle, even when working 100%)

v0.8.5 2017.06.05:

• Fixed lights on uranium miners without mining fluid

v0.8.4 2017.06.01:

• Initialize STYLE from settings

Mon Jun 5
v0.8.3 2017.05.30:

• Fixed hotkey and interface issue

v0.8.2 2017.05.29:

• Quick fix to remove spam messages

v0.8.1 2017.05.29:

• Reintroduced the hotkey: SHIFT+ALT_L

v0.8.0 2017.05.28:

• Fully configurable lights

v0.7.3 2017.05.27:

• Bugfixes

v0.7.2 2017.05.22:

• Bugfixes

v0.7.1 2017.05.10:

• Cached options values (turns out fetching them all the time is quite slow)
• Updated sprite indices for 0.15.10

v0.7.0 2017.05.05:

• Added options menu (Menu->Options->Mods->Map)

v0.6.3 2017.04.28:

• Updated for Factorio 0.15

v0.6.2 2017.01.13:
Bugfix

• Collision mask added, so you can again walk through the indicator lights
• Switching to high contrast mode was broken by 0.6.1, which is now working again

v0.6.1 2017.01.12:
Bugfix

• Using car as base type had unintended consequences, so now using storage-tank instead.

v0.6.0 2017.01.11:
Optimization by Nexela (Nicholas Dunn):

• Indicator lights are now based on rotating an entity instead of destroying and creating.

v0.5.2 2017.01.03:
bugfix:

• Rolled back a rebuild optimization, which used too much ram.

v0.5.1 2017.01.02:
Major cleanup by Nexela (Nicholas Dunn):

• Code Restructure for 0 error/warns in linter.
• Several speedups.
• Ton of bug fixes and robustness improvements (incl. fixing desync issues)
• Add Remote interface.
• Custom events for hotkeys.

v0.5.0 2016.12.17: (ONLY ON GITHUB. STILL BUGGY)
changes:

• Changed data structure from list to table, to allow for the following:
• Removed entities now have their associated lights disappear instantly, instead at next update.
• Mod now scales to larger factories, since removing elements (either from mining or destruction) is now expected constant time instead of linear in the number of lights.

v0.4.5 2016.12.04:
changes:

• Fixed unhelpful options menu text

v0.4.4 2016.12.04:
changes:

• High contrast mode replaces the yellow signal with a blue signal. SHIFT-B to toggle

v0.4.3 2016.10.03:
changes:

• bugfix: 0.4.0 introduced caching of whether a mining drill was depleted, which was mistakenly also set if the drill was out of power.

v0.4.2 2016.10.02:
changes:

• bugfix: re-introduced minor version numbers on global data. The use of function pointers inside global cause the function to be saved as well. This needs to be updated when loading a newer version of the mod, which includes minor versions.

v0.4.1 2016.10.02:
changes:

• optimization: only checking for fluid output as a last resort (speeds update up quite a bit)
• optimization: clean transition from "removing lights a few at a time" to "all lights are off, so no need to check"

v0.4.0 2016.10.01:
changes:

• bugfix: assemblers with fluid output now handled more consistently with the rest
• bugfix: depletion of mines fixed (now explicitly searching for ore patches, since old method sometimes failed)
• change: toggling the indicators now requires admin privileges, and toggling lights will now happen at the same rate as updates, instead of all in one tick

v0.3.3 2016.09.26:
changes:

• bugfix: compatibility issue with unDecorator resolved

v0.3.2 2016.08.30:
changes:

• bugfix: added sanity checks, in case signal entities have been destroyed by other mods

v0.3.1 2016.08.30:
changes:

• bugfix: new fantories would get a red light (but not update) if lights were turned off

v0.3.0 2016.08.29:
changes:

• bugfix: version number was not updated, which caused the position cache to not be filled, causing a crash
• performance: no longer repeatedly checking status when lights are toggled off (thanks factorio user bsdfhsbzxcbz)

v0.2.5 2016.08.28:
changes:

• caching of light position (slightly lower CPU load)
• confirmed working for 0.14, so updated info.json

v0.2.4 2016.08.23:
Bugfixes:

• fixed crash which could occur when removing the last assembler

v0.2.3 2016.08.22:
Bugfixes:

• fixed issue with entity being updated multiple times per tick, incorrectly giving drills the yellow status

v0.2.2 2016.08.22:
Bugfixes and features by factorio user apriori:

• Places the signals at the bottom center of oddly sized entities
• Hotkey 'B' for hiding signals

v0.2.1 2016.08.14:
Bugfixes:

• Correctly handling machines idling while trying to output a bonus item (thanks to randomflyingtaco)

v0.2.0 2016.08.13:
New features:

• Mining drills and pump jacks now also have indicator lights
• Only updates 40 entities per tick, as suggested by github user zamp
• Much more consistent use of red/yellow/green across different entity types

Major refactoring to handle save and load properly
v0.1.0 2016.07.16:
Major refactoring to handle save and load properly

v0.0.3 2016.06.14:
New features:

• Furnaces now also have indicator lights

v0.0.2 2016.06.14:
New features:

• Slightly improved graphics (inspired by sporefreak)
• Red light stays on for 5 seconds, to improve visibility (as suggested by Miravlix)

Bugfixes:

• Machines places by robots now also get an indicator
• Old indicator lights are filtered out at load (this is a hack; the mapping should be stored in global)
• New entities are now only created when state changes.

[/list]

v0.0.1 2016.06.11: Proof of concept.

[sporefreak]

Love the idea but the graphics are kinda scary

[British_Petroleum]

Love the idea but the graphics are kinda scary

You are easily scared this looks great

[sporefreak]

These are not amazing or anything but you are more then welcome to use these, (IF you want that is)
They are all 32X32 but if you want bigger sizes i can make some. (...IF you want that is....)

[Miravlix]

While instant on/off behavior is fine for green and yellow, I find red could benefit from a delay, if the machine is short on resources, it could force the light red for the next five seconds.

Seems like 0.13 creates a lot more situations where you're short of resources for extremely short periods of time pr. item created, but on a 0.5 cycle, a 0.xxx delay can become quite big, so it would be a great help for it to be easier to spot the small errors in designs.

[trold]

While instant on/off behavior is fine for green and yellow, I find red could benefit from a delay, if the machine is short on resources, it could force the light red for the next five seconds.

Seems like 0.13 creates a lot more situations where you're short of resources for extremely short periods of time pr. item created, but on a 0.5 cycle, a 0.xxx delay can become quite big, so it would be a great help for it to be easier to spot the small errors in designs.

Thank you for the suggestion; you are absolutely right. I have added your suggested functionality to v0.0.2.

Ideally, this information should also be made available in a separate list accessible through the GUI, probably summarized by recipe.

[trold]

These are not amazing or anything but you are more then welcome to use these, (IF you want that is)
They are all 32X32 but if you want bigger sizes i can make some. (...IF you want that is....)

I had to redo these, since I want the background to be transparent. I took your suggestion and made the yellow more orange to distinguish it better from the green. Thank you for your input.

[sporefreak]

These are not amazing or anything but you are more then welcome to use these, (IF you want that is)
They are all 32X32 but if you want bigger sizes i can make some. (...IF you want that is....)

I had to redo these, since I want the background to be transparent. I took your suggestion and made the yellow more orange to distinguish it better from the green. Thank you for your input.

They were uploaded to imgur with transparent backgrounds, they should already have transparent backgrounds.

[trold]

They were uploaded to imgur with transparent backgrounds, they should already have transparent backgrounds.

Maybe transparency was lost when uploading to imgur. Here is a comparison:

Image from above:

New Image from mod:

[Liquid5n0w]

Seems to be dropping my UPS on a rather small factory. I like this mod, but it really shouldn't affect UPS should it?

[Oceanel]

Hi. This is another variant of graphics https://www.dropbox.com/s/msy0qnwa26jjj ... s.zip?dl=0

[trold]

I have given into the demands, and the mod no longer kills your CPU. It only does 40 updates per tick, no matter the size of the factory. This will reduce accuracy on bigger factories, instead of slowing down.

[trold]

Seems to be dropping my UPS on a rather small factory. I like this mod, but it really shouldn't affect UPS should it?

This should be fixed in the newest version.

[apriori]

New version in attachments. Changelist:
• Some codelines for correct placement of bottleneck signals for non-vanilla-sized machines, like assembling machine zero or bucket wheel excavator. See image below.
• Added hotkey "B" to toggle bottlenecks visible/hidden (visible by default). See game settings -> controls -> mods to configure. See mod folder -> locale to localize control's description.

Author, contribute it yourself - I'm not github user. License - see my signature below.

[trold]

Thanks to apriori, the signals are now places correctly for big entities. For some reason, it still places signals to the left side on the small 2x2 entities.

[Thomasnotused]

I updated this to 0.14 because I got bored, enjoy!

https://www.dropbox.com/s/ecq98qpmzlnsx ... 1.zip?dl=1

[trold]

I realized that I had completely forgotten to update the download URL at the top of this post ever since v0.2.0, so only people using the mod portal would have gotten the newer versions. Sorry about this. The currently newest version can be found at https://mods.factorio.com/api/downloads ... _0.3.1.zip

[apriori]

russian locale

Code: Select all

[controls]
bottleneck-hotkey = Вкл/выкл индикаторы статуса производства

[Jackalope_Gaming]

I've noticed this mod's graphics are covered up by assembler-type entities that output fluid in the bottom middle. In the base game this is only the oil refinery, but mods and such can add other things with bottom middle fluid output. Changing the picture shift from "shift = {-0.5, -0.3}" to "shift = {0, -0.3}" allows for showing both the middle output and the indicator light fully. It also does not interfere with such entities as chemical plants that have a bottom right fluid output since the indicator light is in between the middle tile and the tile to the right of middle.

[Peter34]

Thanks for making this mod. I've been playing for a little over 2 years now, and I only just very recently realized that it annoys and frustrates me that I can't at-a-glance see whether my machines are working or not, and if not, whether it's because of input or output reason.

Both are reasonbly easy to bypass, by pressing the Alt key or by looking at the Belts to see whether they're full or not full (except when you're using Requester Chests instead, which I maintain is very valid in some cases), but still, this mod speeds up getting answers to that question by at least a factor of 5, and thus it's very, very Factorio.

Thanks!