Skip to content

retc3/msfs-vulkan

Repository files navigation

msfs-vulkan

Caution

WARNING! msfs-vulkan is highly experimental, do not expect it to increase performance, Just because your GPU supports Vulkan doesn't mean msfs-vulkan will work, MSFS may also be highly unstable while you're using msfs-vulkan. You accept the risk that your install of MSFS could be corrupted by this tool by installing it. You'll also probably see artifacting caused by the tool or crash mid way through a 14 hour flight.

Welcome!msfs-vulkan is a translation layer to make MSFS2020/2024's DirectX 12 calls into Vulkan,

It works by using translation layers: KD3D-Proton and DXVK to take the MSFS DirectX calls and translate them into Vulkan calls, This may help performance on low spec systems. You can restore the original MSFS files via the CLI or the GUI.

All the different parts

msfs-vulkan is broken up into 4 different parts.

  • msfs-vulkan-gui: A friendly Graphics interface for those who like GUI's instead of Terminals.
  • msfs-vulkan-cli: The CLI version, You'll need to call it within the Terminal
  • msfs-vulkan-core: As the name suggests, it's the main core of msfs-vulkan, without it none of this would work at all.
  • msfs-vulkan-vulkan: A tiny probe to check if your GPU can use Vulkan or not.

The repos used in this project are installed by the tool, this repo does not have them.

Documentation

Guides incase you need em

  • Usage Guide: How to use the CLI or GUI clients to use msfs-vulkan
  • Configuration Guide: How to configure msfs-vulkan, It's TOML settings, Performance presets, or make it point to your own fork of this project.
  • Development Guide: For whoevers interested, This tells you how msfs-vulkan was developed, The safety boundaries the tool takes to not corrupt your install, And how to compile the code yourself if you'd like.

About

Experimental MSFS 2020/2024 Vulkan launcher for testing VKD3D-Proton/DXVK translation layers, including support for custom and project-maintained forks.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

5 stars

Watchers

1 watching

Forks

Contributors

Languages