update of the docs

Author: jube

01-beginner/code/sokoban01.cc

@@ -1,3 +1,4 @@
+#include <algorithm>
 #include <vector>
 
 #include <gf/Array2D.h>
@@ -9,8 +10,12 @@
 #include <gf/Vector.h>
 #include <gf/Window.h>
 
+// tag::ns[]
 namespace skb {
 
+// end::ns[]
+
+  // tag::data[]
   const char LevelData[] = {
     "  #####"
     "###@ .#"
@@ -23,10 +28,17 @@ namespace skb {
 
   constexpr gf::Vector2i LevelSize = gf::vec(7, 7);
 
+  // end::data[]
+
+  // tag::hero[]
   struct Hero {
     gf::Vector2i position;
   };
 
+  // end::hero[]
+
+
+  // tag::make_hero[]
   Hero makeHero(gf::Span<const char> data, gf::Vector2i size) {
     Hero hero = { gf::vec(0, 0) };
     gf::Vector2i position = gf::vec(0, 0);
@@ -47,6 +59,8 @@ namespace skb {
     return hero;
   }
 
+  // end::make_hero[]
+
   struct Boxes {
     std::vector<gf::Vector2i> positions;
 
@@ -124,6 +138,8 @@ namespace skb {
         case '#':
           level.blocks(position) = Block::Wall;
           break;
+        case '\0':
+          break;
         default:
           assert(false);
           break;
@@ -140,7 +156,9 @@ namespace skb {
     return level;
   }
 
+// tag::ns[]
 }
+// end::ns[]
 
 
 int main() {
@@ -193,6 +211,12 @@ int main() {
           if (level.blocks(behind) != skb::Wall && !boxes.hasBox(behind)) {
             hero.position = target;
             boxes.changeBox(target, behind);
+
+            if (std::all_of(boxes.positions.begin(), boxes.positions.end(), [&level](gf::Vector2i coordinates) {
+              return level.blocks(coordinates) == skb::Block::Goal;
+            })) {
+              return 0;
+            }
           }
         } else {
           hero.position = target;

advanced.adoc

@@ -4,5 +4,12 @@ v0.1
 :toc:
 :homepage: https://gamedevframework.github.io/
 :stem: latexmath
-:source-highlighter: coderay
+:source-highlighter: rouge
 :xrefstyle: full
+
+Things to talk about:
+
+- `gf::Scene`
+- `gf::SceneManager`
+- `gf::Segue`
+

analysis.adoc

@@ -4,5 +4,39 @@ v0.1
 :toc:
 :homepage: https://gamedevframework.github.io/
 :stem: latexmath
-:source-highlighter: coderay
+:source-highlighter: rouge
 :xrefstyle: full
+
+We analyse Sokoban in an agnostic way, not depending on the underlying technology. This analysis will be the base for the three parts of the tutorial.
+
+
+== Rules of Sokoban
+
+https://en.wikipedia.org/wiki/Sokoban[Sokoban] is a puzzle game. The goal for the player is to push boxes on their places in a room. The player can only push the boxes, and can only push one at a time.
+
+
+== Entities in Sokoban
+
+There are three main entities in Sokoban: the level, the hero and the boxes.
+
+=== Level
+
+The level is a 2D array representing the room. Each cell in the array can be either a wall, a goal or a (non-goal) floor. The locations of the hero and the boxes are not coded in this entity because it would had some complexities. The level has a single attribute:
+
+- `blocks` that is a 2D array of block properties (`Wall`, `Goal` or `Floor`)
+
+=== Hero
+
+The hero has a single attribute:
+
+- `position` that indicates its position in the room.
+
+=== Boxes
+
+Boxes, like the hero, are represented by their position in the room. Hence the structure for the boxes has a single attribute too:
+
+- `positions` that is an array of positions in the room, one for each box.
+
+== Graphics for Sokoban
+
+The goal of this tutorial is not to teach graphics. So we will use the excellent graphics from https://kenney.nl/[Kenney.nl] and especially the https://kenney.nl/assets/sokoban[assets for sokoban].

beginner.adoc

@@ -4,5 +4,67 @@ v0.1
 :toc:
 :homepage: https://gamedevframework.github.io/
 :stem: latexmath
-:source-highlighter: coderay
+:source-highlighter: rouge
 :xrefstyle: full
+
+This tutorial is a step-by-step construction of Sokoban with Gamedev Framework. In this beginner tutorial, we will understand the basics of game development and use the minimal features of Gamedev Framework.
+
+
+== Project Setup
+
+.Structure of the project
+* `/`: root directory of the project
+** `/code/`: directory for the source code
+*** `sokoban01.cc`: the single file for this tutorial
+** `/CMakeLists.txt`: the build instructions
+
+
+.Minimal source code
+[source,c++]
+----
+include::01-beginner/code/template01.cc[]
+----
+
+
+.The associated `CMakeLists.txt`
+[source,cmake]
+----
+include::01-beginner/CMakeLists.txt[]
+----
+
+== Development
+
+=== Namespace
+
+.Namespace
+[source,c++]
+----
+include::01-beginner/code/sokoban01.cc[tag=ns]
+----
+
+=== Data
+
+.Data
+[source,c++]
+----
+include::01-beginner/code/sokoban01.cc[tags=data;ns]
+----
+
+=== Structures
+
+.Hero
+[source,c++]
+----
+include::01-beginner/code/sokoban01.cc[tags=hero;ns]
+----
+
+
+=== Structures Instanciation
+
+.Hero Instanciation
+[source,c++]
+----
+include::01-beginner/code/sokoban01.cc[tags=make_hero;ns]
+----
+
+

index.adoc

@@ -4,9 +4,11 @@ v0.1
 :toc:
 :homepage: https://gamedevframework.github.io/
 :stem: latexmath
-:source-highlighter: coderay
+:source-highlighter: rouge
 :xrefstyle: full
 
+Welcome in the tutorial for Gamedev Framework. In this tutorial, we are going to learn how to create a game with Gamedev Framework. The game is https://en.wikipedia.org/wiki/Sokoban[Sokoban].
+
 == Journey
 
 - link:analysis.html[Analysis of the game]

intermediate.adoc

@@ -4,5 +4,13 @@ v0.1
 :toc:
 :homepage: https://gamedevframework.github.io/
 :stem: latexmath
-:source-highlighter: coderay
+:source-highlighter: rouge
 :xrefstyle: full
+
+Things to talk about:
+
+- `gf::View`
+- `gf::Action`
+- `gf::ResourceManager`
+
+