Official Factorio Wiki - User contributions [en]

Rich text

2020-11-30T13:28:36Z

Ixu: Option to use a sprite path directly

{{Languages}}
Rich text formatting in allows the use of tags within most of the game's textboxes to change the visual formatting of text or to embed interactable images/entities. Predefined text tags are employed for this purpose.

== Tags ==

Tags are useful for sharing blueprints, marking map locations in chat or adding icons to map markers and train stations.
Ctrl+alt clicking the map or ground will automatically insert a gps tag and post it into [[console|chat]].

Shift clicking most things with the console open will insert a tag for that thing into chat. The chat and many other textboxes in the game have a button on the right edge that opens an icon selector. This can be used to easily insert rich text tags of recipes, items, fluids, virtual signals and entities into the textbox.

When used in chat, the tag image will be followed by a text description, except for the img tag.
Used elsewhere only the image is shown.

{| class="wikitable"
|-
! style="width:20%"| Syntax
! style="width:15%"| Example Input
! style="width:15%"| Example Result
! style="width:50%"| Description

|-
| [img=sprite-prototype-name]
[img=class/name]
[img=class.name]
| [img=item/iron-plate]
| [[File:Iron_plate.png|28px]]
| Embeds only a small inline game graphic. The period format must be used in game save names. This tag uses [https://lua-api.factorio.com/latest/Concepts.html#SpritePath sprite paths]:
class is any of: item, entity, technology, recipe, item-group, fluid, tile, virtual-signal, achievement, equipment or utility.

name: see below

|-
| [item=name]
| [item=iron-plate]
| [[File:Iron_plate.png|28px]] [Item: Iron plate]
| name is the internal-name of the item

|-
| [entity=name]
| [entity=small-biter]
| [[File:Small_biter.png|28px]] [Entity: Small biter]
| name is the internal-name of the entity

|-
| [technology=name]
| [technology=logistics]
| [[File:Logistics_(research).png|28px]] [Technology: Logistics]
| name is the internal-name of the technology

|-
| [recipe=name]
| [recipe=basic-oil-processing]
| [[File:Basic_oil_processing.png|28px]] [Recipe: Basic oil processing]
| name is the internal-name of the recipe, usually the entity name

|-
| [item-group=name]
| [item-group=combat]
| [[File:Item-group_military.png|28px]] [Item Group: Combat]
| name is any of: logistics, production, intermediate-products, combat, fluids or signals

|-
| [fluid=name]
| [fluid=water]
| [[File:Water.png|28px]] [Fluid: Water]
| name is the internal name of the fluid

|-
| [tile=name]
| [tile=grass-3]
| [[File:Grass_3.png|28px]] [Tile: Grass 3]
| name is the internal name of the tile, usually the lowercase name with hyphens replacing spaces as written from the map editor

|-
| [virtual-signal=name]
| [virtual-signal=signal-A]
| [[File:Signal-A.png|28px]] [Virtual Signal: Signal A]
| name is the word signal followed by either an uppercase letter, number, color, each, everything or anything

|-
| [achievement=name]
| [achievement=minions]
| [[File:Minions-achievement.png|28px]] [Achievement: Minions]
| name is the internal-name of the achievement, usually the lowercase name with hyphens replacing spaces

|-
| [gps=x,y]
[gps=x,y,surface]
| [gps=0,0]
| [[File:Map.png|28px]] [Location: 0,0]
| Embeds a map location and marks the location on the map of other players.
x is the x point coordinate 
y is the y point coordinate 
surface is the current surface. Is only added if the player Ctrl+alt clicks on a surface that is not the default surface. When the player is on another surface than surface, clicking the tag does nothing. Mods must handle this case with [https://lua-api.factorio.com/latest/events.html#on_player_clicked_gps_tag on_player_clicked_gps_tag]
|-
| [special-item=blueprint_string]
|
| [[File:Blueprint.png|28px]] [Blueprint]
| Embeds a blueprint. Players can get a blueprint item by clicking the icon.
blueprint_string is the blueprint string of a blueprint, deconstruction planner or upgrade planners

|-
| [armor=player]
| [armor=Player]
| [[File:Power_armor_MK2.png|28px]] [Armor: Player]
| Embeds the armor of a player. Allows other players to see the equipment installed.
player is the name of the player

|-
| [train=number]
| [train=93]
| [[File:Locomotive.png|28px]] [Train: 2]
| Embeds a reference to a train. Clicking the icon will open the train GUI for that train.
number is the internal unit number of the train

|-
| [train-stop=number]
| [train-stop=100]
| [[File:Train_stop.png|28px]] [Train Stop: Trangar]
| Embeds a reference to a train stop. Clicking the icon will open the GUI for that train stop.
number is the internal unit number of the train stop

|-
| [tooltip=text,tooltip locale key]
| [tooltip=Hover to see "Iron plate",item-name.iron-plate]
| [[File:Custom-tag-icon.png|28px]] Hover to see "Iron plate"
| Shows the given text with a tooltip that is specified with a [[Tutorial:Localisation#Localising_simple_strings|locale key]].

|}

== Text modifiers ==
[[File:Fonts.png|right|thumbnail|100px|Different fonts displayed in-game. (Click to enlarge.)]]

The color and font of text can be changed

{| class="wikitable"
|-
! style="width:20%"| Syntax
! style="width:15%"| Example Input
! style="width:15%"| Example Result
! style="width:50%"| Description
|-
| [color=rgb]...[/color]
[color=#rrggbb]...[/color]
[color=#aarrggbb]...[/color]
[color=rgb]...[.color]
[color=#rrggbb]...[.color]
[color=#aarrggbb]...[.color]
| [color=red]Red[/color] text
[color=1,0,0]Red[/color] text
[color=255,0,0]Red[/color] text
[color=#ff0000]Red[/color] text
| Red text
| rgb is a comma separated RGB color ranging from 0 to 1 or 0 to 255, or a color name
Available colors: default, red, green, blue, orange, yellow, pink, purple, white, black, gray, brown, cyan, acid.
|-
| [font=font-name]...[/font]
[font=font-name]...[.font]
| [font=default-bold]Bold text[/font]
| Bold text
| font-name is the name of the [[Data.raw#font|Factorio font]] to render
|}

== See also ==
* [[Console]]
* [[Data.raw]] for the list of internal names of recipes, technologies, fluids, etc.

Tutorial:Mod structure

2020-05-30T11:00:53Z

Ixu: According to Rseding91 post in https://forums.factorio.com/viewtopic.php?f=25&t=85380

Mods are expected to have a certain structure in order to be loaded by the game. This page aims to explain that file structure and what each file is used for.

== Mod folder and file structure ==

The mod must either be in a folder, or in a folder inside a zip file. The mod folder/zip must be named in the pattern of <code>{mod-name}_{version-number}</code>, for example <code>test-mod-thing_0.0.1</code>. When using a zip file for the mod, the folder inside the zip file does not have any naming restrictions; only the zip file itself must be named with the <code>{mod-name}_{version-number}</code> pattern. The mod name and its version number are defined in the [[#info.json|info.json]] file.

=== Files ===
Inside the mod folder, the game automatically reads the following files during load:
* info.json — The only mandatory file. The [[#info.json|info.json]] identifies the mod, defines its version and other general properties.
* changelog.txt — Version history of the mod, to be shown in the mod browser. The changelog file must follow the strict [[Tutorial:Mod changelog format|formatting requirements]].
* thumbnail.png — Thumbnail to be shown on the mod portal and in the mod browser in-game. Ideally a 144x144px image file.
* settings.lua — This and the next two files are used to set up mod [[Tutorial:Mod settings|configuration options]].
* settings-updates.lua
* settings-final-fixes.lua
* data.lua — This and the next two files are used to define [[Prototype definitions|prototypes]].
* data-updates.lua — The load order of the three data*.lua files is explained on [https://lua-api.factorio.com/latest/Data-Lifecycle.html Data-Lifecycle].
* data-final-fixes.lua
* control.lua — This file is used for runtime scripting. Runtime scripting is documented on [https://lua-api.factorio.com/latest/index.html lua-api.factorio.com].

=== Subfolders ===
Furthermore, the following folders inside the mod folder are recognized by the game:
* locale — Can contain up to one subfolder per language, identified with the language code, for example <code>en</code> for English. The subfolder then has to contain at least one *.cfg file which defines the [[Tutorial:Localisation|translations]] for that language.
* scenarios — Custom [[scenario system|scenarios]] can be placed in subfolders of this folder.
* campaigns — Custom campaigns can be placed in subfolders of this folder.
* tutorials — Custom [[Prototype/Tutorial|tutorials]] can be placed in subfolders of this folder.
* migrations — [https://lua-api.factorio.com/latest/Migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.

=== Example ===
Here is an example directory structure for a mod titled <code>my-armor-mod</code> with a version number of <code>0.3.6</code>:

<pre>
my-armor-mod_0.3.6.zip
|- aFolderName/
|- control.lua
|- data.lua
|- info.json
|- thumbnail.png
</pre>

== info.json ==

The info.json file identifies the mod and defines its version. If the game encounters a problem when parsing the file, the error message can be found in the [[log file]]. A minimal info.json file can look like this:
{
"name": "test-mod-thing",
"version": "0.0.1",
"title": "My best test mod",
"author": "A very great tester",
"factorio_version": "0.18"
"dependencies": ["? optional-mod"]
}

The info.json file supports the following fields:

=== name ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The internal name of mod. The game accepts anything as a mod name, however the mod portal restricts mod names to only consist of alphanumeric characters, dashes and underscores. Note that the mod folder or mod zip file name has to contain the mod name, where the restrictions of the file system apply.

=== version ===
: '''Type''': [[Types/string|string]]

: Mandatory field. Defines the version of the mod in the format <code>"number.number.number"</code> for <code>"main.major.minor"</code>, for example <code>"0.6.4"</code>. Each number can range from 0 to 65535.

=== title ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The display name of the mod, so it is not recommended to use someUgly_pRoGrAmMeR-name here. Can be overwritten with a locale entry in the <code>mod-name</code> category, using the internal mod name as the key.

=== author ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The author of the mod. This field does not have restrictions, it can also be a list of authors etc. The mod portal ignores this field, it will simply display the uploader's name as the author.

=== contact ===
: '''Type''': [[Types/string|string]]

: Optional field. How the mod author can be contacted, for example an email address.

=== homepage ===
: '''Type''': [[Types/string|string]]

: Optional field. Where the mod can be found on the internet. Note that the in-game mod browser shows the mod portal link additionally to this field. Please don't put "None" here, it makes the field on the mod portal website look ugly. Just leave the field empty if the mod doesn't have a website/forum thread/discord.

=== description ===
: '''Type''': [[Types/string|string]]

: Optional field. A short description of what your mod does. This is all that people get to see in-game. Can be overwritten with a locale entry in the <code>mod-description</code> category, using the internal mod name as the key.

=== factorio_version ===
: '''Type''': [[Types/string|string]]

: '''Default''': "0.12"

: Optional field. The major Factorio version that this mod supports. No you can't have more than one version here. Yes, the field is optional, but we have 0.18, not the default 0.12, so you'll have to add the field anyway. Adding a minor version, e.g. "0.18.'''17'''" will make the mod portal reject the mod and the game act weirdly. That means you shouldn't do that; use only main and major version <code>"main.major"</code>, for example <code>"0.18"</code>.

=== dependencies ===
: '''Type''': array of [[#Dependency]]

: '''Default''': ["base"]

: Optional field. Mods that this mod depends on or is incompatible with. If this mod depends on another, the other mod will load first, see [https://lua-api.factorio.com/latest/Data-Lifecycle.html Data-Lifecycle]. An empty array allows get around the default and have no dependencies at all.

: Example:
: <pre>"dependencies": ["mod-a", "? mod-c", "! mod-g > 0.4.3"]</pre>

:: <h4>Dependency</h4>
:: Each dependency is a string that consists of up to three parts: <code>"<prefix> internal-mod-name <equality-operator version>"</code>, for example <code>"? some-mod-everyone-loves >= 6.6.6"</code>. The possible prefixes are: <code>!</code> for incompatibility, <code>?</code> for an optional dependency, <code>(?)</code> for a hidden optional dependency or no prefix for a hard requirement for the other mod. The equality operator (<code><, <=, =, >= or ></code>) combined with the version allows to define dependencies that require certain mod versions, but it is not required. Incompatibility does not support versions. If you use incompatible you are incompatible with the entire mod.