Deepspace 9

A factorio mod: transfer items, technologies, and signals between servers via rockets.

Introduction

Launch rockets to send items to DS 9 or receive items from DS 9 ! This mod allows you to share items, electricity, researches, and signals between several servers.

A item transfer works as shown below:

Sending items:

note left of Game server (headless): Launch a tx rocket with items
Game server (headless)->DS9 local estate: Item TX req
DS9 local estate->DS9 remote cloud: Add items to the cloud
DS9 remote cloud-->DS9 local estate: 200 OK

Receiving items:

note left of Another game server: Launch a rx rocket with item req
Another game server->DS9 local estate: Item RX req
DS9 local estate->DS9 remote cloud: Request items from the cloud
DS9 remote cloud-->DS9 local estate: 200 OK
DS9 local estate->Another game server: Add items to the rocket result inventory

LINK TO THE DS9 local estate repo: https://github.com/MasterBabol/ds9-local-estate

LINK TO THE DS9 remote cloud repo: https://github.com/MasterBabol/ds9-remote-cloud

TODO: add more details

Building & Installation

pacman -S lua
make clean && make

This will create a zip file. Copy the zip file to the mod directory in the read-directory of a factorio game instance.

RECOMMENDED TO MOST USERS: Just get a mod file from the mod forum or in-game mod manager

Support

https://discord.gg/nSGmtBV

API

File (unix FIFO) Interface

File (unix FIFO) Name	Direction	Description
rx-queue.fifo	MOD to LE	Request a rx reservation, series of {request-json}
tx-queue.fifo	MOD to LE	Send a tx request, series of {request-json}
tx-sigqueue.fifo	MOD to LE	Send signals, series of {signal-json}
techsync.fifo	MOD to LE	Send research states of technologies, series of {techsync-json}

DS9 mod will create each file as soon as it needs to send or announce a rx/tx request or states of signals and technologies. These files are located in a directory named "script-output" in the read-directory of factorio game instance.

File interfaces are deprecated and not used. All MOD to LA pipe functions are moved to Rcon interface.

Rcon Interface

Rcon Command	Direction	Description
/dequeue_rx_queue	MOD to LE	Dequeue rx reservation requests, (array of){request-json}
/dequeue_tx_queue	MOD to LE	Dequeue tx requests, (array of){request-json}
/collect_rx_signal_reqs	MOD to LE	Collect rx signal requests, (array of){signal-json}
/collect_tx_signals	MOD to LE	Collect tx signal requests, (array of){signal-json}
/collect_rx_elec_reqs	MOD to LE	Collect rx power requests, (array of){elec-json}
/collect_tx_elecs	MOD to LE	Collect tx power requests, (array of){elec-json}
/collect_technology_researches	MOD to LE	Collect research states and levels, (array of){techsync-json}
/confirm_rx_reservation (array of){request-json}	LE to MOD	Confirm a rx reservation request
/set_rx_signals (array of){signal-json}	LE to MOD	Set signals on signal receivers
/set_rx_elecs (array of){elec-json}	LE to MOD	Set energies on power receivers
/set_technologies (array of){techsync-json}	LE to MOD	Apply higher-level technologies to local game
/add_technologies (array of){techsync-json}	LE to MOD	Merge external technologies deprecated

These commands are always valid and active and can be issued by any user via a Rcon interface Factorio provides. A user can expose a Rcon interface by running a headless factorio server with arguments: --rcon-password 'password' --rcon-port 'port'.

JSON Structure

request-json

Child Name	Description
id	Unique id (factorio LuaEntity; entity.unit_number) for this request
type	Request type 1: reservation: reservation of a rx request 2: revokation: revokation of a rx reservation 3: return: return remained items of a rx reservation
items	Dictionary string (item name) -> uint (item count)
ttl	Time to live (only valid in case of reservation)

signal-json

Child Name	Description
id	ID of the entity
name	Name of the signal
type	Type of the signal
count	Count of the signal (used in tx requests)

elec-json

Child Name	Description
id	ID of the entity
amount	Amount of electricity energy

techsync-json

Child Name	Description
name	Technology name
researched	Has this technology been researched
progress	Progress of the technology, as a number in range [0, 1] currently not used
level	Level of the technology