Skip to content

Commit

Permalink
Deploying to gh-pages from @ b31b75a 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mwydmuch committed Dec 16, 2023
1 parent 91e1ab3 commit a91852b
Show file tree
Hide file tree
Showing 30 changed files with 859 additions and 595 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7a9cb42fa77fdd09e131745aa5ad6662
config: 6eabbbb39bb71b0cab5ca0f16830f659
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
2 changes: 1 addition & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@
</div>
<article role="main">

<section id="page-not-found">
<section class="tex2jax_ignore mathjax_ignore" id="page-not-found">
<h1>404 - Page Not Found<a class="headerlink" href="#page-not-found" title="Link to this heading">#</a></h1>
<section id="the-requested-page-could-not-be-found">
<h2>The requested page could not be found.<a class="headerlink" href="#the-requested-page-could-not-be-found" title="Link to this heading">#</a></h2>
Expand Down
2 changes: 1 addition & 1 deletion README/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@
</div>
<article role="main">

<section id="vizdoom-documentation">
<section class="tex2jax_ignore mathjax_ignore" id="vizdoom-documentation">
<h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" title="Link to this heading">#</a></h1>
<p>This directory contains the documentation for ViZDOOm.</p>
<p>For more information about how to contribute to the documentation go to our <a class="reference external" href="https://github.com/Farama-Foundation/Celshast/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a></p>
Expand Down
16 changes: 8 additions & 8 deletions api/configurationFiles/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -310,12 +310,12 @@
</div>
<article role="main">

<section id="configuration-files">
<section class="tex2jax_ignore mathjax_ignore" id="configuration-files">
<h1>Configuration files<a class="headerlink" href="#configuration-files" title="Link to this heading">#</a></h1>
<p>Instead of configuring the ViZDoom in code, you can load it from the configuration file(s). Each file is read sequentially, so multiple entries with the same key will overwrite previous entries.</p>
<section id="format">
<h2>Format<a class="headerlink" href="#format" title="Link to this heading">#</a></h2>
<p>Each entry in a configraution file is a pair of <strong>key</strong> and <strong>value</strong> separated by an equal sign (<strong>“=”</strong>). The file format should also abide the following rules:</p>
<p>Each entry in a configraution file is a pair of <strong>key</strong> and <strong>value</strong> separated by an equal sign (<strong><code class="docutils literal notranslate"><span class="pre">=</span></code></strong>). The file format should also abide the following rules:</p>
<ul class="simple">
<li><p>one entry per line (except for list parameters),</p></li>
<li><p>case insensitive</p></li>
Expand All @@ -326,11 +326,11 @@ <h2>Format<a class="headerlink" href="#format" title="Link to this heading">#</a
<p>A violation of any of these rules will result in ignoring <strong>only</strong> the line with the error and sending a warning message to stderr (“WARNING! Loading config from: …”).</p>
<section id="list-of-values">
<h3>List of values<a class="headerlink" href="#list-of-values" title="Link to this heading">#</a></h3>
<p><strong>available_buttons</strong> and <strong>available_game_variables</strong> are special parameters, which use multiple values and instead of a single value they expect a list of values separated by whitespaces and enclosed within braces (“{” and “}”). The list can stretch throughout multiple lines as long as all values are separated from each other by whitespaces.</p>
<p><strong>available_buttons</strong> and <strong>available_game_variables</strong> are special parameters, which use multiple values and instead of a single value they expect a list of values separated by whitespaces and enclosed within braces (<code class="docutils literal notranslate"><span class="pre">{</span></code> and <code class="docutils literal notranslate"><span class="pre">}</span></code>). The list can stretch throughout multiple lines as long as all values are separated from each other by whitespaces.</p>
</section>
<section id="appending-values">
<h3>Appending values<a class="headerlink" href="#appending-values" title="Link to this heading">#</a></h3>
<p>Each list assignment (<strong>KEY = { VALUES }</strong>)clears values specified for this key before (in other configuration files or in the code). That is why the *<em>append operator(<em>KEY += { VALUES })</em></em> is available. This way you can more easily combine multiple configuration files and tinker in code.</p>
<p>Each list assignment (<strong><code class="docutils literal notranslate"><span class="pre">KEY</span> <span class="pre">=</span> <span class="pre">{</span> <span class="pre">VALUES</span> <span class="pre">}</span></code></strong>)clears values specified for this key before (in other configuration files or in the code). That is why the <strong>append operator (<code class="docutils literal notranslate"><span class="pre">KEY</span> <span class="pre">+=</span> <span class="pre">{</span> <span class="pre">VALUES</span> <span class="pre">}</span></code>)</strong> is available. This way you can more easily combine multiple configuration files and tinker in code.</p>
</section>
<section id="supported-configuration-keys">
<h3>Supported configuration keys:<a class="headerlink" href="#supported-configuration-keys" title="Link to this heading">#</a></h3>
Expand All @@ -342,8 +342,8 @@ <h3>Supported configuration keys:<a class="headerlink" href="#supported-configur
<li><p><code class="docutils literal notranslate"><span class="pre">automapMode/automap_mode</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">automapRenderTextures/automap_render_textures</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">automapRotate/automap_rotate</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">availableButtons/available_buttons</span></code> (list)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">availableGameVariables/available_game_variables</span></code> (list)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">availableButtons/available_buttons</span></code> (list of values)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">availableGameVariables/available_game_variables</span></code> (list of values)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">consoleEnabled/console_enabled</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">deathPenalty/death_penalty</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">depthBufferEnabled/depth_buffer_enabled</span></code></p></li>
Expand Down Expand Up @@ -379,7 +379,7 @@ <h3>Supported configuration keys:<a class="headerlink" href="#supported-configur
<li><p><code class="docutils literal notranslate"><span class="pre">ViZDoomPath/vizdoom_path</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">windowVisible/window_visible</span></code></p></li>
</ul>
<p>See also: <a class="reference internal" href="#DoomGame.md"><span class="xref myst"><code class="docutils literal notranslate"><span class="pre">DoomGame</span></code></span></a> for config keys and functions related to them.</p>
<p>Config keys are also mentioned for related methods in the documentation for <code class="docutils literal notranslate"><span class="pre">DoomGame</span></code> class.</p>
</section>
<section id="sample-configuration-file-content">
<h3>Sample configuration file content:<a class="headerlink" href="#sample-configuration-file-content" title="Link to this heading">#</a></h3>
Expand Down Expand Up @@ -426,7 +426,7 @@ <h3>Sample configuration file content:<a class="headerlink" href="#sample-config
<span class="na">doom_skill</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">5</span>
</pre></div>
</div>
<p>Other examples of configuration files can be found in <a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/master/scenarios">https://github.com/Farama-Foundation/ViZDoom/tree/master/scenarios</a></p>
<p>Other examples of configuration files can be found in <a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/master/scenarios">scenarios</a> directory.</p>
</section>
</section>
</section>
Expand Down
Loading

0 comments on commit a91852b

Please sign in to comment.