Rich text

2024-10-31T14:41:50Z

Factorio Blueprints: Added planets to rich text

{{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=class/name] 
[img=class.name] 
[img=sprite-prototype-name]
| [img=item.iron-plate] 
[img=quantity-time] 
[img=utility/played_green]
| [[File:Iron_plate.png|28px]] 
[[File:Time_icon.png|28px]] 
[[File:Played green.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

sprite-prototype-name is the [[Data.raw#sprite|internal-name]] of a [[Prototype/Sprite|sprite prototype]].

|-
| [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 item 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]].

|-
| [quality=tier] 
[item=name,quality=tier] 
[entity=name,quality=tier] 

|[quality=normal] 
[item=iron-plate,quality=normal] 
[entity=small-biter,quality=uncommon] 

| [[File:Quality normal.png|28px]] [Quality: Normal] 
[[File:Iron_plate.png|28px]] [Item: Iron plate] 
[[File:Uncommon small biter.png|28px]] [Entity: Uncommon Small biter] 
|
[[Quality]] can also be optionally specified on the following tags: item, entity, recipe, fluid, and virtual-signal 
It can also be added to the other tags that use name, but they ignore it.

The normal quality is the default quality and won't modify tags. Any other quality won't exist without [[Space Age]] and Quality

tier is the internal-name of the quality

|-
| [planet=name]
| [planet=gleba]
| [[File:Gleba.png|28px]] [Planet: Gleba]
| name is the internal name of a planet in Space Age. Available planets are: gleba, fulgora, vulcanus, and aquilo.
|}

== 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.

{{C|GUI}}

Official Factorio Wiki - User contributions [en]

Rich text