VTML: Difference between revisions

Latest revision as of 14:16, 27 March 2024

Other languages:

This page was last verified for Vintage Story version 1.19.

Vintagetext Markup Language (VTML), is a (obviously) completely novel and highly advanced markup language designed to display richly formatted text inside Vintage Story. These are often used to create more versatile handbook pages.

Tags

 
Causes a line break
text
Causes the text to be in italic font
text
Causes the text to be in bold font
<a href="url">text</a>
Turns text into a clickable link. You can link to websites (http://), handbook pages (handbook://pagecode), search results in the handbook (handbooksearch://text_in_your_language), a link that types in the chatbox ("chattype:///giveblock clutter{type: \"barrel-metal1\"}"), trigger hotkeys (hotkey://code) or commands (command:///time set day). Custom links can be added by mods as well using ICoreAPI.RegisterLinkProtocol
text
Formats the text by given properties, all properties are optional
<hk>command</hk> or <hotkey>command</hotkey>
Display the actual current mapping of the "command" key, e.g <hk>sprint</hk> displays the current key used to activate the sprint in your game.

Icons

<icon name="[icon name]"></icon>
Draws an internal icon. See the list below. Note that the waypoint svg icon files are also registered as internal icons.

<icon path="[icon svg path]"></icon>
Draws an icon from an svg file. The path is relative to the texture folder, and should include the svg extension. By default the icons are loaded from the base game, but icons can be loaded from mods by prefixing the path with the mod domain (followed by a colon).

Both kinds of mods can be scaled and colored by the font tag. This is almost necessary for the svg icons, as they are otherwise rendered very small. For example, <icon path="icons/checkmark.svg"></icon>

Internal Icons

These icons are used in World Edit, for the equipment slots and for the tutorial.

<icon name=none></icon>
Crossed out circle
<icon name=dice></icon>
Adds a dice icon
<icon name=paintbrush></icon>
Adds a paintbrush icon
<icon name=raiselower></icon>
Adds a terraforming icon
<icon name=airbrush></icon>
Adds an airbrush icon
<icon name=erode></icon>
Adds an erosion icon
<icon name=move></icon>
Adds an arrow icon
<icon name=import></icon>
Adds an import icon
<icon name=eraser></icon>
Adds an eraser icon
<icon name=growshrink></icon>
Adds a size changing icon
<icon name=line></icon>
Adds a line icon
<icon name=lake></icon>
Adds a water icon
<icon name=floodfill></icon>
Adds an overflowing bucket icon
<icon name=tree></icon>
Adds a tree icon
<icon name=undo></icon>
Adds an undo icon
<icon name=redo></icon>
Adds a redo icon
<icon name=copy></icon>
Adds a copy icon
<icon name=select></icon>
Adds a select icon
<icon name=repeat></icon>
Adds a repeat icon
<icon name=trousers></icon>
Adds a trouser icon
<icon name=gloves></icon>
Adds a glove icon
<icon name=hat></icon>
Adds a hat icon
<icon name=shirt></icon>
Adds a shirt icon
<icon name=boots></icon>
Adds a boot icon
<icon name=basket></icon>
Adds a basket icon
<icon name=cape></icon>
Adds a cape icon
<icon name=ring></icon>
Adds a ring icon
<icon name=medal></icon>
Adds a medal icon
<icon name=belt></icon>
Adds a belt icon
<icon name=necklace></icon>
Adds a necklace icon
<icon name=pullover></icon>
Adds a pullover icon
<icon name=mask></icon>
Adds a mask icon
<icon name=bracers></icon>
Adds a bracer icon
<icon name=handheld></icon>
Adds an icon of a hand holding a tool
<icon name=left></icon>
Adds an icon of an arrow pointing left
<icon name=right></icon>
Adds an icon of an arrow pointing right
<icon name=offhand></icon>
Adds an icon of a left empty hand
<icon name=leftmousebutton></icon>
Adds an icon of a mouse with highlighted left button
<icon name=rightmousebutton></icon>
Adds an icon of a mouse with highlighted right button
<icon name=plusicon>
Plus icon

Waypoint Icons

These are the icons that are already used for the waypoints and map images in-game.

<icon name=wpCircle></icon>
Adds an icon of a circle
<icon name=wpPlayer></icon>
Adds a pear shaped icon
<icon name=wpTurnip></icon>
Adds an icon of a turnip
<icon name=wpGrain></icon>
Adds an icon of grain
<icon name=wpApple></icon>
Adds an icon of an apple
<icon name=wpBerries></icon>
Adds an icon of berries
<icon name=wpMushroom></icon>
Adds an icon of a mushroom
<icon name=wpBee></icon>
Adds an icon of a bee
<icon name=wpCave></icon>
Adds an icon of a mountain
<icon name=wpGear></icon>
Adds an icon of a gear
<icon name=wpGravestone></icon>
Adds an icon of a gravestone
<icon name=wpHome></icon>
Adds an icon of a house
<icon name=wpLadder></icon>
Adds an icon of a ladder out of a hole
<icon name=wpPick></icon>
Adds an icon of a pickaxe
<icon name=wpPropick></icon>
Adds an icon of a prospecting pickaxe
<icon name=wpRocks></icon>
Adds an icon of rocks
<icon name=wpRuins></icon>
Adds an icon of a ruin
<icon name=wpSkull_and_crossbones></icon>
Adds a skull and crossbones icon
<icon name=wpSpiral></icon>
Adds an icon of a spiral
<icon name=wpStar1></icon>
Adds an icon of a four point star
<icon name=wpStar2></icon>
Adds an icon of a five point star
<icon name=wpTrader></icon>
Adds an icon of a trader's caravan
<icon name=wpTree></icon>
Adds an icon of an evergreen tree
<icon name=wpTree2></icon>
Adds an icon of a deciduous tree
<icon name=wpVessel></icon>
Adds an icon of a vessel
<icon name=wpX></icon>
Adds an icon of an X
<icon name=wpCross></icon>
Adds an icon of a cross

Builtin SVG Icons

These icons are included in the base game. Additional SVG icons can be added by mods by placing them in the textures folder. By default the icons are rendered very small. So the example image on the side uses font size 30 for the icons and font size 16 for the names.

<icon path="icons/excla.svg"></icon>
Exclamation mark
<icon path="icons/warning.svg"></icon>
Warning
<icon path="icons/checkmark.svg"></icon>
Checkmark
<icon path="icons/heatmap.svg"></icon>
Contour map
<icon path="icons/rocks.svg"></icon>
Rocks
<icon path="icons/scytheremove.svg"></icon>
Completely remove grass block with scythe
<icon path="icons/scythetrim.svg"></icon>
Trim the top of the grass block with scythe
<icon path="icons/character/armor-body.svg"></icon>
Chest plate
<icon path="icons/character/armor-helmet.svg"></icon>
Helmet
<icon path="icons/character/armor-legs.svg"></icon>
Boots
<icon path="icons/worldedit/chiselbrush.svg"></icon>
Chisel

Content Modding

Basics

Content Mods • Developing a Content Mod • Packaging & Release

Tutorials

Basic	Basic Tutorials • 1. Content Essentials • 2. Simple Item • 3. Simple Block • 4. Simple Recipes
Intermediate	Intermediate Tutorials • 5. Item Variants • 6. Block Variants • 7. Complex Grid Recipes • 8. Further Recipes • 9. Simple World Generation
Advanced	Advanced Tutorials
Other	Other Tutorials • Debugging Content • Inter-Mod Compatibility

Concepts

Modding Concepts • Modinfo • Variants • Domains • Patching • Remapping • World Properties

Moddable Assets

Common

Block Types • Entities • Item Types • Patches • Recipes (Alloy, Barrel, Clayforming, Cooking, Grid, Knapping, Smithing) • Shapes • Sounds • Textures & Icons • World Properties

Uncategorized

Basics	Asset System • Recipes • Entities • Model Creator • Animation • VTML & Icons
Worldgen	WorldGen Concepts • Terrain • Ores • Trees • Json Random Generator

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding
Modding Introduction	Getting Started • Theme Pack
Content Modding	Content Mods • Developing a Content Mod • Basic Tutorials • Intermediate Tutorials • Advanced Tutorials • Content Mod Concepts
Code Modding	Code Mods • Setting up your Development Environment
Property Overview	Item • Entity • Entity Behaviors • Block • Block Behaviors • Block Classes • Block Entities • Block Entity Behaviors • Collectible Behaviors • World properties
Workflows & Infrastructure	Modding Efficiency Tips • Mod-engine compatibility • Mod Extensibility • VS Engine
Additional Resources	Community Resources • Modding API Updates • Programming Languages • List of server commands • List of client commands • Client startup parameters • Server startup parameters Example Mods • API Docs • GitHub Repository

Wiki Navigation
Vintage Story	Guides[[::Category:Guides\| ]] • Frequently Asked Questions • Soundtrack • Versions • Controls
Game systems	Crafting • Knapping • Clay forming • Smithing • Cooking • Temperature • Hunger • Mining • Temporal stability • Mechanical power • Trading • Farming • Animal husbandry
World	World generation • Biomes • Weather • Temporal storms
Items	Tools • Weapons • Armor • Clothing • Bags • Materials • Food
Blocks	Terrain • Plants • Decorative • Lighting • Functional • Ore
Entities	Hostile entities • Animals • NPCs • Players
Miscellaneous	List of client commands • List of server commands • Creative Starter Guide • Bot System • WorldEdit • Cinematic Camera • Adjustable FPS Video Recording • ServerBlockTicking

@@ Line 1: / Line 1: @@
 <languages/><translate>
 <!--T:1-->
-{{GameVersion|1.15}}
+{{GameVersion|1.19}}
-'''Vintagetext Markup Language (VTML)''', is a (obviously) completely novel and highly advanced markup language designed to display richly formatted text inside Vintage Story. Definitely has nothing in common with the old and outdated HTML standard ;-)
+'''Vintagetext Markup Language (VTML)''', is a (obviously) completely novel and highly advanced markup language designed to display richly formatted text inside Vintage Story. These are often used to create more versatile handbook pages.
 </translate>
@@ Line 14: / Line 14: @@
 *'''<nowiki><i>text</i></nowiki>'''<br>Causes the text to be in italic font
 *'''<nowiki><strong>text</strong></nowiki>'''<br>Causes the text to be in bold font
-*'''<nowiki><a href="url">text</a></nowiki>'''<br>Turns text into a clickable link. You can link to websites (http://), handbook pages (handbook://pagecode), search results in the handbook (handbooksearch://text_in_your_language) or trigger hotkeys (hotkey://code)
+*'''<nowiki><a href="url">text</a></nowiki>'''<br>Turns text into a clickable link. You can link to websites (http://), handbook pages (handbook://pagecode), search results in the handbook (handbooksearch://text_in_your_language), a link that types in the chatbox ("chattype:///giveblock clutter{type: \"barrel-metal1\"}"), trigger hotkeys (hotkey://code) or commands (command:///time set day). Custom links can be added by mods as well using ICoreAPI.RegisterLinkProtocol
 *'''<nowiki><font size="num" color="hexcolor" weight="bold" lineheight="1.2" align="right" opacity="0.5">text</font></nowiki>'''<br>Formats the text by given properties, all properties are optional
 *'''<nowiki><hk>command</hk> or <hotkey>command</hotkey></nowiki>'''<br>Display the actual current mapping of the "command" key, e.g <hk>sprint</hk> displays the current key used to activate the sprint in your game.
@@ Line 21: / Line 21: @@
 <!--T:5-->
-'''<nowiki><icon name="[icon name]"></icon></nowiki>'''<br>Draws a symbol, selected from a list of predefined, hardcoded symbols, which can be used when modifying the Handbook or any other rich text in the game. These icons can be scaled and coloured by adding the appropriate commands.
+'''<nowiki><icon name="[icon name]"></icon></nowiki>'''<br>Draws an internal icon. See the list below. Note that the waypoint svg icon files are also registered as internal icons.
+'''<nowiki><icon path="[icon svg path]"></icon></nowiki>'''<br>Draws an icon from an svg file. The path is relative to the texture folder, and should include the svg extension. By default the icons are loaded from the base game, but icons can be loaded from mods by prefixing the path with the mod domain (followed by a colon).
+Both kinds of mods can be scaled and colored by the font tag. This is almost necessary for the svg icons, as they are otherwise rendered very small. For example, '''<nowiki><font size="30"><icon path="icons/checkmark.svg"></icon></font></nowiki>'''
 <!--T:9-->
 [[File:Icons hardcoded.png|500px|thumb|right]]
-====Normal Icons==== <!--T:6-->
+====Internal Icons==== <!--T:6-->
 <!--T:10-->
 These icons are used in World Edit, for the equipment slots and for the tutorial.
+*'''<nowiki><icon name=none></icon></nowiki>'''<br>Crossed out circle
 *'''<nowiki><icon name=dice></icon></nowiki>'''<br>Adds a dice icon
 *'''<nowiki><icon name=paintbrush></icon></nowiki>'''<br>Adds a paintbrush icon
@@ Line 35: / Line 40: @@
 *'''<nowiki><icon name=airbrush></icon></nowiki>'''<br>Adds an airbrush icon
 *'''<nowiki><icon name=erode></icon></nowiki>'''<br>Adds an erosion icon
-*'''<nowiki><br><icon name=move></icon></nowiki>'''<br>Adds an arrow icon
+*'''<nowiki><icon name=move></icon></nowiki>'''<br>Adds an arrow icon
 *'''<nowiki><icon name=import></icon></nowiki>'''<br>Adds an import icon
 *'''<nowiki><icon name=eraser></icon></nowiki>'''<br>Adds an eraser icon
 *'''<nowiki><icon name=growshrink></icon></nowiki>'''<br>Adds a size changing icon
 *'''<nowiki><icon name=line></icon></nowiki>'''<br>Adds a line icon
-*'''<nowiki><br><icon name=lake></icon></nowiki>'''<br>Adds a water icon
+*'''<nowiki><icon name=lake></icon></nowiki>'''<br>Adds a water icon
 *'''<nowiki><icon name=floodfill></icon></nowiki>'''<br>Adds an overflowing bucket icon
 *'''<nowiki><icon name=tree></icon></nowiki>'''<br>Adds a tree icon
 *'''<nowiki><icon name=undo></icon></nowiki>'''<br>Adds an undo icon
 *'''<nowiki><icon name=redo></icon></nowiki>'''<br>Adds a redo icon
-*'''<nowiki><br><icon name=copy></icon></nowiki>'''<br>Adds a copy icon
+*'''<nowiki><icon name=copy></icon></nowiki>'''<br>Adds a copy icon
 *'''<nowiki><icon name=select></icon></nowiki>'''<br>Adds a select icon
 *'''<nowiki><icon name=repeat></icon></nowiki>'''<br>Adds a repeat icon
 *'''<nowiki><icon name=trousers></icon></nowiki>'''<br>Adds a trouser icon
 *'''<nowiki><icon name=gloves></icon></nowiki>'''<br>Adds a glove icon
-*'''<nowiki><br><icon name=hat></icon></nowiki>'''<br>Adds a hat icon
+*'''<nowiki><icon name=hat></icon></nowiki>'''<br>Adds a hat icon
 *'''<nowiki><icon name=shirt></icon></nowiki>'''<br>Adds a shirt icon
 *'''<nowiki><icon name=boots></icon></nowiki>'''<br>Adds a boot icon
 *'''<nowiki><icon name=basket></icon></nowiki>'''<br>Adds a basket icon
 *'''<nowiki><icon name=cape></icon></nowiki>'''<br>Adds a cape icon
-*'''<nowiki><br><icon name=ring></icon></nowiki>'''<br>Adds a ring icon
+*'''<nowiki><icon name=ring></icon></nowiki>'''<br>Adds a ring icon
 *'''<nowiki><icon name=medal></icon></nowiki>'''<br>Adds a medal icon
 *'''<nowiki><icon name=belt></icon></nowiki>'''<br>Adds a belt icon
 *'''<nowiki><icon name=necklace></icon></nowiki>'''<br>Adds a necklace icon
 *'''<nowiki><icon name=pullover></icon></nowiki>'''<br>Adds a pullover icon
-*'''<nowiki><br><icon name=mask></icon></nowiki>'''<br>Adds a mask icon
+*'''<nowiki><icon name=mask></icon></nowiki>'''<br>Adds a mask icon
 *'''<nowiki><icon name=bracers></icon></nowiki>'''<br>Adds a bracer icon
 *'''<nowiki><icon name=handheld></icon></nowiki>'''<br>Adds an icon of a hand holding a tool
@@ Line 68: / Line 73: @@
 *'''<nowiki><icon name=leftmousebutton></icon></nowiki>'''<br>Adds an icon of a mouse with highlighted left button
 *'''<nowiki><icon name=rightmousebutton></icon></nowiki>'''<br>Adds an icon of a mouse with highlighted right button
+*'''<nowiki><icon name=plusicon></nowiki>'''<br>Plus icon
 ====Waypoint Icons==== <!--T:7-->
 <!--T:11-->
-These are the icons that are already used for the waypoints and map images ingame.
+These are the icons that are already used for the waypoints and map images in-game.
 *'''<nowiki><icon name=wpCircle></icon></nowiki>'''<br>Adds an icon of a circle
+*'''<nowiki><icon name=wpPlayer></icon></nowiki>'''<br>Adds a pear shaped icon
 *'''<nowiki><icon name=wpTurnip></icon></nowiki>'''<br>Adds an icon of a turnip
 *'''<nowiki><icon name=wpGrain></icon></nowiki>'''<br>Adds an icon of grain
@@ Line 86: / Line 93: @@
 *'''<nowiki><icon name=wpLadder></icon></nowiki>'''<br>Adds an icon of a ladder out of a hole
 *'''<nowiki><icon name=wpPick></icon></nowiki>'''<br>Adds an icon of a pickaxe
+*'''<nowiki><icon name=wpPropick></icon></nowiki>'''<br>Adds an icon of a prospecting pickaxe
 *'''<nowiki><icon name=wpRocks></icon></nowiki>'''<br>Adds an icon of rocks
 *'''<nowiki><icon name=wpRuins></icon></nowiki>'''<br>Adds an icon of a ruin
@@ Line 98: / Line 106: @@
 *'''<nowiki><icon name=wpX></icon></nowiki>'''<br>Adds an icon of an X
 *'''<nowiki><icon name=wpCross></icon></nowiki>'''<br>Adds an icon of a cross
+====Builtin SVG Icons====
+These icons are included in the base game. Additional SVG icons can be added by mods by placing them in the textures folder. By default the icons are rendered very small. So the example image on the side uses font size 30 for the icons and font size 16 for the names.
+[[File:Icons builtin svg.png|500px|thumb|right]]
+*'''<nowiki><icon path="icons/excla.svg"></icon></nowiki>'''<br>Exclamation mark
+*'''<nowiki><icon path="icons/warning.svg"></icon></nowiki>'''<br>Warning
+*'''<nowiki><icon path="icons/checkmark.svg"></icon></nowiki>'''<br>Checkmark
+*'''<nowiki><icon path="icons/heatmap.svg"></icon></nowiki>'''<br>Contour map
+*'''<nowiki><icon path="icons/rocks.svg"></icon></nowiki>'''<br>Rocks
+*'''<nowiki><icon path="icons/scytheremove.svg"></icon></nowiki>'''<br>Completely remove grass block with scythe
+*'''<nowiki><icon path="icons/scythetrim.svg"></icon></nowiki>'''<br>Trim the top of the grass block with scythe
+*'''<nowiki><icon path="icons/character/armor-body.svg"></icon></nowiki>'''<br>Chest plate
+*'''<nowiki><icon path="icons/character/armor-helmet.svg"></icon></nowiki>'''<br>Helmet
+*'''<nowiki><icon path="icons/character/armor-legs.svg"></icon></nowiki>'''<br>Boots
+*'''<nowiki><icon path="icons/worldedit/chiselbrush.svg"></icon></nowiki>'''<br>Chisel
 </translate>
-{{Navbox/modding|Vintage Story}}
+{{Navbox/contentmodding}}
 {{Game navbox}}

Anonymous

Search

VTML: Difference between revisions

Namespaces

More

Page actions

Latest revision as of 14:16, 27 March 2024

Contents

Tags

Icons

Internal Icons

Waypoint Icons

Builtin SVG Icons

Navigation

Navigation

VS related links

Community portal

Wiki tools

Wiki tools

Anonymous

Search

VTML: Difference between revisions

Latest revision as of 14:16, 27 March 2024

Tags

Icons

Internal Icons

Waypoint Icons

Builtin SVG Icons

Navigation

Wiki tools

Page tools