mirror of
https://github.com/ValveSoftware/Proton.git
synced 2024-12-27 23:25:50 +03:00
README.md: A couple doc changes
This commit is contained in:
Andrew Eikum
parent
2aa231df0f
commit
cf00ea197d
66
README.md
66
README.md
@ -22,23 +22,24 @@ We strongly recommend that most users use the production build of Proton.
|
||||
Obtaining Proton
|
||||
---
|
||||
The most current source for Proton is here:
|
||||
<https://TODO>
|
||||
<https://github.com/ValveSoftware/Proton>
|
||||
|
||||
Which you can clone to your system with this command:
|
||||
|
||||
git clone TODO
|
||||
git clone https://github.com/ValveSoftware/Proton.git proton
|
||||
|
||||
If you clone the Proton git repository, the next step will be to
|
||||
After cloning the Proton git repository, the next step will be to
|
||||
obtain the various submodules that go into building Proton:
|
||||
|
||||
cd proton
|
||||
git submodule init
|
||||
git submodule update
|
||||
#for linux:
|
||||
git submodule update --init wine dxvk
|
||||
#for macos:
|
||||
git submodule update --init
|
||||
|
||||
If you wish to change any subcomponent, now is the time to do so.
|
||||
For example, if you wish to use an alternate version of Wine, you would
|
||||
now put that version in place in the wine/ directory in place of the
|
||||
version that Proton is currently using.
|
||||
For example, if you wish make changes to Wine, you would apply those
|
||||
changes to the <tt>wine/</tt> directory.
|
||||
|
||||
---
|
||||
Building for Linux
|
||||
@ -49,19 +50,15 @@ documented in the Steam Runtime repository:
|
||||
<https://github.com/ValveSoftware/steam-runtime>
|
||||
|
||||
In addition, you will need to install gcc-5 and a long list of dependencies
|
||||
required for Wine.
|
||||
required for Wine. The following set of commands is an example session, and may
|
||||
not be complete.
|
||||
|
||||
The following set of commands is an example session, and may not be
|
||||
complete. It is important to examine the output near the end of
|
||||
build/wine.win{64,32}/config.log to ensure that you have all of the
|
||||
relevant libraries in each chroot. Search for 'executing Makefile commands'
|
||||
in config.log. It is normal to be missing a few libraries, including
|
||||
OpenCL, OSS, and XAudio2.
|
||||
|
||||
cd
|
||||
cd ~
|
||||
git clone https://github.com/ValveSoftware/steam-runtime.git
|
||||
cd steam-runtime
|
||||
#install the 32-bit scout_beta runtime:
|
||||
./setup_chroot.sh --beta --i386
|
||||
#enter the 32-bit runtime:
|
||||
schroot --chroot steamrt_scout_beta_i386
|
||||
|
||||
This will enter the chroot environment, where you would issue the following commands:
|
||||
@ -87,13 +84,17 @@ Finally, change your directory back to proton, and run:
|
||||
cd ../proton
|
||||
./build_proton.sh
|
||||
|
||||
That should configure and build a variety of sub modules, including Wine, and
|
||||
then package the result up into dist/.
|
||||
That should configure and build Wine, and then package the result up into
|
||||
<tt>dist/</tt>. It is important to examine the output near the end of
|
||||
<tt>build/wine.win{64,32}/config.log</tt> to ensure that you have all of the relevant
|
||||
libraries in each chroot. Search for '<tt>executing Makefile commands</tt>' in
|
||||
<tt>config.log</tt> to find messages about missing libraries. It is normal to be missing
|
||||
a few libraries, including OpenCL, OSS, and libav.
|
||||
|
||||
**NOTE:** For now, dxvk requires build-time components that are too new for Debian
|
||||
9. It's recommended to build the DLLs on Arch Linux, where dxvk is actively
|
||||
being developed. This may be resolved in dxvk in the future, or may be worked
|
||||
around by using a newer Debian release. See comments in build_proton.sh.
|
||||
**NOTE:** For now, dxvk requires build-time components that are too new for
|
||||
Debian 9. It's recommended to build the DLLs on Arch Linux, where dxvk is
|
||||
actively being developed. This may be resolved in dxvk in the future, or may
|
||||
be worked around by using a newer Debian release. See comments in <tt>build_proton.sh</tt>.
|
||||
|
||||
---
|
||||
Building for macOS
|
||||
@ -107,21 +108,21 @@ use a packager like Homebrew to find these packages. Then run:
|
||||
TODO - Surely there are other dependencies we have not listed there.
|
||||
|
||||
It is important to examine the output near the end of
|
||||
build/wine.win{64,32}/config.log to ensure that you have all of the
|
||||
<tt>build/wine.win{64,32}/config.log</tt> to ensure that you have all of the
|
||||
relevant libraries required to build Wine properly.
|
||||
|
||||
---
|
||||
Deploying
|
||||
---
|
||||
Once built, the dist/ directory will contain the files which can be distributed
|
||||
Once built, the <tt>dist/</tt> directory will contain the files which can be distributed
|
||||
through Steam. For testing purposes, you should be able to clear out the files
|
||||
in your steamapps/common/Proton directory and replace them with the contents of
|
||||
dist/. The proton script will unpack the files on first run. Note that if you
|
||||
in your <tt>steamapps/common/Proton</tt> directory and replace them with the contents of
|
||||
<tt>dist/</tt>. The <tt>proton</tt> script will unpack the files on first run. Note that if you
|
||||
use the Steam client to verify local files, it will restore the production version
|
||||
of Proton.
|
||||
|
||||
Each component of this software is used under the terms of their licenses.
|
||||
See the LICENSE files here, as well as the LICENSE, COPYING, etc files in each
|
||||
See the <tt>LICENSE</tt> files here, as well as the <tt>LICENSE</tt>, <tt>COPYING</tt>, etc files in each
|
||||
submodule and directory for details.
|
||||
|
||||
|
||||
@ -129,7 +130,7 @@ submodule and directory for details.
|
||||
Runtime Config Options
|
||||
----
|
||||
Proton can be tuned at runtime to help certain games run. Options can either
|
||||
be defined in a comma-separated list stored in the STEAM_COMPAT_CONFIG
|
||||
be defined in a comma-separated list stored in the <tt>STEAM_COMPAT_CONFIG</tt>
|
||||
environment variable when running Proton (the Steam client does this),
|
||||
or passed through the presence of individual environment variables as documented below.
|
||||
|
||||
@ -137,9 +138,8 @@ All of the below are runtime options. They do not effect permanent changes to
|
||||
the Wine prefix. Removing the option will revert to the previous behavior.
|
||||
|
||||
| Compat config string | Environment Variable | Description |
|
||||
| :-------------------- | :-------------------- | :----------- |
|
||||
| dxvk | PROTON_USE_DXVK | Run the game with DXVK instead of wined3d. |
|
||||
| nod3d11 | PROTON_NO_D3D11 | Disable d3d11.dll, for games which can fall
|
||||
back to and run better with d3d9. |
|
||||
| :-------------------- | :----------------------------- | :----------- |
|
||||
| <tt>dxvk</tt> | <tt>PROTON_USE_DXVK</tt> | Run the game with DXVK instead of wined3d. |
|
||||
| <tt>nod3d11</tt> | <tt>PROTON_NO_D3D11</tt> | Disable <tt>d3d11.dll</tt>, for games which can fall back to and run better with d3d9. |
|
||||
|
||||
<!-- Target: GitHub Flavor Markdown. To test locally: pandoc -f markdown_github -t html README.md -->
|
||||
|
||||
Loading…
Reference in New Issue
Block a user