Skip to content

Commit 25c3e7a

Browse files
committed
deploy: a750ff1
1 parent 2ea1cfb commit 25c3e7a

File tree

11 files changed

+11
-11
lines changed

11 files changed

+11
-11
lines changed

.doctrees/bots/performance.doctree

20 Bytes
Binary file not shown.

.doctrees/bots/setup.doctree

244 Bytes
Binary file not shown.
475 Bytes
Binary file not shown.

.doctrees/environment.pickle

0 Bytes
Binary file not shown.

_sources/bots/performance.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Performance Statistics
1919
The game provides several statistics related to performance, which you can monitor and adapt your program.
2020

2121
- mainThreadUtilization - fraction (0..1) of the time the main thread does any work, vs time it sleeps.
22-
- ping - network delay measured in milliseconds.
22+
- ping - network round-trip time measured in milliseconds.
2323
- networkUp - network bandwidth use measured in KB/s, from client to game server.
2424
- networkDown - same going from game server to client.
2525

_sources/bots/setup.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The uwapi repository contains c/c++ headers for all functions and structures pro
77
Furthermore, it contains convenient wrappers for Python and C# for easy start.
88

99
.. important::
10-
Do *not* use Flatpak or Snap for Steam on Linux.
10+
Do *not* use Flatpak, or Snap, or any other containerization for Steam on Linux.
1111

1212
Steam Appid Txt
1313
---------------
@@ -23,13 +23,13 @@ You will find the ``steam_appid.txt`` in the uwapi repository.
2323
Copy it into the ``bin`` folder, next to the game executable.
2424

2525
It is recommended to remove the ``steam_appid.txt`` when you are done with your AI/bot program.
26-
Presence of the file may cause a corruption when the game is updated.
26+
Presence of the file may cause corruption of some files when the game is updated.
2727

2828
Game Install Path
2929
-----------------
3030

3131
.. important::
32-
If you installed Unnatural World in non-default location, define environment variable ``UNNATURAL_ROOT`` to the directory containing the library.
32+
If you installed Unnatural World in non-default location, define environment variable ``UNNATURAL_ROOT`` pointing to the ``bin`` directory containing the library.
3333

3434
.. tab-set::
3535
:sync-group: platform

_sources/bots/troubleshooting.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Troubleshooting
1818
Make sure that Steam is running and logged in.
1919
It must run under the same user as the program.
2020

21-
Also make sure that you have copied the steam_appid.txt file correctly.
21+
Also make sure that you have copied the :ref:`steam_appid.txt <bots/setup:Steam Appid Txt>` file correctly.
2222

2323
Do not use any containerization.
2424

bots/performance.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ <h2>Performance Statistics<a class="headerlink" href="#performance-statistics" t
286286
<p>The game provides several statistics related to performance, which you can monitor and adapt your program.</p>
287287
<ul class="simple">
288288
<li><p>mainThreadUtilization - fraction (0..1) of the time the main thread does any work, vs time it sleeps.</p></li>
289-
<li><p>ping - network delay measured in milliseconds.</p></li>
289+
<li><p>ping - network round-trip time measured in milliseconds.</p></li>
290290
<li><p>networkUp - network bandwidth use measured in KB/s, from client to game server.</p></li>
291291
<li><p>networkDown - same going from game server to client.</p></li>
292292
</ul>

bots/setup.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ <h1>Setup<a class="headerlink" href="#setup" title="Link to this heading">¶</a>
276276
Furthermore, it contains convenient wrappers for Python and C# for easy start.</p>
277277
<div class="admonition important">
278278
<p class="admonition-title">Important</p>
279-
<p>Do <em>not</em> use Flatpak or Snap for Steam on Linux.</p>
279+
<p>Do <em>not</em> use Flatpak, or Snap, or any other containerization for Steam on Linux.</p>
280280
</div>
281281
<section id="steam-appid-txt">
282282
<h2>Steam Appid Txt<a class="headerlink" href="#steam-appid-txt" title="Link to this heading"></a></h2>
@@ -291,13 +291,13 @@ <h2>Steam Appid Txt<a class="headerlink" href="#steam-appid-txt" title="Link to
291291
You will find the <code class="docutils literal notranslate"><span class="pre">steam_appid.txt</span></code> in the uwapi repository.
292292
Copy it into the <code class="docutils literal notranslate"><span class="pre">bin</span></code> folder, next to the game executable.</p>
293293
<p>It is recommended to remove the <code class="docutils literal notranslate"><span class="pre">steam_appid.txt</span></code> when you are done with your AI/bot program.
294-
Presence of the file may cause a corruption when the game is updated.</p>
294+
Presence of the file may cause corruption of some files when the game is updated.</p>
295295
</section>
296296
<section id="game-install-path">
297297
<h2>Game Install Path<a class="headerlink" href="#game-install-path" title="Link to this heading"></a></h2>
298298
<div class="admonition important">
299299
<p class="admonition-title">Important</p>
300-
<p>If you installed Unnatural World in non-default location, define environment variable <code class="docutils literal notranslate"><span class="pre">UNNATURAL_ROOT</span></code> to the directory containing the library.</p>
300+
<p>If you installed Unnatural World in non-default location, define environment variable <code class="docutils literal notranslate"><span class="pre">UNNATURAL_ROOT</span></code> pointing to the <code class="docutils literal notranslate"><span class="pre">bin</span></code> directory containing the library.</p>
301301
</div>
302302
<div class="sd-tab-set docutils">
303303
<input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio">

bots/troubleshooting.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ <h1>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to
287287
<span class="sd-summary-text">Failed to initialize Steam API</span><span class="sd-summary-state-marker sd-summary-chevron-right"><svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-right" viewBox="0 0 24 24" aria-hidden="true"><path d="M8.72 18.78a.75.75 0 0 1 0-1.06L14.44 12 8.72 6.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0Z"></path></svg></span></summary><div class="sd-summary-content sd-card-body docutils">
288288
<p class="sd-card-text">Make sure that Steam is running and logged in.
289289
It must run under the same user as the program.</p>
290-
<p class="sd-card-text">Also make sure that you have copied the steam_appid.txt file correctly.</p>
290+
<p class="sd-card-text">Also make sure that you have copied the <a class="reference internal" href="setup.html#steam-appid-txt"><span class="std std-ref">steam_appid.txt</span></a> file correctly.</p>
291291
<p class="sd-card-text">Do not use any containerization.</p>
292292
</div>
293293
</details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3">

0 commit comments

Comments
 (0)