Emoji Keyboard Export

This mod will export a plugin for the Emoji Keyboard app for the active Factorio game, including mods, using the active locale.

The plugin consists of a JSON file describing all items, fluids, recipes, technologies, and virtual signals that can be typed using Rich Text, categorized and with their tag, and a sprite map.

This mod won't do anything when not run in Instrument Mode.

The code based on FactorioLab Export.

Usage instructions

1. Install this mod alongside any mods that should be included in the data set
2. Set up Steam to run this mod in Instrument Mode

• In the library, right click Factorio and in Launch Options enter: --instrument-mod emoji-keyboard-export
• Alternately, run Factorio from the command line with these options

1. Start Factorio and start a new game, a message will appear indicating the export started (if not, check that this mod and flib mod are enabled, and you used instrument mode)
2. Wait for the export to complete, another message appears in the chat, you can now exit Factorio
3. Copy the contents of %APPDATA%\Factorio\script-output\emoji-keyboard-export into the plugin directory of Emoji Keyboard and restart it.

FAQ

Can the exported files be used for something else?

Yes, of course. Icons can be copyrighted resp. by Wube or mod authors.

What is the size of the tiles of the sprite map?

Tiles are 72×72 px (64 + 2×4 padding).

What is the format of the JSON file?

A PluginData object as defined in board.ts, simplified below:

type PluginData = {
	name: string;
	symbol: SpriteRef;
	boards: [MainBoard];
	spriteMaps: Record<string, SpriteMap>;
}

type SpriteMap = {
	path: string,
	width: number,
	height: number,
	padding?: number;
	cols: number;
	rows: number;
	index: Record<string, { row: number, col: number }>
}

type SpriteRef = {
	spriteMap: string;
	sprite: string;
}

type MainBoard = {
	name: string;
	symbol: SpriteRef;
	byRow: (Keyboard[] | Record<string, never>)[]
}

type Keyboard = {
	name: string;
	symbol: SpriteRef;
	content: Cluster[];
}

type Cluster = {
	cluster: string;
	name: string;
	symbol: KeyCap;
}