VTML

From Vintage Story Wiki
Jump to navigation Jump to search

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 ;-)

Tags

  • <br>
    Causes a line break
  • <i>text</i>
    Causes the text to be in italic font
  • <strong>text</strong>
    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) or trigger hotkeys (hotkey://code)
  • <font size="num" color="hexcolor" weight="bold" lineheight="1.2" align="right" opacity="0.5">text</font>
    Formats the text by given properties, all properties are optional

Icons

<icon name="[icon name]"></icon>
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.

Icons hardcoded.png

Normal Icons

These icons are not used in the game at the moment, but are still available.

  • <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
  • <br><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
  • <br><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
  • <br><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
  • <br><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
  • <br><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
  • <br><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

Waypoint Icons

These are the icons that are already used for the waypoints and map images ingame.

  • <icon name=wpBee></icon>
    Adds an icon of a bee
  • <icon name=wpCave></icon>
    Adds an icon of a mountain
  • <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=wpCircle></icon>
    Adds an icon of a circle
  • <icon name=wpPick></icon>
    Adds an icon of a pickaxe
  • <icon name=wpPlayer></icon>
    Adds an icon of the player map marker
  • <icon name=wpRocks></icon>
    Adds an icon of rocks
  • <icon name=wpRuins></icon>
    Adds an icon of a ruin
  • <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 traders caravan
  • <icon name=wpVessel></icon>
    Adds an icon of a vessel


Main Page: Modding
Basics Mod Types | Asset System | Textures | Items | Recipes | Blocks | Model Creator | Release
Advanced Setup(Windows,Linux) | Items (Code, JSON) | Blocks | Item-Block interactions | Block Behaviors | Block Entities | Particles | World Access
Worldgen Terrain | Ores | Trees | WorldGen API
Rendering Shaders and Renderers
Property Overview Item | Block | Block Behaviors | Block Classes | Block Entities | Block Entity Behaviors