mkwineprefix

Python versions PyPI - Version GitHub tag (with filter) License GitHub commits since latest release (by SemVer including pre-releases) CodeQL QA Tests Coverage Status Dependabot Documentation Status mypy uv pytest Ruff Downloads Stargazers pre-commit.ci status Prettier Follow @Tatsh Mastodon Follow

Create a Wine prefix with custom settings.

Commands

mkwineprefix

Create a Wine prefix with custom settings.

Usage

mkwineprefix [OPTIONS] PREFIX_NAME

Options

-D, --dpi <dpi>

DPI.

-d, --debug

Enable debug output.

--disable-explorer

Disable starting explorer.exe automatically.

--disable-services

Disable starting services.exe automatically (only useful for simple CLI programs with –disable-explorer).

-E, --eax

Enable EAX.

-g, --gtk

Enable Gtk+ theming.

-r, --prefix-root <prefix_root>

Prefix root.

-S, --sandbox

Sandbox the prefix.

--no-gecko

Disable downloading Gecko automatically.

--no-mono

Disable downloading Mono automatically.

--no-xdg

Disable winemenubuilder.exe.

--no-assocs

Disable creating file associations, but still allow menu entries to be made (unless –no-xdg is also passed).

-N, --nvapi

Add dxvk-nvapi.

-o, --noto

Use Noto Sans in place of most fonts.

-T, --trick <tricks>

Add an argument for winetricks.

-t, --tmpfs

Make Wine use tmpfs.

-V, --windows-version <windows_version>

Windows version.

Options:

11 | 10 | vista | 2k3 | 7 | 8 | xp | 81 | 2k | 98 | 95

--vd <SIZE>

Virtual desktop size, e.g. 1024x768.

-W, --winrt-dark

Enable dark mode for WinRT apps.

-x, --dxva-vaapi

Enable DXVA2 support with VA-API.

--32

Use 32-bit prefix.

Arguments

PREFIX_NAME

Required argument

Create a Wine prefix with custom settings.

async mkwineprefix.prefix.create_wine_prefix(prefix_name: str, *, _32bit: bool = False, asio: bool = False, disable_explorer: bool = False, disable_services: bool = False, dpi: int = 96, dxva_vaapi: bool = False, dxvk_nvapi: bool = False, eax: bool = False, gtk: bool = False, no_associations: bool = False, no_gecko: bool = False, no_mono: bool = False, no_xdg: bool = False, noto_sans: bool = False, prefix_root: StrPath | None = None, sandbox: bool = False, tmpfs: bool = False, tricks: Iterable[str] | None = None, vd: str = 'off', windows_version: WineWindowsVersion = '10', winrt_dark: bool = False) → Path

Create a Wine prefix with custom settings.

If winetricks is not installed, the tricks argument will be ignored.

Parameters:
prefix_name : str

Name of the prefix to create.

_32bit : bool

Create a 32-bit Wine prefix.

asio : bool

Enable ASIO support.

disable_explorer : bool

Disable explorer.exe from automatically starting.

disable_services : bool

Disable services.exe from automatically starting.

dpi : int

Screen DPI.

dxva_vaapi : bool

Enable VAAPI support for DXVA.

dxvk_nvapi : bool

Enable DXVK NVAPI support.

eax : bool

Enable EAX support.

gtk : bool

Enable GTK theme support.

no_associations : bool

Disable file associations.

no_gecko : bool

Disable Gecko support.

no_mono : bool

Disable Mono support.

no_xdg : bool

Disable XDG support.

noto_sans : bool

Use Noto Sans font.

prefix_root : str | PathLike[str] | None

Root directory for the prefix. If None, defaults to ~/.local/share/wineprefixes.

sandbox : bool

Enable sandbox mode.

tmpfs : bool

Use /tmp as a temporary filesystem.

tricks : Iterable[str] | None

List of winetricks to run. If None, defaults to an empty list.

vd : str

Virtual desktop mode. If 'off', disables virtual desktop mode.

windows_version : WineWindowsVersion

Windows version to set for the prefix.

winrt_dark : bool

Enable Windows 10 dark mode.

Returns:

Path to the created prefix.

Return type:

Path

Raises:

FileExistsError – If the prefix directory already exists.

Indices and tables