Adding `tauri_winres` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add --build tauri-winres

to add tauri_winres as a build-time dependency. To add it as a run-time dependency, run:

cargo add tauri-winres

To add it manually, edit your project's Cargo.toml file and add to the [build-dependencies] or [dependencies] section:

tauri-winres = "0.3.6"

The tauri_winres library will be automatically available globally. Read the tauri_winres library documentation.

Back to the crate overview.

Readme

tauri-winres

A simple library to facilitate adding Resources (metainformation and icons) to Portable Executables.

Note: tauri-winres is a fork of winres which no longer works on Rust 1.61 or higher and has been left unmaintained. This fork completely replaced the resource compiler implementation with the awesome embed-resource crate for better cross-platform compilation support. This fork was primarily updated and modified for use in Tauri. For a more general-purpose-like fork, which currently sticks closer to upstream, we suggest to also take a look at winresource.

Documentation

Toolkit

Before we begin you need to have the appropriate tools installed.

rc.exe from the Windows SDK
windres.exe and ar.exe from minGW64

If you are using Rust with the MSVC ABI you will need the Windows SDK and for the GNU ABI you'll need minGW64.

The Windows SDK can generally be found in the registry, but minGW64 must be in the $PATH environment.

Using tauri-winres

First, you will need to add a build script to your crate (build.rs) by adding it to your crate's Cargo.toml file:

[package]
#...
build = "build.rs"

[build-dependencies]
tauri-winres = "0.1"

Next, you have to write a build script. A short example is shown below.

// build.rs

fn main() {
  if std::env::var("CARGO_CFG_TARGET_OS").unwrap() == "windows" {
    let mut res = tauri_winres::WindowsResource::new();
    res.set_icon("test.ico");
    res.compile().unwrap();
  }
}

That's it. The file test.ico should be located in the same directory as build.rs. Metainformation (like program version and description) is taken from Cargo.toml's [package] section.

Note that support for using this crate on non-Windows platforms is experimental. It is recommended to only use tauri-winres on Windows hosts, by using cfg as a directive to avoid building tauri-winres on unix platforms alltogether.

[package]
#...
build = "build.rs"

[target.'cfg(windows)'.build-dependencies]
tauri-winres = "0.1"

Next, you have to write a build script. A short example is shown below.

// build.rs

#[cfg(windows)]
fn main() {
    let mut res = tauri_winres::WindowsResource::new();
    res.set_icon("test.ico");
    res.compile().unwrap();
}

#[cfg(unix)]
fn main() {}

Additional Options

For added convenience, tauri-winres parses Cargo.toml for a package.metadata.tauri-winres section:

[package.metadata.tauri-winres]
OriginalFilename = "PROGRAM.EXE"
LegalCopyright = "Copyright © 2016"
#...

This section may contain arbitrary string key-value pairs, to be included in the version info section of the executable/library file.

The following keys have special meanings and will be shown in the file properties of the Windows Explorer:

FileDescription, ProductName, ProductVersion, OriginalFilename and LegalCopyright

See MSDN for more details on the version info section of executables/libraries.

About this project

The original author and maintainers use this crate for their personal projects and although it has been tested in that context, we have no idea if the behaviour is the same everywhere.

To be brief, we are very much reliant on your bug reports and feature suggestions to make this crate better.

Adding tauri_winres library as a dependency

Adding `tauri_winres` library as a dependency