cargo-xwin

formerly cargo-xwinbuild

CI Crates.io docs.rs PyPI Docker Image

🚀 Help me to become a full-time open-source developer by sponsoring me on GitHub

Cross compile Cargo project to Windows msvc target with ease.

By using this software you are consented to accept the license at https://go.microsoft.com/fwlink/?LinkId=2086102

Prerequisite

  1. For pure Rust project, no prerequisites needed.
  2. For C/C++ dependencies, install clang.
  3. For assembly dependencies, install llvm-tools-preview component via rustup component add llvm-tools-preview or install llvm.

Installation

bash cargo install cargo-xwin

You can also install it using pip:

bash pip install cargo-xwin

We also provide a Docker image which has wine pre-installed in addition to cargo-xwin and Rust, for example to build for x86_64 Windows:

bash docker run --rm -it -v $(pwd):/io -w /io messense/cargo-xwin \ cargo xwin build --release --target x86_64-pc-windows-msvc

Usage

  1. Install Rust Windows msvc target via rustup, for example, rustup target add x86_64-pc-windows-msvc
  2. Run cargo xwin build, for example, cargo xwin build --target x86_64-pc-windows-msvc

Run tests with wine

With wine installed, you can run tests with the cargo xwin test command, for example, cargo xwin test --target x86_64-pc-windows-msvc

Customization

The Microsoft CRT and Windows SDK can be customized using the following environment variables or CLI options.

| Environment Variable | CLI option | Description | |----------------------|--------------------|--------------------------------------------------------------------------------------------------------------------| | XWIN_ARCH | --xwin-arch | The architectures to include, defaults to x86_64,aarch64, possible values: x86, x86_64, aarch, aarch64 | | XWIN_VARIANT | --xwin-variant | The variants to include, defaults to desktop, possible values: desktop, onecore, spectre | | XWIN_VERSION | --xwin-version | The version to retrieve, defaults to 16, can either be a major version of 15 or 16, or a <major>.<minor> version | | XWIN_CACHE_DIR | --xwin-cache-dir | xwin cache directory to put CRT and SDK files |

CMake Support

Some Rust crates use the cmake crate to build C/C++ dependencies, cargo-xwin will generate a CMake toolchain file automatically to make cross compilation work out of the box.

ninja is required to enable CMake support.

License

This work is released under the MIT license. A copy of the license is provided in the LICENSE file.