Doc updates (#68)

* Small change

Making small changes needed

* Added new pictures

Added new pictures for the Extras section and index

* Brief update

Briefly updated the mobbot page

* Small edits

Small edits to the Extras page

* Game balance

Made a lot of game balancing to make the game better and add incentives to do certain things

* Added enums

Added enums to the Enums page to give the players all the enums they will need

* Progress

Made progress in making accurate documentation

* Base updates

Added the changes needed for the docs

* New

Started new page

* doc additions

* Last photos

Added last photos for creditrs

* Final

Finalized the docs

---------

Co-authored-by: Gunnar Moody <[email protected]>

docs/build/html/_sources/credits.rst

@@ -27,10 +27,6 @@ Ian King (:blue:`Church Inc.`)
 
 .. figure:: ./_static/contributors/ian.png
 
-
-.. figure:: ./_static/contributors/ian_STYLISH.png
-   :width: 180
-
 ----
 
 
@@ -70,18 +66,20 @@ Carson Bring (:red:`Turing Co.`)
 
 .. figure:: ./_static/contributors/carson_bring.png
 
+
 ----
 
-Mason Myles (:red:`Turing Co.`)
+Carson Keeping (:blue:`Church Inc.`)
 
-.. figure:: ./_static/contributors/mason.png
+.. figure:: ./_static/contributors/carson_keeping.png
    :width: 400
 
-POV: Two weeks after working on Byte-le.
 
 ----
 
-Carson Keeping (:blue:`Church Inc.`)
+Mason Myles (:red:`Turing Co.`)
 
-.. figure:: ./_static/contributors/carson_keeping.png
+.. figure:: ./_static/contributors/mason.png
    :width: 400
+
+POV: Two weeks after working on Byte-le.

docs/build/html/_sources/extras.rst

@@ -35,3 +35,17 @@ they are rivals and absolutely despise the other. I did a good job, huh? -- Unpa
 .. figure:: ./_static/ceos/you're_fired_turing.jpg
 
 "You're fired." - CEO of :red:`Turing Co.`
+
+----
+
+Here are some extra gifs that were used in the game. Enjoy
+
+=================================================== ===================================================
+.. image:: ./_static/gifs/church_bot.gif            .. image:: ./_static/gifs/turing_bot.gif
+.. image:: ./_static/gifs/church_mobbot_damaged.gif .. image:: ./_static/gifs/turing_mobbot_damaged.gif
+.. image:: ./_static/gifs/church_mobbot_placing.gif .. image:: ./_static/gifs/turing_mobbot_placing.gif
+.. image:: ./_static/gifs/dynamite.gif              .. image:: ./_static/gifs/landmine.gif
+.. image:: ./_static/gifs/emp.gif                   .. image:: ./_static/gifs/copium.gif
+.. image:: ./_static/gifs/turite.gif                .. image:: ./_static/gifs/lambdium.gif
+.. image:: ./_static/gifs/ancient_tech.gif
+=================================================== ===================================================

docs/build/html/_sources/game_board.rst

@@ -111,6 +111,37 @@ The :doc:`placeables` page will explain everything that can be placed on the map
 the enums needed for every object that can be on the game map.
 
 
+OreOccupiableStation
+--------------------
+
+OreOccupiableStation is a class that helps store the Ores and Ancient Tech. If you would like to check if a Tile has any
+Ore or Ancient Tech, type the following:
+
+.. code-block:: python
+
+    tile.is_occupied_by_object_type(ObjectType.ORE_OCCUPIABLE_STATION)
+
+If this method returns ``True``, that means that either Copium, Lambdium, Turite, or Ancient Tech is on that Tile.
+
+If there is an OreOccupiableStation object, you can do the following to check the type of the stored material:
+
+.. code-block:: python
+
+    ore = tile.get_occupied_by(ObjectType.ORE_OCCUPIABLE_STATION)
+    isinstance(ore, Turite)
+
+In this example, the code is checking if the ore is Turite. Using the ``isinstance()`` method will return a boolean
+value indicating if the first argument is an instance of the second argument. Below is all the ways you can check for
+all materials assuming ``ore = tile.get_occupied_by(ObjectType.ORE_OCCUPIABLE_STATION)`` returned an object. Make sure
+to type these verbatim.
+
+.. code-block:: python
+
+    isinstance(ore, Copium)
+    isinstance(ore, Turite)
+    isinstance(ore, Lambdium)
+    isinstance(ore, AncientTech)
+
 Bases
 -----
 

docs/build/html/credits.html

@@ -333,9 +333,6 @@ <h2>THANK YOU!<a class="headerlink" href="#thank-you" title="Permalink to this h
 <figure class="align-default">
 <img alt="_images/ian.png" src="_images/ian.png" />
 </figure>
-<figure class="align-default">
-<a class="reference internal image-reference" href="_images/ian_STYLISH.png"><img alt="_images/ian_STYLISH.png" src="_images/ian_STYLISH.png" style="width: 180px;" /></a>
-</figure>
 <hr class="docutils" />
 <p>Brandon Gasser (<span class="blue">Church Inc.</span>)</p>
 <figure class="align-default">
@@ -362,16 +359,16 @@ <h2>THANK YOU!<a class="headerlink" href="#thank-you" title="Permalink to this h
 <img alt="_images/carson_bring.png" src="_images/carson_bring.png" />
 </figure>
 <hr class="docutils" />
-<p>Mason Myles (<span class="red">Turing Co.</span>)</p>
+<p>Carson Keeping (<span class="blue">Church Inc.</span>)</p>
 <figure class="align-default">
-<a class="reference internal image-reference" href="_images/mason.png"><img alt="_images/mason.png" src="_images/mason.png" style="width: 400px;" /></a>
+<a class="reference internal image-reference" href="_images/carson_keeping.png"><img alt="_images/carson_keeping.png" src="_images/carson_keeping.png" style="width: 400px;" /></a>
 </figure>
-<p>POV: Two weeks after working on Byte-le.</p>
 <hr class="docutils" />
-<p>Carson Keeping (<span class="blue">Church Inc.</span>)</p>
+<p>Mason Myles (<span class="red">Turing Co.</span>)</p>
 <figure class="align-default">
-<a class="reference internal image-reference" href="_images/carson_keeping.png"><img alt="_images/carson_keeping.png" src="_images/carson_keeping.png" style="width: 400px;" /></a>
+<a class="reference internal image-reference" href="_images/mason.png"><img alt="_images/mason.png" src="_images/mason.png" style="width: 400px;" /></a>
 </figure>
+<p>POV: Two weeks after working on Byte-le.</p>
 </section>
 </section>
 

docs/build/html/extras.html

@@ -338,6 +338,46 @@ <h1>Extras<a class="headerlink" href="#extras" title="Permalink to this heading"
 <img alt="_images/you%27re_fired_turing.jpg" src="_images/you%27re_fired_turing.jpg" />
 </figure>
 <p>“You’re fired.” - CEO of <span class="red">Turing Co.</span></p>
+<hr class="docutils" />
+<p>Here are some extra gifs that were used in the game. Enjoy</p>
+<table class="table">
+<tbody>
+<tr class="row-odd"><td><img alt="_images/church_bot.gif" src="_images/church_bot.gif" />
+</td>
+<td><img alt="_images/turing_bot.gif" src="_images/turing_bot.gif" />
+</td>
+</tr>
+<tr class="row-even"><td><img alt="_images/church_mobbot_damaged.gif" src="_images/church_mobbot_damaged.gif" />
+</td>
+<td><img alt="_images/turing_mobbot_damaged.gif" src="_images/turing_mobbot_damaged.gif" />
+</td>
+</tr>
+<tr class="row-odd"><td><img alt="_images/church_mobbot_placing.gif" src="_images/church_mobbot_placing.gif" />
+</td>
+<td><img alt="_images/turing_mobbot_placing.gif" src="_images/turing_mobbot_placing.gif" />
+</td>
+</tr>
+<tr class="row-even"><td><img alt="_images/dynamite.gif" src="_images/dynamite.gif" />
+</td>
+<td><img alt="_images/landmine.gif" src="_images/landmine.gif" />
+</td>
+</tr>
+<tr class="row-odd"><td><img alt="_images/emp.gif" src="_images/emp.gif" />
+</td>
+<td><img alt="_images/copium.gif" src="_images/copium.gif" />
+</td>
+</tr>
+<tr class="row-even"><td><img alt="_images/turite.gif" src="_images/turite.gif" />
+</td>
+<td><img alt="_images/lambdium.gif" src="_images/lambdium.gif" />
+</td>
+</tr>
+<tr class="row-odd"><td><img alt="_images/ancient_tech.gif" src="_images/ancient_tech.gif" />
+</td>
+<td></td>
+</tr>
+</tbody>
+</table>
 </section>
 
 

docs/build/html/game_board.html

@@ -312,6 +312,7 @@ <h2> Contents </h2>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#coordinates">Coordinates</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#occupied-by">Occupied_by</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#is-occupied-by-and-get-occupied-by">Is_occupied_by and get_occupied_by</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#oreoccupiablestation">OreOccupiableStation</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#bases">Bases</a></li>
 </ul>
 </li>
@@ -397,6 +398,30 @@ <h3>Is_occupied_by and get_occupied_by<a class="headerlink" href="#is-occupied-b
 <p>The <a class="reference internal" href="placeables.html"><span class="doc">Placeables</span></a> page will explain everything that can be placed on the map by MOB-BOT, and <a class="reference internal" href="enums.html"><span class="doc">Enums</span></a> will have
 the enums needed for every object that can be on the game map.</p>
 </section>
+<section id="oreoccupiablestation">
+<h3>OreOccupiableStation<a class="headerlink" href="#oreoccupiablestation" title="Permalink to this heading">#</a></h3>
+<p>OreOccupiableStation is a class that helps store the Ores and Ancient Tech. If you would like to check if a Tile has any
+Ore or Ancient Tech, type the following:</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tile</span><span class="o">.</span><span class="n">is_occupied_by_object_type</span><span class="p">(</span><span class="n">ObjectType</span><span class="o">.</span><span class="n">ORE_OCCUPIABLE_STATION</span><span class="p">)</span>
+</pre></div>
+</div>
+<p>If this method returns <code class="docutils literal notranslate"><span class="pre">True</span></code>, that means that either Copium, Lambdium, Turite, or Ancient Tech is on that Tile.</p>
+<p>If there is an OreOccupiableStation object, you can do the following to check the type of the stored material:</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">ore</span> <span class="o">=</span> <span class="n">tile</span><span class="o">.</span><span class="n">get_occupied_by</span><span class="p">(</span><span class="n">ObjectType</span><span class="o">.</span><span class="n">ORE_OCCUPIABLE_STATION</span><span class="p">)</span>
+<span class="nb">isinstance</span><span class="p">(</span><span class="n">ore</span><span class="p">,</span> <span class="n">Turite</span><span class="p">)</span>
+</pre></div>
+</div>
+<p>In this example, the code is checking if the ore is Turite. Using the <code class="docutils literal notranslate"><span class="pre">isinstance()</span></code> method will return a boolean
+value indicating if the first argument is an instance of the second argument. Below is all the ways you can check for
+all materials assuming <code class="docutils literal notranslate"><span class="pre">ore</span> <span class="pre">=</span> <span class="pre">tile.get_occupied_by(ObjectType.ORE_OCCUPIABLE_STATION)</span></code> returned an object. Make sure
+to type these verbatim.</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nb">isinstance</span><span class="p">(</span><span class="n">ore</span><span class="p">,</span> <span class="n">Copium</span><span class="p">)</span>
+<span class="nb">isinstance</span><span class="p">(</span><span class="n">ore</span><span class="p">,</span> <span class="n">Turite</span><span class="p">)</span>
+<span class="nb">isinstance</span><span class="p">(</span><span class="n">ore</span><span class="p">,</span> <span class="n">Lambdium</span><span class="p">)</span>
+<span class="nb">isinstance</span><span class="p">(</span><span class="n">ore</span><span class="p">,</span> <span class="n">AncientTech</span><span class="p">)</span>
+</pre></div>
+</div>
+</section>
 <section id="bases">
 <h3>Bases<a class="headerlink" href="#bases" title="Permalink to this heading">#</a></h3>
 <p>Each team will have a base on the map. Their base will match their MOB-BOT and company color.</p>
@@ -499,6 +524,7 @@ <h2>Mining Interactions<a class="headerlink" href="#mining-interactions" title="
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#coordinates">Coordinates</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#occupied-by">Occupied_by</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#is-occupied-by-and-get-occupied-by">Is_occupied_by and get_occupied_by</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#oreoccupiablestation">OreOccupiableStation</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#bases">Bases</a></li>
 </ul>
 </li>

docs/source/credits.rst

@@ -27,10 +27,6 @@ Ian King (:blue:`Church Inc.`)
 
 .. figure:: ./_static/contributors/ian.png
 
-
-.. figure:: ./_static/contributors/ian_STYLISH.png
-   :width: 180
-
 ----
 
 
@@ -70,18 +66,20 @@ Carson Bring (:red:`Turing Co.`)
 
 .. figure:: ./_static/contributors/carson_bring.png
 
+
 ----
 
-Mason Myles (:red:`Turing Co.`)
+Carson Keeping (:blue:`Church Inc.`)
 
-.. figure:: ./_static/contributors/mason.png
+.. figure:: ./_static/contributors/carson_keeping.png
    :width: 400
 
-POV: Two weeks after working on Byte-le.
 
 ----
 
-Carson Keeping (:blue:`Church Inc.`)
+Mason Myles (:red:`Turing Co.`)
 
-.. figure:: ./_static/contributors/carson_keeping.png
+.. figure:: ./_static/contributors/mason.png
    :width: 400
+
+POV: Two weeks after working on Byte-le.

docs/source/extras.rst

@@ -35,3 +35,17 @@ they are rivals and absolutely despise the other. I did a good job, huh? -- Unpa
 .. figure:: ./_static/ceos/you're_fired_turing.jpg
 
 "You're fired." - CEO of :red:`Turing Co.`
+
+----
+
+Here are some extra gifs that were used in the game. Enjoy
+
+=================================================== ===================================================
+.. image:: ./_static/gifs/church_bot.gif            .. image:: ./_static/gifs/turing_bot.gif
+.. image:: ./_static/gifs/church_mobbot_damaged.gif .. image:: ./_static/gifs/turing_mobbot_damaged.gif
+.. image:: ./_static/gifs/church_mobbot_placing.gif .. image:: ./_static/gifs/turing_mobbot_placing.gif
+.. image:: ./_static/gifs/dynamite.gif              .. image:: ./_static/gifs/landmine.gif
+.. image:: ./_static/gifs/emp.gif                   .. image:: ./_static/gifs/copium.gif
+.. image:: ./_static/gifs/turite.gif                .. image:: ./_static/gifs/lambdium.gif
+.. image:: ./_static/gifs/ancient_tech.gif
+=================================================== ===================================================

docs/source/game_board.rst

@@ -111,6 +111,37 @@ The :doc:`placeables` page will explain everything that can be placed on the map
 the enums needed for every object that can be on the game map.
 
 
+OreOccupiableStation
+--------------------
+
+OreOccupiableStation is a class that helps store the Ores and Ancient Tech. If you would like to check if a Tile has any
+Ore or Ancient Tech, type the following:
+
+.. code-block:: python
+
+    tile.is_occupied_by_object_type(ObjectType.ORE_OCCUPIABLE_STATION)
+
+If this method returns ``True``, that means that either Copium, Lambdium, Turite, or Ancient Tech is on that Tile.
+
+If there is an OreOccupiableStation object, you can do the following to check the type of the stored material:
+
+.. code-block:: python
+
+    ore = tile.get_occupied_by(ObjectType.ORE_OCCUPIABLE_STATION)
+    isinstance(ore, Turite)
+
+In this example, the code is checking if the ore is Turite. Using the ``isinstance()`` method will return a boolean
+value indicating if the first argument is an instance of the second argument. Below is all the ways you can check for
+all materials assuming ``ore = tile.get_occupied_by(ObjectType.ORE_OCCUPIABLE_STATION)`` returned an object. Make sure
+to type these verbatim.
+
+.. code-block:: python
+
+    isinstance(ore, Copium)
+    isinstance(ore, Turite)
+    isinstance(ore, Lambdium)
+    isinstance(ore, AncientTech)
+
 Bases
 -----