mirror of
https://github.com/doitsujin/dxvk.git
synced 2025-02-20 10:54:16 +01:00
[meta] Update README
This commit is contained in:
parent
48a2b63247
commit
e6a12dc4e7
38
README.md
38
README.md
@ -4,7 +4,19 @@ A Vulkan-based translation layer for Direct3D 10/11 which allows running 3D appl
|
|||||||
|
|
||||||
For the current status of the project, please refer to the [project wiki](https://github.com/doitsujin/dxvk/wiki).
|
For the current status of the project, please refer to the [project wiki](https://github.com/doitsujin/dxvk/wiki).
|
||||||
|
|
||||||
For binary releases, see the [releases](https://github.com/doitsujin/dxvk/releases) page.
|
|
||||||
|
## How to use
|
||||||
|
In order to install a DXVK package obtained from the [release](https://github.com/doitsujin/dxvk/releases) page into a given wine prefix, run the following commands from within the DXVK directory:
|
||||||
|
|
||||||
|
```
|
||||||
|
export WINEPREFIX=/path/to/.wine-prefix
|
||||||
|
winetricks --force setup_dxvk.verb
|
||||||
|
```
|
||||||
|
|
||||||
|
This will **copy** the DLLs into the `system32` and `syswow64` directories of your wine prefix and set up the required DLL overrides. Pure 32-bit prefixes are also supported.
|
||||||
|
|
||||||
|
Verify that your application uses DXVK instead of wined3d by checking for the presence of the log files `d3d11.log` and `dxgi.log` in the application's directory, or by enabling the HUD (see notes below).
|
||||||
|
|
||||||
|
|
||||||
## Build instructions
|
## Build instructions
|
||||||
|
|
||||||
@ -12,7 +24,7 @@ For binary releases, see the [releases](https://github.com/doitsujin/dxvk/releas
|
|||||||
- [wine 3.10](https://www.winehq.org/) or newer
|
- [wine 3.10](https://www.winehq.org/) or newer
|
||||||
- [Meson](http://mesonbuild.com/) build system (at least version 0.43)
|
- [Meson](http://mesonbuild.com/) build system (at least version 0.43)
|
||||||
- [MinGW64](http://mingw-w64.org/) compiler and headers (requires threading support)
|
- [MinGW64](http://mingw-w64.org/) compiler and headers (requires threading support)
|
||||||
- [glslang](https://github.com/KhronosGroup/glslang) front end and validator
|
- [glslang](https://github.com/KhronosGroup/glslang) compile
|
||||||
|
|
||||||
### Building DLLs
|
### Building DLLs
|
||||||
|
|
||||||
@ -22,7 +34,7 @@ Inside the DXVK directory, run:
|
|||||||
./package-release.sh master /your/target/directory --no-package
|
./package-release.sh master /your/target/directory --no-package
|
||||||
```
|
```
|
||||||
|
|
||||||
This will create a folder `dxvk-master` in `/your/target/directory`, which contains both 32-bit and 64-bit versions of DXVK.
|
This will create a folder `dxvk-master` in `/your/target/directory`, which contains both 32-bit and 64-bit versions of DXVK, which can be set up in the same way as the release versions as noted above.
|
||||||
|
|
||||||
#### Compiling manually
|
#### Compiling manually
|
||||||
```
|
```
|
||||||
@ -39,26 +51,8 @@ ninja install
|
|||||||
|
|
||||||
The D3D10, D3D11 and DXGI DLLs as well as a shell script to set up DXVK for a specific wine prefix will be located in `/your/dxvk/directory/bin`.
|
The D3D10, D3D11 and DXGI DLLs as well as a shell script to set up DXVK for a specific wine prefix will be located in `/your/dxvk/directory/bin`.
|
||||||
|
|
||||||
## How to use
|
|
||||||
In order to set up a wine prefix to use DXVK instead of wined3d globally, run:
|
|
||||||
|
|
||||||
```
|
|
||||||
cd /your/compiling/directory/x32/
|
|
||||||
WINEPREFIX=/your/wineprefix bash setup_dxvk.sh
|
|
||||||
cd ../x64/
|
|
||||||
WINEPREFIX=/your/wineprefix bash setup_dxvk.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
When built line by line, run:
|
|
||||||
```
|
|
||||||
cd /your/dxvk/directory/bin
|
|
||||||
WINEPREFIX=/your/wineprefix bash setup_dxvk.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
Verify that your application uses DXVK instead of wined3d by checking for the presence of the log files `d3d11.log` and `dxgi.log` in the application's directory, or by enabling the HUD (see notes below).
|
|
||||||
|
|
||||||
### Notes on Vulkan drivers
|
### Notes on Vulkan drivers
|
||||||
Before reporting an issue, please check the [Wiki](https://github.com/doitsujin/dxvk/wiki/Driver-support) page on the current driver status.
|
Before reporting an issue, please check the [Wiki](https://github.com/doitsujin/dxvk/wiki/Driver-support) page on the current driver status and make sure you run a recent enough driver version for your hardware.
|
||||||
|
|
||||||
### Online multi-player games
|
### Online multi-player games
|
||||||
Manipulation of Direct3D libraries in multi-player games may be considered cheating and can get your account **banned**. This may also apply to single-player games with an embedded or dedicated multiplayer portion. **Use at your own risk.**
|
Manipulation of Direct3D libraries in multi-player games may be considered cheating and can get your account **banned**. This may also apply to single-player games with an embedded or dedicated multiplayer portion. **Use at your own risk.**
|
||||||
|
Loading…
x
Reference in New Issue
Block a user