Integration Helper [ALPHA]

A mod for people streaming the game, that are looking to spice up their game by letting viewers trigger actions in the game.

The mod does not do anything on its own, without something triggering actions. To this end the remote interface silentstorm-integration-helper is provided by the mod.

You will need to provide your own means of communicating between your streaming platform of choice and the game. Factorio does provide RCON to interface with the game.

Available Functions

For parameters and their descriptions as well as examples, please see the README.md

build_ghosts

Builds ghosted entities around a location on the map. You can optionally have it attempt to build destroyed entities (which have not left a ghost) as well. However that will not work for all types of buildings due to game limitations and it may not create anything, or in some cases even create the wrong building.

repair_base

The repair_base function repairs entities around a location on the map. Minimum and maximum health points restored are configurable.

build_bp

Allows to build arbitrary constructions. Simply create a blueprint of whatever it is you want to have build, use the share / export feature of the blueprint and copy the string and specify that as the blueprint_string parameter.

By default it will not build a blue belt for example if the force selected didn't yet research them, but that can be overridden.

deconstruct

Marks random buildings of the specified force for deconstruction by construction robots, effectively stopping the building.

gain_research

Advance the currently active research by an amount

cancel_research

Cancels the current active research

disable_research

Cancels all the active research for a force, disables all Labs and prevents accessing the Tech Tree for a specified amount of time.

random_research

Start a random research that is available to be researched and put it to the top of the research queue. If the research queue is full, the last item of the research queue is dropped.

forget_research

Removes a random technology that has already been researched. All machines using the technology lose their recipe. Does not disable dependent technologies. So if you lose Optics for example, you will still be able to use Laser Turrets, despite it being behind Optics.

set_arti_speed

Increases the artillery shooting speed of a team for a specified number of seconds.

set_arti_range

Increase the artillery range of a team for a specified number of seconds.

set_lab_speed

Increases the speed that research labs work at. This will make research progress faster, however it will also make them consume science packs faster. Can be considered the less cheaty version of gain_research.

teleport

Teleports a player to the given location on a given surface after a given delay. If the player is inside a vehicle it will be teleported alongside the player if possible, otherwise the player is evicted from the vehicle before teleport.

Will not teleport player into places they cannot get out of. Will not teleport player onto water if they cannot swim.

teleport_distance

Teleports a player the given number of tiles from their current location. If the player is inside a vehicle it will be teleported alongside the player if possible, otherwise the player is evicted from the vehicle before teleport.

Will not teleport player into places they cannot get out of. Will not teleport player onto water if they cannot swim.

If a surface is specified, please note that the player coordinates on their current surface will be used as _origin_ coordinates. If the specified surface does not contain these coordinates the teleport will fail.

enemy_arty

Finds artillery turrets of the provided force and converts them to an enemy artillery turret.

remove_entity

Outright erases buildings from the map. Can either erase random or specific entities. When removing random entities it will pick a random building to remove and remove up to the specified number of this entity. It will NOT remove multiple different entities.

reset_recipe

Removes the currently active recipe from any machine that has a recipe set. Note: Due to the fact that furnaces (at least vanilla ones) do not actually have a set recipe, but instead select it automatically based on the input material, they are not affected by this function.

biter_revive

For a limited time biters have a chance to respawn when being killed. Can be limited to biters dying in a specific area. If a delay is specified, players within the area where biters will be revived will see a warning message.

snap_wires

Cuts circuit wires and / or power cables between entities.

load_turrets

Loads turrets around a location with particular ammunition.

advance_rocket

Add rocket parts to rocket silos, advancing (or reverting) their launch progress.

rain_item

Spawns a specified amount of an item onto the ground at a specific location, or at the location of a specified entity (either biters or players).

If entity is provided then surface and position are ignored

modify_walk_speed

Increases or decreases the walking speed of a player.

modify_craft_speed

Increases or decreases the hand crafting speed of a player.

modify_reach_distance

Increase the distance the character can interact with entities.

modify_build_distance

Increase the distance the character can build new entities in.

modify_mining_speed

Increase the speed the character can mine entities at.

on_fire

Creates fire centered around a player.

barrage

Launches a configured number of projectiles at a player with configurable delays.