Images
Image syntax follows the standard Markdown image syntax with additional features. Images are always rendered in the middle of the topic.
Runtime images can be disabled in Voile's configuration (see the Configuration topic).
Locations
An image can be sourced from multiple locations.
Type | Location |
|---|---|
Mod resource asset image | Images located in the |
File system image | Images located in Voile's data folder ( |
Online image | Any online image that can be directly downloaded. |
Images loaded from the file system or from the Internet are considered runtime images.
Mod resource asset image
Topics from mod integrations should prefer including required images within their mod's Common/ assets. Then they can be easily sourced by specifying the fully qualified or relative path starting from the Common/ folder.
Resizing (resize hint)
Images shown in the UI can be resized by specifying {resize-hint} within the alternative text block. This hint is optional. If not specified, Voile will render the image with its original resolution.
Format | Result |
|---|---|
| Resizes image to 300 (width) x 200 (height). |
| Resizes image to 300 (width) while respecting image's aspect ratio. |
| Resizes image to 200 (height) while respecting image's aspect ratio. |
Multiple images
It is possible to specify multiple images next to each other.
Supported image file types
Numerous image file formats are supported. If the image is not a PNG, it will get automatically converted.
Supported formats:
.png.jpg,.jpeg.webp.tiff,.tif.bmp.gif(not animated, only the first frame).wbmp