Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
api
command
Command api is the M7 end-to-end guest: a Go program that calls the Factorio API through the generated bindings.
|
Command api is the M7 end-to-end guest: a Go program that calls the Factorio API through the generated bindings. |
|
array
command
Command array exercises the variable-length marshalling: arrays over every element shape, dictionaries, and tier-2 dynamic values, in both directions.
|
Command array exercises the variable-length marshalling: arrays over every element shape, dictionaries, and tier-2 dynamic values, in both directions. |
|
callback
command
Command callback exercises the callback seam in both directions: a console command and a remote interface this guest declares, and a remote.call it makes into somebody else's.
|
Command callback exercises the callback seam in both directions: a console command and a remote interface this guest declares, and a remote.call it makes into somebody else's. |
|
callcost
command
Command callcost is the fixture for profiling what a host call costs through a REAL compiled guest, rather than through the Lua ABI on its own.
|
Command callcost is the fixture for profiling what a host call costs through a REAL compiled guest, rather than through the Lua ABI on its own. |
|
churn
command
Command churn is the allocation-churn guest: what an ORDINARY allocating Go event handler costs a guest that cannot collect.
|
Command churn is the allocation-churn guest: what an ORDINARY allocating Go event handler costs a guest that cannot collect. |
|
confchanged
command
Command confchanged is the in-game fixture for the CONFIGURATION-CHANGED PAYLOAD: what script.on_configuration_changed hands its handler, which the FkLua hook discarded for two milestones.
|
Command confchanged is the in-game fixture for the CONFIGURATION-CHANGED PAYLOAD: what script.on_configuration_changed hands its handler, which the FkLua hook discarded for two milestones. |
|
custominput
command
Command custominput is the in-game fixture for a NAME-ADDRESSED subscription, which is how Factorio delivers a keybind.
|
Command custominput is the in-game fixture for a NAME-ADDRESSED subscription, which is how Factorio delivers a keybind. |
|
custominputdata
command
Command custominputdata is the DATA-STAGE half of the custom-input fixture: it defines the two custom-input prototypes ./examples/custominput subscribes to by name.
|
Command custominputdata is the DATA-STAGE half of the custom-input fixture: it defines the two custom-input prototypes ./examples/custominput subscribes to by name. |
|
datastage
command
Command datastage is the data-stage end-to-end guest: a Go program that becomes a Factorio mod's settings.lua, data.lua and data-final-fixes.lua.
|
Command datastage is the data-stage end-to-end guest: a Go program that becomes a Factorio mod's settings.lua, data.lua and data-final-fixes.lua. |
|
demo-daylight
command
Command demo-daylight is half of the two-mod fkipc demo: a slider in a web page drags the sun across a running Factorio.
|
Command demo-daylight is half of the two-mod fkipc demo: a slider in a web page drags the sun across a running Factorio. |
|
dict
command
Command dict is the end-to-end fixture for a DICTIONARY FIELD INSIDE A STRUCT, which is the shape five event payloads carry and the Go generator refused until 2026-08-02 -- and, since 2026-08-06, for A BINARY STRING through a generated reader.
|
Command dict is the end-to-end fixture for a DICTIONARY FIELD INSIDE A STRUCT, which is the shape five event payloads carry and the Go generator refused until 2026-08-02 -- and, since 2026-08-06, for A BINARY STRING through a generated reader. |
|
dynread
command
Command dynread is the end-to-end fixture for READING a tier-2 value.
|
Command dynread is the end-to-end fixture for READING a tier-2 value. |
|
eventheap
command
Command eventheap measures how much guest heap a HOST-INITIATED dispatch keeps forever.
|
Command eventheap measures how much guest heap a HOST-INITIATED dispatch keeps forever. |
|
gcbench
command
Command gcbench is the acceptance vehicle for what a collection costs the WORST TICK, in a real Factorio, measured by Factorio.
|
Command gcbench is the acceptance vehicle for what a collection costs the WORST TICK, in a real Factorio, measured by Factorio. |
|
gcconfig
command
Command gcconfig asks one question of the collector: does the configuration a guest installs BEFORE THE COLLECTOR COMES UP survive?
|
Command gcconfig asks one question of the collector: does the configuration a guest installs BEFORE THE COLLECTOR COMES UP survive? |
|
gcsave
command
Command gcsave is the collector's save/load guest: does a heap that is being COLLECTED survive a real Factorio save and reload?
|
Command gcsave is the collector's save/load guest: does a heap that is being COLLECTED survive a real Factorio save and reload? |
|
gctorture
command
Command gctorture is the collector's retention gate: build a structure, drop a KNOWN half of it, collect, and check that what should have survived did and what should not have did not.
|
Command gctorture is the collector's retention gate: build a structure, drop a KNOWN half of it, collect, and check that what should have survived did and what should not have did not. |
|
goroutine
command
Command goroutine is the M10 guest: a Go program using goroutines and channels, compiled to Lua and run inside Factorio's sandbox.
|
Command goroutine is the M10 guest: a Go program using goroutines and channels, compiled to Lua and run inside Factorio's sandbox. |
|
grow
command
Command grow is the round-trip's growing guest.
|
Command grow is the round-trip's growing guest. |
|
growbench
command
Command growbench is the acceptance vehicle for what a `memory.grow` costs the WORST TICK, in a real Factorio, measured by Factorio.
|
Command growbench is the acceptance vehicle for what a `memory.grow` costs the WORST TICK, in a real Factorio, measured by Factorio. |
|
heap
command
Command heap measures how much guest heap a host call keeps forever.
|
Command heap measures how much guest heap a host call keeps forever. |
|
hello
command
Command hello is the M4 end-to-end guest: a Go program that becomes a Factorio mod.
|
Command hello is the M4 end-to-end guest: a Go program that becomes a Factorio mod. |
|
ipc
command
Command ipc is the fkipc wiring fixture: the four lines a guest author writes to get an IPC link, and nothing else.
|
Command ipc is the fkipc wiring fixture: the four lines a guest author writes to get an IPC link, and nothing else. |
|
lasterror
command
Command lasterror is the fixture for fk.LastError, the import that carries WHAT THE ENGINE SAID across the boundary beside a status.
|
Command lasterror is the fixture for fk.LastError, the import that carries WHAT THE ENGINE SAID across the boundary beside a status. |
|
logdump
command
Command logdump is the end-to-end fixture for the LINE BUILDER and the VALUE DUMPER, which are the two halves of one story: a guest that wants to say what it is doing without paying for it forever.
|
Command logdump is the end-to-end fixture for the LINE BUILDER and the VALUE DUMPER, which are the two halves of one story: a guest that wants to say what it is doing without paying for it forever. |
|
migrate
command
Command migrate is the round-trip's REBUILD guest: the only one here that exports fk_migrate, and the reason it exists is that nothing ever had.
|
Command migrate is the round-trip's REBUILD guest: the only one here that exports fk_migrate, and the reason it exists is that nothing ever had. |
|
retain
command
Command retain is the round-trip's PERSISTENT HANDLE guest.
|
Command retain is the round-trip's PERSISTENT HANDLE guest. |
|
typedargs
command
Command typedargs is the end-to-end fixture for the TYPED ARGUMENT form of a method whose parameter table is a discriminated union.
|
Command typedargs is the end-to-end fixture for the TYPED ARGUMENT form of a method whose parameter table is a discriminated union. |
|
Package fk is the guest-side half of the FkLua host boundary.
|
Package fk is the guest-side half of the FkLua host boundary. |
|
Code generated by fklua from runtime-api.json.
|
Code generated by fklua from runtime-api.json. |
|
Package fkdata is the guest-side half of Factorio's SETTINGS and DATA stages.
|
Package fkdata is the guest-side half of Factorio's SETTINGS and DATA stages. |
|
Package fkgc is the guest-side garbage collector for a FkLua guest built with TinyGo's `-gc=custom`.
|
Package fkgc is the guest-side garbage collector for a FkLua guest built with TinyGo's `-gc=custom`. |
|
Package fkipc is a message-oriented IPC link between a FkLua guest and a companion process on the same machine, over Factorio's UDP surface.
|
Package fkipc is a message-oriented IPC link between a FkLua guest and a companion process on the same machine, over Factorio's UDP surface. |
|
wire
Package wire is the fkipc frame codec: the 24-byte header, the nine frame types, and the four control payloads both ends must agree on byte for byte.
|
Package wire is the fkipc frame codec: the 24-byte header, the nine frame types, and the four control payloads both ends must agree on byte for byte. |
|
Package fklog builds a log line in one fixed buffer and hands it to the host without allocating.
|
Package fklog builds a log line in one fixed buffer and hands it to the host without allocating. |
Click to show internal directories.
Click to hide internal directories.