Additional documentation and fixes.

Also added benchmarking capability.

Author: bernhardstrobl

Diff for: Blender/testmodels.blend

@@ -1,6 +1,8 @@
 # Pico3D Engine for the Pimoroni PicoSystem
 
-![Pico3D preview](docs/pico3d.jpeg)
+![Pico3D preview](docs/pico3d.jpg)
+
+Created as part of a master's thesis at the Kempten University of Applied Sciences.
 
 ## Getting Started
 
@@ -13,9 +15,10 @@ Add pico_multicore to the target_link_libraries in picosystem.cmake found in pic
 You should now be able to compile all the examples including pico3d.
 
 
-## Tutorials
+## Blender Tutorials
 - [Creating and exporting a game world in Blender](docs/tutorial_blender_export.md)
-- [Material, Lights and Textures in Blender](docs/tutorial_blender_materials.md) 
+- [Material, lights and textures in Blender](docs/tutorial_blender_materials.md) 
+- [Exporting individual meshes](docs/tutorial_blender_mesh.md) 
 
 
 ## F.A.Q.

Diff for: Blender/world.blend

@@ -10,7 +10,6 @@ These are split between flat and gouraud shaded triangles (i.e. those which have
 
 Gouraud:
 - glow: This ignores any lighting calculation onto the material. Useful for example to depict light sources which do not dim at night.
-- nolight: Always darkens triangles regardless of nearby light sources.
 
 Textures:
 - scroll: Applies a scrolling effect like those used in the city billboards.

Diff for: README.md

@@ -0,0 +1,19 @@
+# Exporting individual meshes
+
+While exporting chunks automatically is great for scenery, you will still need the individual object in the game world to either manipulate or have moving around.
+
+In the prototype game of Pico3D, these separate meshes are:
+- The gates of Pico City, in file logic_gate.cpp and gate.h for the mesh
+- The grass as foliage, covered in logic_grass.cpp and grass.h for the mesh
+- The NPCs and zombies, which mainly consists of meshes with different poses to be interpolated from. Main logic is covered by logic_npc and logic_zombies.
+
+All of these basically feed the 3D engine with the render_triangle() function, which only needs a triangle positioned in world coordinates and you are good to go. Have a look at any of those files as a reference once you have exported your mesh.
+
+## Exporting a single mesh from Blender
+Exporting a single mesh can be done simply by putting a check box on "Export Single Model", then changing the "Mesh" name to the desired mesh and giving the resulting C array a name itself in "Model". Then choose a desired file path (testmodel.h for example) and press on EXPORT.
+
+![Choose material name](blender21.jpg)
+
+There are two options in Advanced that may be of interest:
+- 16-bit Vertex Ints: uses less flash/ram but the model can only be 64x64 units in size (i.e. 32 units from the local object origin in each direction). This is usually sufficient unless you need a really big model (e.g. a large world backdrop).
+- Store in RAM: This just adds the "const" keyword in front of the array letting the compiler know to store the mesh in flash memory. If you access the mesh frequently it may be better to keep it in RAM unless you are running low (more likely to be the case with large models).

Diff for: chunk_data.h

@@ -23,6 +23,13 @@ uint32_t perf_75_below = 0;
 uint32_t perf_75_above = 0;
 #endif
 
+#ifdef BENCHMARK
+uint32_t perf_25_below = 0;
+uint32_t perf_50_below = 0;
+uint32_t perf_75_below = 0;
+uint32_t perf_75_above = 0;
+#endif
+
 //Framebuffer for second core to render into
 color_t framebuffer[SCREEN_WIDTH * SCREEN_HEIGHT] __attribute__ ((aligned (4))) = { };
 buffer_t *FRAMEBUFFER = buffer(SCREEN_WIDTH, SCREEN_HEIGHT, framebuffer);

Diff for: docs/blender21.jpg

@@ -37,7 +37,21 @@ int32_t render_sync() {
 
 
         //performance counters
-        #ifdef FRAME_COUNTER
+        #ifdef BENCHMARK
+            if (benchmark_complete == 0) {
+                if (core1_time < 25000) {
+                    perf_25_below++;
+                } else if (core1_time < 50000) {
+                    perf_50_below++;
+                } else if (core1_time < 75000) {
+                    perf_75_below++;
+                } else if (core1_time >= 75000) {
+                    perf_75_above++;
+                }
+                benchmark_frames++;
+                avg_frametime += core1_time;
+            }
+        #elif FRAME_COUNTER
             if (core1_time < 25000) {
                 perf_25_below++;
             } else if (core1_time < 50000) {
@@ -49,6 +63,7 @@ int32_t render_sync() {
             }
         #endif
 
+
     //if core 1 is still rendering, we have to keep the old frame and old triangle lists
     } else {
         //skipped_frames++;

Diff for: docs/pico3d.jpg

@@ -196,10 +196,10 @@ void render_triangle(struct triangle_32 &in) {
         render_lighting(in);
     }
 
-    //if the shaders are meant to glow at night, reduce them to the correct one and return
+    //if the shaders are meant to glow at night, reduce them to the correct shader_id and return
     if (in.shader_id > 10 && in.shader_id < 20) {
         in.shader_id -= 10;
-    }
+    } 
 
     //if the triangle still exists at this point, we can add it to the triangle list
     triangle_list_next[number_triangles].vertex1.x = x1;

Diff for: docs/tutorial_blender_materials.md

@@ -54,5 +54,11 @@ void logic_demo() {
     demo_progress++;
     if (demo_progress >= 7000) {
         demo_progress = 0;
+        #ifdef BENCHMARK
+            if(benchmark_complete == 0) {
+                benchmark_complete = 1;
+                avg_frametime = avg_frametime / benchmark_frames;
+            }
+        #endif
     }
 }

Diff for: docs/tutorial_blender_mesh.md

@@ -17,8 +17,8 @@ void logic_new_game() {
     //camera_position[2] = 8;
 
     //in the outskirts
-    camera_position[0] = 35;
-    camera_position[2] = -20;
+    //camera_position[0] = 35;
+    //camera_position[2] = -20;
 
     pitch = 0;
     yaw = 0;

Diff for: engine/render_globals.h

@@ -116,7 +116,7 @@ void display_info() {
 
     //show talk button if quest/shop npc is close
     if (close_npc != -1) {
-        if (close_npc == 1 && npc_quest_list[close_npc].dialogue == 11) {
+        if (close_npc == 1 && (npc_quest_list[close_npc].dialogue == 11 || npc_quest_list[close_npc].dialogue == 12)) {
             text("A: Buy Ammo", 0, 110);
         }else {
             text("A: Talk", 0, 110);
@@ -164,17 +164,17 @@ void display_info() {
 
 
             case 10:text("Need Bullets?", 0, 90); text("10$ for 5.", 0, 100);break;
-            case 11:text("Good hunting.", 0, 90); break;
+            case 11:text("Good hunting.", 0, 90); text(str(player_money + QUEST_AMMO_COST) + "$ -> " + str(player_money) + "$", 0, 100); break;
             case 12:text("You don't have", 0, 90); text("enough money.", 0, 100); break;
 
 
             case 20: text("Oh, well done for", 0, 90); text("making it here.", 0, 100);break;
             case 21: text("The fire keeps the", 0, 90); text("zombies away.", 0, 100);break;
             case 22: text("This place used to", 0, 90); text("have horses but...", 0, 100); break;
             case 23: text("I mean look at the", 0, 90); text("surroundings...", 0, 100); break;
-            case 24: text("The owner is very", 0, 90); text("unhappy due to this.", 0, 100); break;
-            case 25: text("Sells ammo to anyone,", 0, 90); text("hoping it will help.", 0, 100); break;
-            case 26: text("Don't get killed", 0, 90); text("and stock up.", 0, 100); break;
+            case 24: text("The stable owner is", 0, 90); text("pretty unhappy.", 0, 100); break;
+            case 25: text("Sells ammo to anyone", 0, 90); text("hoping it will help.", 0, 100); break;
+            case 26: text("Don't get killed and", 0, 90); text("get some rest here.", 0, 100); break;
         }
         #endif
 

Diff for: engine/render_sync.cpp

@@ -145,10 +145,12 @@ void logic_input() {
 
     } else if (menu == MENU_START) {
 
+        #ifndef BENCHMARK //Benchmark disables inputs
         if (pressed(A) || pressed(B) || pressed(X) || pressed(Y) || pressed(UP) || pressed(DOWN) || pressed(LEFT) || pressed(RIGHT)) {
             logic_new_game();
             menu = 0;
         }
+        #endif
 
     } else if (menu == MENU_DEATH) {
 

Diff for: engine/render_triangle.cpp

@@ -44,6 +44,11 @@ void display_menu() {
     } else if (menu == MENU_START) {
         pen(15, 15, 15);
 
+        #ifdef BENCHMARK
+        if (benchmark_complete == 0) {
+            text("BENCHMARKING", 0, 0);
+        }
+        #else
         if (demo_progress < 2500) {
             text("Pico3D Engine", 28, 20);
             text("by: Bernhard Strobl", 10, 30);
@@ -52,6 +57,7 @@ void display_menu() {
         if ((demo_progress / 32) % 2 == 0) {
             text("Press any button", 20, 90);
         }
+        #endif
 
     } else if (menu == MENU_DEATH) {
         pen(15, 0, 0);

Diff for: game/logic_demo.cpp

@@ -20,12 +20,11 @@ void init_quest_npcs() {
     npc_quest_list[1].y = -41 * FIXED_POINT_FACTOR;
 
 
-
     //Fireplace guy
     npc_quest_list[2].status = 1;
     npc_quest_list[2].direction = 1;
-    npc_quest_list[2].shirt_color = 0xA00A; 
-    npc_quest_list[2].dialogue = 20; 
+    npc_quest_list[2].shirt_color = 0xAF0A;
+    npc_quest_list[2].dialogue = 20;
     npc_quest_list[2].x = 48 * FIXED_POINT_FACTOR;
     npc_quest_list[2].y = -35 * FIXED_POINT_FACTOR;
 }
@@ -39,22 +38,24 @@ void talk_quest_npc() {
 
         } else {
             dialogue_display = npc_quest_list[close_npc].dialogue;
-            npc_quest_list[close_npc].dialogue++;
+            npc_quest_list[close_npc].dialogue++; //increase dialogue counter
 
             //give out same text for guard once conversation limit is reached
             if (npc_quest_list[close_npc].dialogue == 7) {
                 npc_quest_list[close_npc].dialogue = 6;
             }
 
             //Stable owner
-            if (npc_quest_list[close_npc].dialogue == 11 || npc_quest_list[close_npc].dialogue == 12 || npc_quest_list[close_npc].dialogue == 13) {
+            if (npc_quest_list[close_npc].dialogue == 12 || npc_quest_list[close_npc].dialogue == 13) {
 
                 if (player_money >= QUEST_AMMO_COST) {
                     player_money -= QUEST_AMMO_COST;
                     player_ammo += QUEST_AMMO_PURCHASE;
                     npc_quest_list[close_npc].dialogue = 11;
+                    dialogue_display = 11;
                 } else {
                     npc_quest_list[close_npc].dialogue = 12;
+                    dialogue_display = 12;
                 }
             }
 

Diff for: game/logic_events.cpp

@@ -20,11 +20,19 @@ using namespace picosystem;
 //#define FRAME_COUNTER //tallies frametimes for performance analysis
 //#define CONTENTION_COUNTER //enables counters for RAM contention on the 4 main banks
 //#define CPU_LED_LOAD //CPU load on LED (Core1: Green-40fps, Yellow-20fps, Red-10fps), blue if core 0 overloaded (logic too slow)
+//#define BENCHMARK //starts a benchmark recording average frametime and rough fps counter (takes 3 minutes!)
 
 int32_t logic_time;
-
 int32_t show_battery = 0;
 
+#ifdef BENCHMARK
+#define NO_NPCS //disable npcs for predictable performance
+uint32_t avg_frametime = 0;
+uint32_t benchmark_frames = 0;
+int32_t benchmark_complete = 0;
+#endif
+
+
 #include "engine/render_globals.h"
 #include "engine/chunk_globals.h" //chunk settings
 #include "chunk_data.h" //contains all the chunk data of the game world (exported by Blender addon)
@@ -290,7 +298,7 @@ void draw(uint32_t tick) {
 
 
 
-    //DEBUG
+    //DEBUG INFORMATION BELOW
     //clear the screen when all else fails to get at least debug output
     /*
     pen(0, 0, 0);
@@ -341,5 +349,19 @@ void draw(uint32_t tick) {
         }
     #endif
 
+    #ifdef BENCHMARK
+    if (benchmark_complete == 1) {
+        text("Benchmark results:", 0, 0);
+        text("40 FPS:" + str(perf_25_below), 0, 10);
+        text("20 FPS:" + str(perf_50_below), 0, 20);
+        text("13 FPS:" + str(perf_75_below), 0, 30);
+        text("<13 FPS:" + str(perf_75_above), 0, 40);
+        text("Average frame time:", 0, 50);
+        text(str(avg_frametime), 0, 60);
+        text("Frames rendered:", 0, 70);
+        text(str(benchmark_frames), 0, 80);
+    }
+    #endif
+
 }