Ventoy Image List Plugin

  • Background

By default, Ventoy will search all the directories and sub-directories in the 1st partition to find all the ISO/IMG... files.
You can change the default search root in Global Control Plugin with a VTOY_DEFAULT_SEARCH_ROOT option, then Ventoy will only search the specified directory and its sub-directories.
Besides, you can put a .ventoyignore file under some directory, Ventoy will skip this directory and its sub-directories when searching files.
Finally, Ventoy will sort all the files found by their names and show the boot menu.

  • New Requirement

Although Ventoy provides a flexible configuration for searching image files. But there are still some special cases.
For example:
1. You just want to show some of the ISO files in a directory, not all the ISO files.
2. You don't want to sort the files by name, you just want to show the boot menu in your specified order.
3. It's OK for Ventoy to search automatically. But I just want to hide some special iso files from the search result.

With this plugin, you can give a file list. It can be a whitelist or blacklist.
For WhiteList
Ventoy will no longer search for the files but just use your file list.
Also, Ventoy will NOT sort these files anymore, but directly display the boot menu according to the order given in the list.
For BlackList
Firstly, Ventoy will search as normal. And then remove the files in the blacklist from the search result.

It should be noted that, you don’t need to use this plugin in 99% of the cases. Just let Ventoy to search for the files.

  • Json Configuration

A image_list/image_blacklist array is defined to describe the auto installation configuration in /ventoy/ventoy.json.
image_list and image_blacklist are mutually exclusive. You can only use one of them.

{
    "image_list": [
        "/ISO/Linux/archlinux-2020.10.01-x86_64.iso",
        "/ISO/cn_windows_10_enterprise_ltsc_2019_x64_dvd_9c09ff24.iso",
        "/ISO/Win10PE.iso"
    ]
}

Key Type Description
STRING Full path of the image file (ISO/IMG/VHD...).
Must be in the 1st partition, the path must begin with / and without space and non-ascii characters.
image_list and image_blacklist are correspond respectively to whitelist mode and blacklist mode.
This option supports fuzzy matching, please refer About Path Matching
  • Multi-Mode

Supported. You can set different configurations for different BIOS mode. Please refer Multi-Mode Option for details.

  • Notes

1. This pluing has no dependencies with menu alias plugin. You just need to use the full path of the real file in the list.
2. When you set VTOY_DEFAULT_SEARCH_ROOT, all the files in the list must be under the specified directory or its sub-directories.