1
0
Fork 0
mirror of https://github.com/aclist/dztui.git synced 2025-07-03 06:18:58 +02:00

docs: update API info

This commit is contained in:
aclist 2024-07-14 22:24:48 +09:00
parent 87deb89b82
commit 5a45e20cbe
3 changed files with 17 additions and 11 deletions

View file

@ -102,11 +102,14 @@ Enable a Proton version ≥ `6.8` (or use Proton Experimental) in the `Compatibi
=== API key & server IDs
==== Steam API key (required)
1. Register for a https://steamcommunity.com/dev/apikey[Steam API key] (free) using your Steam account. You will be asked for a unique URL for your app when registering.
==== Steam Web API key (required)
1. Register for a https://steamcommunity.com/dev/apikey[Steam Web API key] (free) using your Steam account. You will be asked for a unique URL for your app when registering.
2. 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.
3. 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 https://aclist.github.io/dzgui/kb.html#DZG-007[DZG-007] for additional information.
==== BattleMetrics API key (optional)
This key is optional. Using this key in conjunction with the above allows you to also connect to and query servers by numerical ID instead of by IP. See <<Manage > Add server by ID, Add server by ID>>.