Add in lesson 02

Author: lefticus

src/CMakeLists.txt

@@ -17,7 +17,10 @@ add_executable(
   game_hacking_lesson_00.cpp
   game_hacking_lesson_00.hpp
   game_hacking_lesson_01.cpp
-  game_hacking_lesson_01.hpp)
+  game_hacking_lesson_01.hpp
+  game_hacking_lesson_02.cpp
+  game_hacking_lesson_02.hpp
+)
 
 target_link_libraries(
   awesome_game

src/bitmap.cpp

@@ -2,7 +2,7 @@
 
 #include "bitmap.hpp"
 
-namespace lefticus::my_awesome_game {
+namespace lefticus::awesome_game {
 Vector2D<Color> load_png(const std::filesystem::path &filename)
 {
   std::vector<unsigned char> image;// the raw pixels

src/bitmap.hpp

@@ -1,5 +1,5 @@
-#ifndef MY_AWESOME_GAME_BITMAP_HPP
-#define MY_AWESOME_GAME_BITMAP_HPP
+#ifndef AWESOME_GAME_BITMAP_HPP
+#define AWESOME_GAME_BITMAP_HPP
 
 #include <filesystem>
 #include <ftxui/dom/node.hpp>
@@ -9,7 +9,7 @@
 #include "vector2d.hpp"
 #include <fmt/format.h>
 
-namespace lefticus::my_awesome_game {
+namespace lefticus::awesome_game {
 
 // A simple way of representing a bitmap on screen using only characters
 struct Bitmap : ftxui::Node
@@ -44,4 +44,4 @@ Vector2D<Color> load_png(const std::filesystem::path &filename);
 
 }// namespace lefticus::my_awesome_game
 
-#endif// MY_AWESOME_GAME_BITMAP_HPP
+#endif// AWESOME_GAME_BITMAP_HPP

src/color.hpp

@@ -1,5 +1,5 @@
-#ifndef MY_AWESOME_GAME_COLOR_HPP
-#define MY_AWESOME_GAME_COLOR_HPP
+#ifndef AWESOME_GAME_COLOR_HPP
+#define AWESOME_GAME_COLOR_HPP
 
 #include <cmath>
 #include <cstdint>
@@ -8,7 +8,7 @@
 
 
 // Todo: move this into `tools` project?
-namespace lefticus::my_awesome_game {
+namespace lefticus::awesome_game {
 template<typename Type> struct Basic_Color;
 
 template<typename OutType, typename InType>
@@ -57,6 +57,7 @@ template<typename Type> struct Basic_Color
   Type B{};
   Type A{};
 
+  auto operator<=>(const Basic_Color &) const = default;
 
   template<typename RHS> constexpr auto &operator+=(Basic_Color<RHS> rhs) noexcept
   {
@@ -85,4 +86,4 @@ template<typename Type> struct Basic_Color
 using Color = Basic_Color<std::uint8_t>;
 }// namespace lefticus::my_awesome_game
 
-#endif// MY_AWESOME_GAME_COLOR_HPP
+#endif// AWESOME_GAME_COLOR_HPP

src/game_components.hpp

@@ -1,5 +1,5 @@
-#ifndef MY_AWESOME_GAME_GAME_COMPONENTS_HPP
-#define MY_AWESOME_GAME_GAME_COMPONENTS_HPP
+#ifndef AWESOME_GAME_GAME_COMPONENTS_HPP
+#define AWESOME_GAME_GAME_COMPONENTS_HPP
 
 #include <chrono>
 #include <functional>
@@ -10,7 +10,7 @@
 #include "color.hpp"
 #include "vector2d.hpp"
 
-namespace lefticus::my_awesome_game {
+namespace lefticus::awesome_game {
 
 struct Game;
 
@@ -55,6 +55,14 @@ struct Menu
   };
 
   std::vector<MenuItem> items;
+
+  Menu() = default;
+
+  explicit Menu(std::initializer_list<MenuItem> items_)
+    : items{items_}
+  {
+
+  }
 };
 
 using Variable = std::variant<double, std::int64_t, std::string, bool>;
@@ -118,4 +126,4 @@ struct Game
 
 }// namespace lefticus::my_awesome_game
 
-#endif// MY_AWESOME_GAME_GAME_COMPONENTS_HPP
+#endif// AWESOME_GAME_GAME_COMPONENTS_HPP

src/game_hacking_lesson_00.cpp

@@ -3,31 +3,37 @@
 #include "game_components.hpp"
 
 
-namespace lefticus::my_awesome_game::game_hacking::lesson_00 {
+namespace lefticus::awesome_game::hacking::lesson_00 {
 Game_Map make_map()// NOLINT cognitive complexity
 {
   Game_Map map{ Size{ 10, 10 } };// NOLINT magic numbers
 
 
   auto empty_draw =
     [](Vector2D_Span<Color> &pixels, [[maybe_unused]] const Game &game, [[maybe_unused]] Point map_location) {
-      fill(pixels, Color{ 5, 5, 25, 255 });// NOLINT magic number
+      // just a grey
+      fill(pixels, Color{ 25, 25, 25, 255 });// NOLINT magic number
     };
 
   auto cannot_enter = [](const Game &, Point, Direction) -> bool { return false; };
 
-  auto water = [](
-                 Vector2D_Span<Color> &pixels, [[maybe_unused]] const Game &game, [[maybe_unused]] Point map_location) {
-    fill(pixels, Color{ 0, 0, 250, 255 });// NOLINT magic number
-  };
+  auto water_draw =
+    [](Vector2D_Span<Color> &pixels, [[maybe_unused]] const Game &game, [[maybe_unused]] Point map_location) {
+      fill(pixels, Color{ 0, 0, 250, 255 });// NOLINT magic number
+    };
 
 
   auto wall_draw = []([[maybe_unused]] Vector2D_Span<Color> &pixels,
                      [[maybe_unused]] const Game &game,
                      [[maybe_unused]] Point map_location) {
     static constexpr auto wall_color = Color{ 100, 100, 100, 128 };
 
-
+    // We fill in the wall with a color, the color alternates by the second
+    // game clock is milliseconds (1000 per second)
+    // divide by 1000 to get the current second, the % 2
+    // gives you the remainder of current second divided by 2.
+    // Result is that even numbered seconds have the first color
+    // and odd numbered seconds have the second color
     switch ((game.clock.count() / 1000) % 2) {// NOLINT magic number
     case 0:
       fill(pixels, Color{ 64, 128, 64, 255 });// NOLINT magic number
@@ -38,6 +44,8 @@ Game_Map make_map()// NOLINT cognitive complexity
     }
 
 
+    // Fill each of the 4 walls with the wall color if the wall is closed.
+    // if the wall is open (can_enter_from) that direction, the do not draw the wall
     if (!game.maps.at(game.current_map).can_enter_from(game, map_location, Direction::East)) {
       fill_line(pixels,
         Point{ pixels.size().width - 1, 0 },
@@ -61,18 +69,19 @@ Game_Map make_map()// NOLINT cognitive complexity
     }
   };
 
-  for (std::size_t cur_x = 0; cur_x < map.locations.size().width; ++cur_x) {
-    for (std::size_t cur_y = 0; cur_y < map.locations.size().height; ++cur_y) {
-      map.locations.at(Point{ cur_x, cur_y }).draw = empty_draw;
-    }
-  }
+  // be default everything is an empty, passable location
+  fill(map.locations, Location{ {}, {}, empty_draw, {} });
+
+  // the entire border of the map is surrounded by water
+  fill_border(map.locations, Location{ {}, {}, water_draw, cannot_enter });
 
-  fill_border(map.locations, Location{ {}, {}, water, cannot_enter });
 
   const auto Flashing_Tile = Location{ {}, {}, wall_draw, cannot_enter };
 
   constexpr static auto special_location = Point{ 8, 8 };
 
+  // Fill in the map locations with flashing tiles and hints
+
   map.locations.at(Point{ 3, 4 }) = Flashing_Tile;
   map.locations.at(Point{ 2, 5 }) = Flashing_Tile;// NOLINT magic numbers
   map.locations.at(Point{ 1, 2 }) = Flashing_Tile;
@@ -92,13 +101,15 @@ Game_Map make_map()// NOLINT cognitive complexity
   map.locations.at(Point{ 8, 7 }).enter_action// NOLINT
     = [](Game &game, Point, Direction) { game.last_message = "You need to remove the wall"; };
   map.locations.at(Point{ 7, 8 }).enter_action// NOLINT
-    = [](Game &game, Point, Direction) { game.last_message = "Look for 'special_location' in the source code"; };
+    = [](Game &game, Point, Direction) {
+        game.last_message = fmt::format("Look for 'special_location' ({}:{})", __FILE__, __LINE__);
+      };
 
   map.locations.at(special_location) = Flashing_Tile;
   map.locations.at(special_location).can_enter = [](const Game &, Point, [[maybe_unused]] Direction direction) {
     // || means "or"
     // this means you can currently enter the code from either
-    // the South or the East...
+    // the South || (or) the East...
     // but you need to be able to enter from the North or the West!
     //
     //        North
@@ -111,8 +122,6 @@ Game_Map make_map()// NOLINT cognitive complexity
     return direction == Direction::South || direction == Direction::East;
   };
 
-  map.locations.at(special_location).exit_action = [](Game &game, Point, Direction) { game.last_message = ""; };
-
   map.locations.at(special_location).enter_action = [](Game &game, Point, Direction) {
     game.last_message = "You found the secret room! Now change the call to `play_game` to start lesson 01";
     Menu menu;
@@ -138,7 +147,11 @@ Game make_lesson()
   retval.display_variables.emplace_back("Task");
 
   Character player;
+
+  // player's starting map location is {1,1}
   player.map_location = { 1, 1 };
+
+  // Draw a circle-like thing for the player
   player.draw =
     [](Vector2D_Span<Color> &pixels, [[maybe_unused]] const Game &game, [[maybe_unused]] Point map_location) {
       for (std::size_t cur_x = 2; cur_x < pixels.size().width - 2; ++cur_x) {
@@ -158,9 +171,13 @@ Game make_lesson()
   retval.player = player;
 
   retval.popup_message =
-    "Welcome to 'Learning C++ With Game Hacking Lesson 00!' Your job is to get into the special square in the bottom right "
-    "corner of the map. But to do that you'll need to modify the source code!";
+    "Welcome to 'Learning C++ With Game Hacking Lesson 00'\n\n"
+    "This lesson is to just get started with the project, but you will also learn some basic logic and how to get "
+    "around the source code.\n\n"
+    "Your job is to get into the special square in the bottom right corner of the map.\n\n"
+    "But to do that you'll need to modify the source code!\n"
+    "(Be sure to look for clues in the bottom message box :) )";
 
   return retval;
 }
-}// namespace lefticus::my_awesome_game
+}// namespace lefticus::awesome_game::hacking::lesson_00

src/game_hacking_lesson_00.hpp

@@ -1,14 +1,13 @@
-#ifndef MY_AWESOME_GAME_GAME_HACKING_LESSON_00_HPP
-#define MY_AWESOME_GAME_GAME_HACKING_LESSON_00_HPP
+#ifndef AWESOME_GAME_GAME_HACKING_LESSON_00_HPP
+#define AWESOME_GAME_GAME_HACKING_LESSON_00_HPP
 
-namespace lefticus::my_awesome_game {
+namespace lefticus::awesome_game {
 struct Game;
 
-namespace game_hacking::lesson_00 {
+namespace hacking::lesson_00 {
   Game make_lesson();
 }
-}
-
+}// namespace lefticus::awesome_game
 
 
-#endif// MY_AWESOME_GAME_GAME_HACKING_LESSON_00_HPP
+#endif// AWESOME_GAME_GAME_HACKING_LESSON_00_HPP

src/game_hacking_lesson_01.cpp

@@ -1,11 +1,9 @@
-#include <source_location>
-
+#include "game_hacking_lesson_01.hpp"
 #include "bitmap.hpp"
 #include "game_components.hpp"
-#include "game_hacking_lesson_00.hpp"
 
 
-namespace lefticus::my_awesome_game::game_hacking::lesson_01 {
+namespace lefticus::awesome_game::hacking::lesson_01 {
 
 bool button_pressed(const Game &game) { return get<bool>(game.variables.at("ButtonPressed")); }
 
@@ -19,8 +17,10 @@ Game_Map make_map()// NOLINT cognitive complexity
   auto button_draw =
     [](Vector2D_Span<Color> &pixels, [[maybe_unused]] const Game &game, [[maybe_unused]] Point map_location) {
       if (button_pressed(game)) {
+        // Light grey if button is pressed
         fill(pixels, Color{ 45, 45, 45, 255 });// NOLINT magic number
       } else {
+        // dark grey if button is not pressed
         fill(pixels, Color{ 15, 15, 15, 255 });// NOLINT magic number
       }
     };
@@ -32,10 +32,10 @@ Game_Map make_map()// NOLINT cognitive complexity
 
   auto cannot_enter = [](const Game &, Point, Direction) -> bool { return false; };
 
-  auto water = [](
-                 Vector2D_Span<Color> &pixels, [[maybe_unused]] const Game &game, [[maybe_unused]] Point map_location) {
-    fill(pixels, Color{ 0, 0, 250, 255 });// NOLINT magic number
-  };
+  auto water_draw =
+    [](Vector2D_Span<Color> &pixels, [[maybe_unused]] const Game &game, [[maybe_unused]] Point map_location) {
+      fill(pixels, Color{ 0, 0, 250, 255 });// NOLINT magic number
+    };
 
 
   auto wall_draw = []([[maybe_unused]] Vector2D_Span<Color> &pixels,
@@ -77,13 +77,10 @@ Game_Map make_map()// NOLINT cognitive complexity
     }
   };
 
-  for (std::size_t cur_x = 0; cur_x < map.locations.size().width; ++cur_x) {
-    for (std::size_t cur_y = 0; cur_y < map.locations.size().height; ++cur_y) {
-      map.locations.at(Point{ cur_x, cur_y }).draw = empty_draw;
-    }
-  }
+  // be default everything is an empty, passable location
+  fill(map.locations, Location{ {}, {}, empty_draw, {} });
 
-  fill_border(map.locations, Location{ {}, {}, water, cannot_enter });
+  fill_border(map.locations, Location{ {}, {}, water_draw, cannot_enter });
 
   const auto Flashing_Tile = Location{ {}, {}, wall_draw, cannot_enter };
 
@@ -111,6 +108,8 @@ Game_Map make_map()// NOLINT cognitive complexity
         // so if you step on this tile then it will invert the state of the button
         // from true to false and from false to true.
         //
+        // don't get too hung up on this weird `std::get<bool>` thing yet!
+        //
         // At least...that's the idea. Problem is there's a typo. Do you see it?!
         game.variables["BottonPressed"] = !std::get<bool>(game.variables["ButtonPressed"]);
       };
@@ -123,11 +122,8 @@ Game_Map make_map()// NOLINT cognitive complexity
 
   map.locations.at(special_location).enter_action = [](Game &game, Point, Direction) {
     game.last_message = "You opened the door! Now change the call to `play_game` to start lesson 02";
-    Menu menu;
-    menu.items.push_back(
-      Menu::MenuItem{ "Continue Game", [](Game &menu_action_game) { menu_action_game.clear_menu(); } });
-    menu.items.push_back(
-      Menu::MenuItem{ "Exit Game", [](Game &menu_action_game) { menu_action_game.exit_game = true; } });
+    Menu menu{ { "Continue Game", [](Game &menu_action_game) { menu_action_game.clear_menu(); } },
+      { "Exit Game", [](Game &menu_action_game) { menu_action_game.exit_game = true; } } };
     game.set_menu(menu);
   };
 
@@ -157,9 +153,9 @@ Game make_lesson()
           if ((cur_x == 2 && cur_y == 2) || (cur_x == 2 && cur_y == pixels.size().height - 3)
               || (cur_x == pixels.size().width - 3 && cur_y == pixels.size().height - 3)
               || (cur_x == pixels.size().width - 3 && cur_y == 2)) {
-            pixels.at(Point{ cur_x, cur_y }) += Color{ 128, 128, 0, 64 };// NOLINT
+            pixels.at(Point{ cur_x, cur_y }) += Color{ 128, 128, 0, 64 };// NOLINT Magic Number
           } else {
-            pixels.at(Point{ cur_x, cur_y }) += Color{ 128, 128, 0, 255 };// NOLINT
+            pixels.at(Point{ cur_x, cur_y }) += Color{ 128, 128, 0, 255 };// NOLINT Magic Number
           }
         }
       }
@@ -169,9 +165,11 @@ Game make_lesson()
   retval.player = player;
 
   retval.popup_message =
-    "Welcome to 'Learning C++ With Game Hacking Lesson 01!' Your job is to get into the special square in the bottom "
-    "right corner of the map. But to do that you'll need to modify the source code!";
+    "Welcome to 'Learning C++ With Game Hacking Lesson 01'\n\n"
+    "Your job, again, is to get into the special square in the bottom right corner of the map, and you'll need to "
+    "modify the code.\n\n"
+    "There is a hidden button, but it's currently broken :(. Fortunately there are clues again.";
 
   return retval;
 }
-}// namespace lefticus::my_awesome_game::game_hacking::lesson_01
+}// namespace lefticus::awesome_game::hacking::lesson_01