Skip to content

Commit

Permalink
Settings change to make the navigation collapsible
Browse files Browse the repository at this point in the history
Settings change to make the navigation Minor wording changes.
  • Loading branch information
ac-arcana committed May 25, 2024
1 parent b7ebe17 commit e9ff366
Show file tree
Hide file tree
Showing 15 changed files with 118 additions and 43 deletions.
Binary file modified docs/_build/doctrees/about.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.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: e704fcf5162fea360fecee1055cdcedd
config: 503407e6b496571be10eca61124c9202
tags: 645f666f9bcd5a90fca523b33c5a78b7
15 changes: 9 additions & 6 deletions docs/_build/html/_sources/about.rst.txt
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
About COGITO
About
============

What is COGITO?
---------------
COGITO is a first Person Immersive Sim Template Project for Godot Engine 4.
In comparison to other first person assets out there, which focus mostly on shooter mechanics, COGITO focuses on providing a framework for creating interactable objects and items.

Principals of COGITO
--------------------
Guiding Principals
------------------
The structure of this template always tries to adhere to the following principles:

* **Complete:** When you download COGITO and press play, you get a functioning project out of the box. Game menu, save slot select, options and a playable level are all included.
* **Versatile:** Wether your game is set in the future, the past or the present, uses melee, projectile or no weapons at all, has low poly, stylized or realistic graphics, the template will have features for you.
* **Modular:** Don't want to use a feature? You will be able to hide it, ignore it or strip it out without breaking COGITO. At the same time, COGITO is designed to be extendable with your own custom features or other add-ons.
* **Approachable:** While there will always be a learning curve, we strive to make COGTIO approachable and intuitive to use, so it doesn't get in your way of making your game.

Current Features of COGITO
--------------------------
Current Features
----------------
* First person player controller with:
* Sprinting, jumping, crouching, sliding, stairs handling, ladder handling
* Fully customizable attributes like Health, Stamina, Visibility (for stealth) - Component-based, so easy to add your own.
Expand Down Expand Up @@ -61,7 +61,10 @@ Thanks and Contributions
License and Credits
-------------------
* This add-on is published under the MIT license.
* You can use this add-on in your projects, personal or commercial, as long as you credit us (mostly cause I'd love to see what people use it for!)
* You can use this add-on in your projects, personal or commercial, as long as you credit us (mostly cause we'd love to see what people use it for!)

|
* About the game assets under the COGITO/assets folder:
* 3D models are by `Kenney <https://www.kenney.nl/>`_ or `Philip Drobar <https://www.philipdrobar.com/>`_.
* Audio is either by `Kenney <https://www.kenney.nl/>`_ or from `freesound.org <https://freesound.org/>`_ used under CC0 or MIT license
Expand Down
5 changes: 3 additions & 2 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ COGITO
about
tutorials

------------

.. image:: Cogito_capsule_202402_jpg.jpg
:alt: Cogito Banner

Expand All @@ -31,6 +33,5 @@ COGITO is made by `Philip Drobar <https://www.philipdrobar.com>`_ with help from

------------

! IMPORTANT
-----------
.. caution::
COGITO is still under active development. While some features are pretty much set, others might change soon. Use at your own risk and check Issues and Discussion pages for more information.
40 changes: 28 additions & 12 deletions docs/_build/html/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>About COGITO &mdash; Cogito documentation</title>
<title>About &mdash; Cogito documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />

Expand All @@ -22,6 +22,7 @@
<link rel="author" title="About these documents" href="#" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Tutorials" href="tutorials.html" />
<link rel="prev" title="COGITO" href="index.html" />
</head>

Expand All @@ -46,15 +47,24 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">About COGITO</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-is-cogito">What is COGITO?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#principals-of-cogito">Principals of COGITO</a></li>
<li class="toctree-l2"><a class="reference internal" href="#current-features-of-cogito">Current Features of COGITO</a></li>
<li class="toctree-l2"><a class="reference internal" href="#guiding-principals">Guiding Principals</a></li>
<li class="toctree-l2"><a class="reference internal" href="#current-features">Current Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="#thanks-and-contributions">Thanks and Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#license-and-credits">License and Credits</a></li>
<li class="toctree-l2"><a class="reference internal" href="#mit-license">MIT License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#videos">Videos</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#old-feature-overview">(Old) Feature Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#sliding-door-from-scratch">Sliding Door from Scratch</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#wieldables-overview">Wieldables Overview</a></li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
Expand All @@ -71,7 +81,7 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">About COGITO</li>
<li class="breadcrumb-item active">About</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/about.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand All @@ -81,15 +91,15 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="about-cogito">
<h1>About COGITO<a class="headerlink" href="#about-cogito" title="Link to this heading"></a></h1>
<section id="about">
<h1>About<a class="headerlink" href="#about" title="Link to this heading"></a></h1>
<section id="what-is-cogito">
<h2>What is COGITO?<a class="headerlink" href="#what-is-cogito" title="Link to this heading"></a></h2>
<p>COGITO is a first Person Immersive Sim Template Project for Godot Engine 4.
In comparison to other first person assets out there, which focus mostly on shooter mechanics, COGITO focuses on providing a framework for creating interactable objects and items.</p>
</section>
<section id="principals-of-cogito">
<h2>Principals of COGITO<a class="headerlink" href="#principals-of-cogito" title="Link to this heading"></a></h2>
<section id="guiding-principals">
<h2>Guiding Principals<a class="headerlink" href="#guiding-principals" title="Link to this heading"></a></h2>
<p>The structure of this template always tries to adhere to the following principles:</p>
<ul class="simple">
<li><p><strong>Complete:</strong> When you download COGITO and press play, you get a functioning project out of the box. Game menu, save slot select, options and a playable level are all included.</p></li>
Expand All @@ -98,8 +108,8 @@ <h2>Principals of COGITO<a class="headerlink" href="#principals-of-cogito" title
<li><p><strong>Approachable:</strong> While there will always be a learning curve, we strive to make COGTIO approachable and intuitive to use, so it doesn’t get in your way of making your game.</p></li>
</ul>
</section>
<section id="current-features-of-cogito">
<h2>Current Features of COGITO<a class="headerlink" href="#current-features-of-cogito" title="Link to this heading"></a></h2>
<section id="current-features">
<h2>Current Features<a class="headerlink" href="#current-features" title="Link to this heading"></a></h2>
<ul class="simple">
<li><dl class="simple">
<dt>First person player controller with:</dt><dd><ul>
Expand Down Expand Up @@ -176,7 +186,12 @@ <h2>Thanks and Contributions<a class="headerlink" href="#thanks-and-contribution
<h2>License and Credits<a class="headerlink" href="#license-and-credits" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>This add-on is published under the MIT license.</p></li>
<li><p>You can use this add-on in your projects, personal or commercial, as long as you credit us (mostly cause I’d love to see what people use it for!)</p></li>
<li><p>You can use this add-on in your projects, personal or commercial, as long as you credit us (mostly cause we’d love to see what people use it for!)</p></li>
</ul>
<div class="line-block">
<div class="line"><br /></div>
</div>
<ul class="simple">
<li><dl class="simple">
<dt>About the game assets under the COGITO/assets folder:</dt><dd><ul>
<li><p>3D models are by <a class="reference external" href="https://www.kenney.nl/">Kenney</a> or <a class="reference external" href="https://www.philipdrobar.com/">Philip Drobar</a>.</p></li>
Expand Down Expand Up @@ -221,6 +236,7 @@ <h2>MIT License<a class="headerlink" href="#mit-license" title="Link to this hea
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="COGITO" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="tutorials.html" class="btn btn-neutral float-right" title="Tutorials" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
20 changes: 18 additions & 2 deletions docs/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,24 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">About COGITO</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about.html#what-is-cogito">What is COGITO?</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#guiding-principals">Guiding Principals</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#current-features">Current Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#thanks-and-contributions">Thanks and Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#license-and-credits">License and Credits</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#mit-license">MIT License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#videos">Videos</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#old-feature-overview">(Old) Feature Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#sliding-door-from-scratch">Sliding Door from Scratch</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#wieldables-overview">Wieldables Overview</a></li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
Expand Down
35 changes: 25 additions & 10 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="About COGITO" href="about.html" />
<link rel="next" title="About" href="about.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -46,8 +46,24 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">About COGITO</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about.html#what-is-cogito">What is COGITO?</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#guiding-principals">Guiding Principals</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#current-features">Current Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#thanks-and-contributions">Thanks and Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#license-and-credits">License and Credits</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#mit-license">MIT License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#videos">Videos</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#old-feature-overview">(Old) Feature Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#sliding-door-from-scratch">Sliding Door from Scratch</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#wieldables-overview">Wieldables Overview</a></li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
Expand Down Expand Up @@ -78,25 +94,24 @@
<h1>COGITO<a class="headerlink" href="#cogito" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
</div>
<hr class="docutils" />
<img alt="Cogito Banner" src="_images/Cogito_capsule_202402_jpg.jpg" />
<a class="reference external image-reference" href="https://godotengine.org/"><img alt="Godot 4.2.1 1_stable" src="https://img.shields.io/badge/Godot_4.2.1_stable-blue?logo=godotengine&amp;logoColor=white" /></a>
<a class="reference external image-reference" href="https://github.com/Phazorknight/Cogito"><img alt="COGITO beta 202404" src="https://img.shields.io/badge/beta_202404-35A1D7?label=COGITO&amp;labelColor=0E887A" /></a>
<p>beta 202405.11</p>
<p>COGITO is made by <a class="reference external" href="https://www.philipdrobar.com">Philip Drobar</a> with help from <a class="reference external" href="https://github.com/Phazorknight/Cogito/graphs/contributors">these contributors</a>.</p>
<hr class="docutils" />
<section id="important">
<h2>! IMPORTANT<a class="headerlink" href="#important" title="Link to this heading"></a></h2>
<blockquote>
<div><p>COGITO is still under active development. While some features are pretty much set, others might change soon. Use at your own risk and check Issues and Discussion pages for more information.</p>
</div></blockquote>
</section>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>COGITO is still under active development. While some features are pretty much set, others might change soon. Use at your own risk and check Issues and Discussion pages for more information.</p>
</div>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="about.html" class="btn btn-neutral float-right" title="About COGITO" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="about.html" class="btn btn-neutral float-right" title="About" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
Binary file modified docs/_build/html/objects.inv
Binary file not shown.
20 changes: 18 additions & 2 deletions docs/_build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,24 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">About COGITO</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about.html#what-is-cogito">What is COGITO?</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#guiding-principals">Guiding Principals</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#current-features">Current Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#thanks-and-contributions">Thanks and Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#license-and-credits">License and Credits</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#mit-license">MIT License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#videos">Videos</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#old-feature-overview">(Old) Feature Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#sliding-door-from-scratch">Sliding Door from Scratch</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#wieldables-overview">Wieldables Overview</a></li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
Expand Down
Loading

0 comments on commit e9ff366

Please sign in to comment.