Factorio 2.1.24 compatibility fork of deadlock-beltboxes-loaders by Deadlock989, Shane Madden, MasterBuilder. Fork source on GitHub. Original gameplay settings and prototype identities are retained. Replace the original mod with this fork; they cannot be enabled together.
Retains the optional high-tier loader and beltbox registrations. Native checks covered nine tiers, belt snapping, robot construction, quality handling and item flow. The original integration API documentation follows.
Deadlock’s Stacking Beltboxes & Compact Loaders
==========================
DSB is a Factorio mod which adds small 1x1 loaders and beltboxes. These can be used to stack items from a belt, in-line,
greatly increasing belt throughput.
If you are a Factorio modder, you can get DSB to automatically
generate stacked versions of items from your own mods. A description of the DSB API is below.
Step 1
Add “?deadlock-beltboxes-loaders-factorio21” as an optional dependency in your mod’s info.json.
For example:
{
"name": "DeadlockTweaks",
"version": "0.1.0",
"title": "Deadlock's Tweaks",
"author": "Deadlock989",
"contact": "",
"homepage": "",
"dependencies": ["base \>= 0.17.0", "?deadlock-beltboxes-loaders-factorio21],
"description": "Some small quality of life adjustments.",
"factorio_version": "0.17"
}
Step 2
DSB exposes a set of functions which handle stack creation (and optionally
beltbox and loader tier creation) for you. You should call these functions from your mod’s
data-final-fixes.lua. Check that deadlock exists before you try
and call any of the functions, so that your mod will still run without errors if
DSB isn’t installed. For example:
-- [data-final-fixes.lua]
-- this mod makes diamonds. don’t dig straight down
-- we already created our items earlier on
-- get DSB to stack my itamz
if deadlock then
-- repeat this for every item you want crated
deadlock.add_stack("deadlock-uber-diamond", "__DeadlockTweaks__/graphics/icons/stacked-diamond.png", "deadlock-stacking-1", 64)
end
Alternatively, if you have a long list of items which you want to insert into
different technologies, you could put them into some kind of array or table and
then loop through them.
This is the simplest use case. Several more functions are provided: these are
described on the following pages.
deadlock.add_stack()
This is the function used to crate things that DSB doesn’t handle by default. It
can take up to six parameters. A full call looks like this:
deadlock.add_stack(item_name, graphic_path, target_tech, icon_size, item_type, mipmap_levels)
| Parameter | Optional / Mandatory? | Explanation |
|------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| item_name | Mandatory | String. The name of the item you want crated, e.g. “iron-plate”. |
| graphic_path | Optional | String. The path to an icon for your stacked item. Can be omitted, but this is bad for performance (see "More Details" below). |
| target_tech | Optional | String. The technology name (e.g. “deadlock-stacking-1”) that the crating recipe unlocks will be inserted into. If specified, the technology must already exist as a prototype in data.raw. If omitted or nil, the mod won’t update any technologies, and you’ll have to handle gaining access to the recipes yourself. |
| icon_size | Optional | Integer. The size of your custom icon in pixels. Defaults to 64. Not used if no icon is supplied. |
| item_type | Optional | String. The type of item, e.g. "item", "ammo", "repair-tool" etc. Defaults to "item". |
| mipmap_levels| Optional | Integer. The mipmap levels of your custom icon. Defaults to nil. Not used if no icon is supplied. |
You can omit an optional parameter or specify nil to use the defaults.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
