Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

meta: Update usage section #152

Merged
merged 4 commits into from
Jan 20, 2024
Merged

meta: Update usage section #152

merged 4 commits into from
Jan 20, 2024

Conversation

jp7677
Copy link
Owner

@jp7677 jp7677 commented Jan 19, 2024

It's long overdue to update the README usage guide.
While at it, also some smaller CI changes...

@jp7677 jp7677 requested a review from Saancreed January 19, 2024 17:42
Copy link
Collaborator

@Saancreed Saancreed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We currently have in Wine section:

  • Ensure that Wine uses the native version of nvapi/nvapi64, e.g. with WINEDLLOVERRIDES=nvapi,nvapi64=n.

I think this would only be needed when Wine itself is shipping nvapi.dll that's marked as builtin and does not have "prefer native" flag. This applies only to Wine Staging versions older than 7.22 (because anything newer has Staging nvapi patchset disabled) so we might want to specify that nowadays this is generally not needed.

Otherwise, LGTM.

README.md Outdated
@@ -71,14 +61,18 @@ Wine does not includes DXVK-NVAPI.

DXVK 1.10 and older does not support `DXVK_ENABLE_NVAPI`. Disable the `nvapiHack` in DXVK 1.10 and older with `dxgi.nvapiHack = False` set in a DXVK configuration file, see [dxvk.conf](https://github.com/doitsujin/dxvk/blob/master/dxvk.conf).

### Non-NVIDIA GPUs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could refactor this section to begin with ### Using DXVK-NVAPI outside/without NVIDIA proprietary driver and then add a subsection that contains additional info about non-NVIDIA GPUs. This way we can mention what would be needed to use DXVK-NVAPI with NVK (allow other drivers + optionally driver version) and then how to spoof NV with other vendors on top of that.

## Tweaks, debugging and troubleshooting

See the [DXVK-NVAPI Wiki](https://github.com/jp7677/dxvk-nvapi/wiki) for common issues and workarounds.

The following environment variables tweak DXVK-NVAPI's runtime behavior:

- `DXVK_NVAPI_DRIVER_VERSION` lets you override the reported driver version. Valid values are numbers between 100 and 99999. Use e.g. `DXVK_NVAPI_DRIVER_VERSION=47141` to report driver version `471.41`.
- `DXVK_NVAPI_ALLOW_OTHER_DRIVERS`, when set to `1`, lets you use DXVK-NVAPI without running an NVIDIA card on NVIDIA's proprietary driver. Useful for using D3D11 extensions on a non-NVIDIA GPU.
- `DXVK_NVAPI_ALLOW_OTHER_DRIVERS`, when set to `1`, lets you use DXVK-NVAPI without running an NVIDIA card on NVIDIA's proprietary driver.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe mention that we will pretend all foreign devices to be Pascal GPUs (to avoid issues with DLSS) and changing that is (currently) not supported?

@jp7677
Copy link
Owner Author

jp7677 commented Jan 20, 2024

Thanks for the useful additions @Saancreed , I've tried to incorporated everything, please let me now if it still makes sense.

Copy link
Collaborator

@Saancreed Saancreed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jp7677 jp7677 merged commit 40e3945 into master Jan 20, 2024
2 checks passed
@jp7677 jp7677 deleted the readme-usage-updates branch January 20, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants