Skip to content

Commit

Permalink
README and documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@dimi309
dimi309 committed Oct 21, 2024
1 parent 66f17fc commit 144a145
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 38 deletions.
28 changes: 13 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,32 @@ and the use of cutting edge methods and technologies.

*Mobile devices are no longer supported. Please read further below for details.*

# Games
# First Little Games

## First little games
## Avoid the Bug

Avoid the Bug
[![AvoidTheBug](img/avoidthebug.png)](https://github.com/dimi309/small3d-first-games/tree/master/avoidthebug)

![AvoidTheBug](img/avoidthebug.png)

## Chase the Goat

Chase the Goat
[![ChaseTheGoat](img/chasethegoat.png)](https://github.com/dimi309/small3d-first-games/tree/master/chasethegoat)

![ChaseTheGoat](img/chasethegoat.png)
## Frog Remixed

Frog Remixed

![FrogRemixed](img/frogremixed.png)
[![FrogRemixed](img/frogremixed.png)](https://github.com/dimi309/small3d-first-games/tree/master/frogremixed)

All of the above can be found here: https://github.com/dimi309/small3d-first-games

## More "evolved" titles

[Gloom](https://github.com/dimi309/gloom) (open source)
# More "Evolved" Titles
## Gloom (open source)

![Gloom](img/gloom.png)
[![Gloom](img/gloom.png)](https://github.com/dimi309/gloom)

[Islet Hell](https://store.steampowered.com/app/2069750/Islet_Hell/) (once commercially released, now free of charge)
## Islet Hell (once commercially released, now free of charge)

![IsletHell](img/islethell.png)
[![IsletHell](img/islethell.png)](https://store.steampowered.com/app/2069750/Islet_Hell/)

# Non-game project

Expand Down
49 changes: 26 additions & 23 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,28 +72,31 @@
<p>This library provides a sufficient level of game development functionalities for C++ developers to be able to build cross-platform games based on a single code-base. Supporting as many platforms as possible while minimising the amount of code and time needed for maintenance is favoured over richness of features and the use of cutting edge methods and technologies.</p>
<p><em>Mobile devices are no longer supported. Please read further below for details.</em></p>
<h1><a class="anchor" id="autotoc_md1"></a>
Games</h1>
First Little Games</h1>
<h2><a class="anchor" id="autotoc_md2"></a>
First little games</h2>
<p>Avoid the Bug</p>
<p><img src="avoidthebug.png" alt="" class="inline" title="AvoidTheBug"/> </p>
<p>Chase the Goat</p>
<p><img src="chasethegoat.png" alt="" class="inline" title="ChaseTheGoat"/> </p>
<p>Frog Remixed</p>
<p><img src="frogremixed.png" alt="" class="inline" title="FrogRemixed"/> </p>
<p>All of the above can be found here: <a href="https://github.com/dimi309/small3d-first-games">https://github.com/dimi309/small3d-first-games</a></p>
Avoid the Bug</h2>
<p><a href="https://github.com/dimi309/small3d-first-games/tree/master/avoidthebug"><img src="avoidthebug.png" alt="" class="inline" title="AvoidTheBug"/> </a></p>
<h2><a class="anchor" id="autotoc_md3"></a>
More "evolved" titles</h2>
<p><a href="https://github.com/dimi309/gloom">Gloom</a> (open source)</p>
<p><img src="gloom.png" alt="" class="inline" title="Gloom"/> </p>
<p><a href="https://store.steampowered.com/app/2069750/Islet_Hell/">Islet Hell</a> (once commercially released, now free of charge)</p>
<p><img src="islethell.png" alt="" class="inline" title="IsletHell"/> </p>
<h1><a class="anchor" id="autotoc_md4"></a>
Chase the Goat</h2>
<p><a href="https://github.com/dimi309/small3d-first-games/tree/master/chasethegoat"><img src="chasethegoat.png" alt="" class="inline" title="ChaseTheGoat"/> </a></p>
<h2><a class="anchor" id="autotoc_md4"></a>
Frog Remixed</h2>
<p><a href="https://github.com/dimi309/small3d-first-games/tree/master/frogremixed"><img src="frogremixed.png" alt="" class="inline" title="FrogRemixed"/> </a></p>
<p>All of the above can be found here: <a href="https://github.com/dimi309/small3d-first-games">https://github.com/dimi309/small3d-first-games</a></p>
<h1><a class="anchor" id="autotoc_md5"></a>
More "Evolved" Titles</h1>
<h2><a class="anchor" id="autotoc_md6"></a>
Gloom (open source)</h2>
<p><a href="https://github.com/dimi309/gloom"><img src="gloom.png" alt="" class="inline" title="Gloom"/> </a></p>
<h2><a class="anchor" id="autotoc_md7"></a>
Islet Hell (once commercially released, now free of charge)</h2>
<p><a href="https://store.steampowered.com/app/2069750/Islet_Hell/"><img src="islethell.png" alt="" class="inline" title="IsletHell"/> </a></p>
<h1><a class="anchor" id="autotoc_md8"></a>
Non-game project</h1>
<ul>
<li><a href="https://github.com/dimi309/serial-model-renderer">Serial Model Renderer</a>, used to test the 3D model reading and rendering functionality of <a class="el" href="namespacesmall3d.html">small3d</a></li>
</ul>
<h1><a class="anchor" id="autotoc_md5"></a>
<h1><a class="anchor" id="autotoc_md9"></a>
Features</h1>
<ul>
<li>3D models loaded from glTF (glb files), Wavefront (obj files) or from a native format</li>
Expand All @@ -109,14 +112,14 @@ <h1><a class="anchor" id="autotoc_md5"></a>
<li>Frame-based animation (Wavefront)</li>
<li>Skeletal animation (glTF)</li>
</ul>
<h1><a class="anchor" id="autotoc_md6"></a>
<h1><a class="anchor" id="autotoc_md10"></a>
Limitations</h1>
<ul>
<li>Non-PNG images are not supported.</li>
<li>There are no scenes, just SceneObjects rendered in an infinite space.</li>
<li>The 3D model parsers are far from feature-complete but pretty robust nonetheless. The goal is not to be able to read a complete node structure from a gltf file for example, but to extract individual models and their animations, in order to use them in a game.</li>
</ul>
<h1><a class="anchor" id="autotoc_md7"></a>
<h1><a class="anchor" id="autotoc_md11"></a>
Supported platforms</h1>
<ul>
<li>Windows</li>
Expand All @@ -132,20 +135,20 @@ <h1><a class="anchor" id="autotoc_md7"></a>
<p><a href="https://github.com/dimi309/small3d/releases/tag/1.8016.last.mobile">https://github.com/dimi309/small3d/releases/tag/1.8016.last.mobile</a></p>
<p>You could also just use the <a class="el" href="namespacesmall3d.html">small3d</a> boilerplate project which is set to reference the abovementioned version:</p>
<p><a href="https://github.com/dimi309/small3d-boilerplate">https://github.com/dimi309/small3d-boilerplate</a></p>
<h1><a class="anchor" id="autotoc_md8"></a>
<h1><a class="anchor" id="autotoc_md12"></a>
Tutorial</h1>
<p><a href="https://www.gamedev.net/tutorials/programming/engines-and-middleware/small3d-tutorial-r5655/">https://www.gamedev.net/tutorials/programming/engines-and-middleware/small3d-tutorial-r5655/</a></p>
<h1><a class="anchor" id="autotoc_md9"></a>
<h1><a class="anchor" id="autotoc_md13"></a>
Building and deploying</h1>
<h2><a class="anchor" id="autotoc_md10"></a>
<h2><a class="anchor" id="autotoc_md14"></a>
Prerequisites</h2>
<p>The following need to be installed, with the relevant environment variables and tools accessible via the command line:</p>
<ul>
<li>Some compiler (e.g. gcc, Visual Studio, clang) with C++17 support recommended as a minimum.</li>
<li>7zip (only on Windows)</li>
<li>CMake</li>
</ul>
<h2><a class="anchor" id="autotoc_md11"></a>
<h2><a class="anchor" id="autotoc_md15"></a>
Deploying small3d</h2>
<p>Run the build script which is suitable to your platform from the <code>scripts</code> directory (<code>build-vs.bat</code>, <code>build-mingw.bat</code> or <code>build.sh</code>).</p>
<p>Then, the unit tests are executed by running <code>unittests</code> binary from <code>build/bin</code>.</p>
Expand All @@ -158,7 +161,7 @@ <h2><a class="anchor" id="autotoc_md11"></a>
<li>The <code>small3d/cmake</code> directory if you will be using cmake</li>
</ul>
<p>You can also deploy using <a href="https://conan.io">conan</a>. The conan package is provided in a <a href="https://github.com/dimi309/small3d-conan">separate repository</a>.</p>
<h1><a class="anchor" id="autotoc_md12"></a>
<h1><a class="anchor" id="autotoc_md16"></a>
Referenced libraries</h1>
<p>The following dependencies' <em>source code</em> repositories (not binaries) are distributed in this same repository (in the <code>deps</code> directory). They can be built by executing a single script (see "Building", above) and they can also be used directly in your application / game code.</p>
<ul>
Expand Down

0 comments on commit 144a145

Please sign in to comment.