dzgui/docs/source/setup.rst
2026-08-16 14:22:12 +09:00

44 lines
1.5 KiB
ReStructuredText

Setup
=========
DayZ license
-----------------
Prepare a Steam account with a DayZ license (i.e., own the game). From Steam's right-click menu for the game options, under ``Compatibility``, enable a Proton version ≥ ``6.8`` (or use Proton
Experimental for the latest version).
As of this writing, any recent version of Proton should work, and it is encouraged to use the most recent one.
API keys
-------------
You will need at a minimum a :ref:`Steam Web API key<steam_api>` in order to browse the server index.
.. _steam_api:
Steam Web API key
^^^^^^^^^^^^^^^^^^
**This step is required**.
Register for a `Steam Web API key <https://steamcommunity.com/dev/apikey>`_ (free) using your Steam account. You will be asked for a unique URL for your app when registering.
Since this key is for a personal use application and does not actually call back anywhere, set a generic local identifier here like "127.0.0.1" or some other name that is meaningful to you.
Once configured, you can insert this key in the app when launching it for the first time.
.. note::
If you are confused about this requirement, please refer to DZGUI Knowledge Base article :ref:`DZG-007<DZG-007>` for additional information.
Battlemetrics API key
^^^^^^^^^^^^^^^^^^^^^^
.. warning::
This feature is no longer supported in DZGUI. Battlemetrics has switched to a paid service.
Battlemetrics queries are expected to fail in DZGUI 6. In DZGUI 7, this feature has been removed entirely.
Next steps
--------------
Proceed to the next section for usage instructions.