title	description
Actions - Dependencies	These are the actions supported in dependencies steps.

Actions

Each step has an action type, Bottles uses this to figure out what operation to perform. Each of these determines a specific set of parameters.

Bottles supports several actions and will certainly be extended in the future.

Actions table

The following table lists all the actions that Bottles supports for dependencies steps.

Action	Description
`install_exe` or `install_msi`	Install an executable
`download_archive`	Download an archive
`archive_extract`	Extract an archive
`cab_extract`	Extract a Windows Cabinet
`get_from_cab`	Extract a file from a Windows Cabinet
`override_dll`	Override a DLL
`uninstall`	Call an uninstaller by its name
`set_windows`	Set the current Windows version
`use_windows`	Set Windows version per executable
`register_dll`	Register one ore more DLL and ActiveX control
`set_register_key`	Set a Windows registry key
`copy_file` or `copy_dll`	Copy a file from one place to another
`install_fonts`	Copy one or more fonts to the bottle windows/Fonts path
`register_font`	Register a font in the Windows registry
`replace_font`	Replace a font replacement in the Windows registry

Common definitions

Downloads and local files

All actions that support a url key will download the file from that URL. This can also be used to define a local file (from th|e Bottles' temp folder). The correct syntax to use the local file is:

..
url: temp/file...
..

the temp/ part (placeholder) will be automatically replaced by the full path to the Bottles' temp folder.

`install_exe` or `install_msi`

This action is used to install an executable.

Parameters

Key	Description
`file_name`	The name of the file to be installed
`url`	The URL or path of the file to be downloaded
`rename`	The new name of the file if it must be renamed
`file_checksum`	The checksum of the file (MD5)
`arguments`	The arguments to be passed to the executable
`environment`	The environment variables to be injected

Example

- action: install_exe
  environment: 
    WINEDLLOVERRIDES: fusion=b
  file_name: ndp48-x86-x64-allos-enu.exe
  url: https://download.visualstudio.microsoft.com/download/pr/7afca223-55d2-470a-8edc-6a1739ae3252/abd170b4b0ec15ad0222a809b761a036/ndp48-x86-x64-allos-enu.exe
  rename: dotnet48.exe
  file_checksum: 4e7a8586d06ce1f8cebac0d4bc379e16
  arguments: /sfxlang:1027 /q /norestart

`download_archive`

This action is used to download an archive, can also be used to download any other kind of file. It only downloads the file, it does not extract, install or anything else.

Parameters

Key	Description
`file_name`	The name of the file to be downloaded
`url`	The URL or path of the file to be downloaded
`rename`	The new name of the file if it must be renamed
`file_checksum`	The checksum of the file (MD5)

Example

- action: download_archive
  file_name: msxml6-KB973686-enu-amd64.exe
  url: https://web.archive.org/web/20190122095451/https://download.microsoft.com/download/1/5/8/158F681A-E595-472B-B15E-62B649B1B6FF/msxml6-KB973686-enu-amd64.exe
  file_checksum: 13a292beb9ebe46ac97b8a4352fe2cd5

`archive_extract`

This action is used to download and extract an archive. The archive will be extracted to a new directory named as the file_name or rename in the Bottles' temp directory.

Parameters

Key	Description
`file_name`	The name of the file to be downloaded
`url`	The URL or path of the file to be downloaded
`rename`	The new name of the file if it must be renamed
`file_checksum`	The checksum of the file (MD5)

Example

- action: archive_extract
  file_name: faudio-20.07.tar.xz
  rename: faudio_20_07.xz
  url: https://github.com/Kron4ek/FAudio-Builds/releases/download/20.07/faudio-20.07.tar.xz
  file_checksum: 7385a4d276f940e025488e74a967789b

`cab_extract`

This action is used to extract a Windows Cabinet, can also download it before extracting.

Parameters

Key	Description
`file_name`	The name of the file to be downloaded
`url`	The URL or path of the file to be downloaded
`rename`	The new name of the file if it must be renamed
`file_checksum`	The checksum of the file (MD5)
`dest`	The destination folder where the files will be extracted, Bottles will automatically create it if does not exist

Supported `dest` values

The destination should start with one of the following placeholders:

Placeholder	Description
temp/	Will be automatically replaced with the full path to the Bottles' temp directory

If the destination does not start with one of the supported placeholders, it will fail with an error. It is not possible to extract a whole Windows Cabinet to a bottle folder, hardscripting this will result in a rejection by the team.

Example

- action: cab_extract
  file_name: directx_Jun2010_redist.exe
  url: https://download.microsoft.com/download/8/4/A/84A35BF1-DAFE-4AE8-82AF-AD2AE20B6B14/directx_Jun2010_redist.exe
  file_checksum: 822e4c516600e81dc7fb16d9a77ec6d4
  dest: temp/directx_Jun2010_redist/

`get_from_cab`

This action is used to extract a file from a Windows Cabinet.

Parameters

Key	Description
`source`	The path to the Windows Cabinet file
`file_name`	The file to be extracted (support wildcards)
`dest`	The destination folder where the files will be extracted, Bottles will automatically create it if does not exist

Supported `dest` values

The destination should start with one of the following placeholders:

Placeholder	Description
temp/	Will be automatically replaced with the full path to the Bottles' temp directory
win64/	Will be automatically replaced with the full path to the windows/ system 64bit folder of the running bottle
win32/	Will be automatically replaced with the full path to the windows/ system 32bit folder of the running bottle

Note: The win64 and win32 placeholders are extremely important, as they change according to the bottle's architecture. Windows (and WINE) 32bit use the system32 folder to store 32bit resources, while 64bit systems uses the system32 folder to store 64bit resources and syswow64 to store 32bit.

If the destination does not start with one of the supported placeholders, it will fail with an error. It is not possible to extract a whole Windows Cabinet to a bottle folder, hardscripting this will result in a rejection by the team.

Example

- action: get_from_cab
  source: directx_Jun2010_redist.exe
  file_name: Jun2010_D3DCompiler_43_x86.cab
  dest: temp/d3dcompiler_43_x86/

example using the win64 and win32 placeholders:

- action: get_from_cab
  source: d3dcompiler_43_x86/Jun2010_D3DCompiler_43_x86.cab
  file_name: D3DCompiler_43.dll
  dest: win32
  rename: d3dcompiler_43.dll

- action: get_from_cab
  source: d3dcompiler_43_x64/Jun2010_D3DCompiler_43_x64.cab
  file_name: D3DCompiler_43.dll
  dest: win64/
  rename: d3dcompiler_43.dll

`override_dll`

This action is used to override a DLL in the bottle.

References:

Wine User's Guide - DLL Overrides

Parameters

Key	Description
`dll`	The name of the DLL to be overridden
`type`	The type of the override

Supported `type` values

Value
`native`
`builtin`
`disabled`
`native,builtin`
`builtin,native`

Do not use the short n/b/d syntax, it will not work.

Example

- action: override_dll
  dll: msvcp140
  type: native,builtin

- action: override_dll
  dll: msvcr140
  type: native,builtin

- action: override_dll
  dll: ucrtbase
  type: native,builtin

`uninstall`

This action is used to uninstall a program from the bottle before proceeding with the dependency installation. It will look for the uninstaller UUID and run the uninstaller.

This can be very useful for dependencies like dotnet* witch are not compatible with mono and require it to be uninstalled.

Parameters

Key	Description
`file_name`	The name of the program to be uninstalled

Example

- action: uninstall
  file_name: Wine Mono

`set_windows`

This action is used to change the Windows version of the bottle.

Supported `version`

Value	Description
`win10`	Windows 10
`win81`	Windows 8.1
`win8`	Windows 8
`win7`	Windows 7
`win2008r2`	Windows 2008 R2
`win2008`	Windows 2008
`win2003`	Windows 2003
`winxp`	Windows XP
`win98`	Windows 98
`win95`	Windows 95

Example

- action: set_windows
  version: win10

`use_windows`

This action is used to set a Windows version for an executable.

Supported `version`

Same as set_windows action.

Example

- action: use_windows
  version: win10

`register_dll`

This action is used to register a DLL and ActiveX control in the bottle.

Parameters

Key	Description
`dlls`	The list of DLLs to be registered

Example

- action: register_dll
  dlls:
    - dsdmo.dll
    - dsdmoprp.dll

`set_register_key`

This action is used to set a key in the bottle's registry (WINE Registry).

Parameters

Key	Description
`key`	The key to be set
`value`	The value to be set
`data`	The data to be set
`type`	The type of the data to be set

Supported `type` values

Value	Description
`REG_DWORD`	A 32-bit number
`REG_SZ`	A string
`REG_BINARY`	A binary
`REG_MULTI_SZ`	A list of strings
`REG_EXPAND_SZ`	A string with environment variables

Example

- action: set_register_key
  key: HKLM\\Software\\Microsoft\\NET Framework Setup\\NDP\\v4\\Full
  value: Install
  data: '0001'
  type: REG_DWORD

- action: set_register_key
  key: HKLM\\Software\\Microsoft\\NET Framework Setup\\NDP\\v4\\Full
  value: Version
  data: 4.0.30319
  type: REG_SZ

`copy_file` or `copy_dll`

This action is used to copy files from a source to a destination. It also supports wildcards to copy multiple files using patterns.

copy_dll is just an alias for copy_file.

Parameters

Key	Description
`file_name`	The name of the file to be copied (wildcards are supported)
`url`	The temp path where the files are located
`dest`	The destination path

Note: the url key supports only files in the Bottles' temp path and should start with the temp/ placeholder, as it will be replaced with the full Bottles' temp path.

Supported `dest` values

The destination should start with one of the following placeholders:

Placeholder	Description
temp/	Will be automatically replaced with the full path to the Bottles' temp directory
win64/	Will be automatically replaced with the full path to the windows/ system 64bit folder of the running bottle
win32/	Will be automatically replaced with the full path to the windows/ system 32bit folder of the running bottle
windows/	Will be automatically replaced with the full path to the windows/ folder of the running bottle

Note: The win64 and win32 placeholders are extremely important, as they change according to the bottle's architecture. Windows (and WINE) 32bit use the system32 folder to store 32bit resources, while 64bit systems uses the system32 folder to store 64bit resources and syswow64 to store 32bit.

If the destination does not start with one of the supported placeholders, it will fail with an error. It is not possible to extract a whole Windows Cabinet to a bottle folder, hardscripting this will result in a rejection by the team.

Example

- action: copy_dll
  file_name: '*.dll'
  url: temp/faudio_20_07/faudio-20.07/x64
  dest: win32
  
- action: copy_dll
  file_name: '*.dll'
  url: temp/faudio_20_07/faudio-20.07/x64
  dest: win64

`install_fonts`

This action is used to install (copy) fonts from the temp path to the bottle Windows/Fonts folder.

Parameters

Key	Description
`url`	The temp path where the fonts are located
`fonts`	The fonts to be installed

Note: the url key supports only files in the Bottles' temp path and should start with the temp/ placeholder, as it will be replaced with the full Bottles' temp path.

Example

- action: install_fonts
  url: temp/SourceHanSans
  fonts:
  - SourceHanSans.ttc
  - SourceHanSans2.ttc

`register_font`

This action is used to register a font in the bottle (WINE) registry so it cab be found by the runner.

Parameters

Key	Description
`name`	The name of the font
`file`	The font file name (in `Windows/Fonts` path)

Example

- action: register_font
  name: Source Han Sans SC ExtraLight
  file: SourceHanSans.ttc

- action: register_font
  name: Source Han Sans SC Light
  file: SourceHanSans.ttc

- action: register_font
  name: Source Han Sans SC Normal
  file: SourceHanSans.ttc

`replace_font`

This action can be used to replace a font. It is useful to fake a font installation, replacing it with anothe font (like when one is under proprietary license and cannot be redistributed).

Parameters

Key	Description
`font`	The font to be used as replacement
`replace`	The list of fonts to be replaced

Example

- action: replace_font
  font: Source Han Sans SC
  replace:
  - Dengxian
  - FangSong
  - KaiTi
  - Microsoft YaHei
  - Microsoft YaHei UI
  - NSimSun
  - SimHei
  - SimKai
  - SimSun
  - SimSun-ExtB

Files

Actions.md

Latest commit

History

Actions.md

File metadata and controls

Actions

Actions table

Common definitions

Downloads and local files

install_exe or install_msi

Parameters

Example

download_archive

Parameters

Example

archive_extract

Parameters

Example

cab_extract

Parameters

Supported dest values

Example

get_from_cab

Parameters

Supported dest values

Example

override_dll

Parameters

Supported type values

Example

uninstall

Parameters

Example

set_windows

Supported version

Example

use_windows

Supported version

Example

register_dll

Parameters

Example

set_register_key

Parameters

Supported type values

Example

copy_file or copy_dll

Parameters

Supported dest values

Example

install_fonts

Parameters

Example

register_font

Parameters

Example

replace_font

Parameters

Example

`install_exe` or `install_msi`

`download_archive`

`archive_extract`

`cab_extract`

Supported `dest` values

`get_from_cab`

Supported `dest` values

`override_dll`

Supported `type` values

`uninstall`

`set_windows`

Supported `version`

`use_windows`

Supported `version`

`register_dll`

`set_register_key`

Supported `type` values

`copy_file` or `copy_dll`

Supported `dest` values

`install_fonts`

`register_font`

`replace_font`