Improve example names

4ian · 4ian · commit 21af62c80290 · 2025-09-25T15:15:30.000+02:00
diff --git a/examples/3d-bomber-bunny/README.md b/examples/3d-bomber-bunny/README.md
@@ -1 +1,3 @@
+# 3D Bomber Bunny
+
 A bomberman-like game for up to 4 players with procedural animations and particles.
diff --git a/examples/3d-car-coin-hunt/README.md b/examples/3d-car-coin-hunt/README.md
@@ -1 +1,3 @@
+# 3D Car Coint Hunt
+
 A top-down 3D racing game with 360° controls where players are driving through a city to collect coins.
diff --git a/examples/3d-endless-terrain/README.md b/examples/3d-endless-terrain/README.md
@@ -1 +1,3 @@
+# 3D Endless Terrain Demo
+
 A demonstration of height map tiling.
diff --git a/examples/3d-platformer/README.md b/examples/3d-platformer/README.md
@@ -1 +1,3 @@
+# Bunny 3D Platformer
+
 A 3D platformer (Mario-like) game. Jump around and collect as many coins as you can!
diff --git a/examples/3d-racing-game/README.md b/examples/3d-racing-game/README.md
@@ -1 +1,3 @@
+# Arcade 3D Racing
+
 An arcade racing game inspired from Out Run.
diff --git a/examples/3d-road-crosser/README.md b/examples/3d-road-crosser/README.md
@@ -1 +1,3 @@
+# Road Crosser
+
 A Frogger-like similar to the mobile game "Crossy Road" with endless random level generation.
diff --git a/examples/3d-shark-frenzy/README.md b/examples/3d-shark-frenzy/README.md
@@ -1 +1,3 @@
+# Shark Frenzy
+
 Eat as much fish as possible to survive in a game inspired from Hungry Shark.
diff --git a/examples/basic-ai-with-pathfinding/README.md b/examples/basic-ai-with-pathfinding/README.md
@@ -1 +1,3 @@
+# Basic AI using Pathfinding
+
 Show how to use pathfinding to make enemies chase the player.
diff --git a/examples/calcopus-spine-demo/README.md b/examples/calcopus-spine-demo/README.md
@@ -1,4 +1,4 @@
-# Calcopus
+# Calcopus (Spine Demo)
 
 An example of project with Spine object used. Player needs to resolve simple math tasks quickly in order to find the lowest value.
 What is demonstrated in this project:
diff --git a/examples/car-physics/README.md b/examples/car-physics/README.md
@@ -1 +1,3 @@
-A fun realistic physics based car example
+# Car 2D Physics Demo
+
+A fun realistic physics based car example.
diff --git a/examples/crazygames-sdk-demo/README.md b/examples/crazygames-sdk-demo/README.md
@@ -1 +1,3 @@
+# CrazyGames SDK Demo
+
 Showcase all the features from the CrazyGames SDK V3 extension. The project can be exported as HTML5 game to be imported in the QA tools on CrazyGames website.
diff --git a/examples/customize-keys-with-lastpressedkey/README.md b/examples/customize-keys-with-lastpressedkey/README.md
@@ -1 +1,3 @@
+# Keyboard Input Customization
+
 This explains how to remember the last key that was pressed and customize the inputs of your game.
diff --git a/examples/newgrounds-api/README.md b/examples/newgrounds-api/README.md
@@ -1 +1,3 @@
-A demo on how to use New grounds API extension.
+# Newgrounds API Demo
+
+A demo on how to use the Newgrounds API extension.
diff --git a/examples/p2p-networking/README.md b/examples/p2p-networking/README.md
@@ -1 +1,3 @@
+# P2P Networking Demo
+
 A showcase of some multiplayer/networking possibilities using the P2P extension.
diff --git a/examples/save-load/README.md b/examples/save-load/README.md
@@ -1 +1,3 @@
+# Manual Save/Load Demo
+
 Advanced example showing how to persist data and then reload them from storage (useful to store game progress, or save the state of some objects in a game).
diff --git a/examples/starting-2d-driving/README.md b/examples/starting-2d-driving/README.md
@@ -1,2 +1,4 @@
+# 2D Driving
+
 A 2D physics-based, top-down, game where the player is controlling a 2D car.
 It has some obstacles that can be pushed away. Support keyboard and mobile controls for the player car.
diff --git a/examples/starting-2d-platformer-shooter/README.md b/examples/starting-2d-platformer-shooter/README.md
@@ -1 +1,3 @@
+# 2D Platformer Shooter
+
 A 2D Mega Man-like starter game where the player controls a character who can jump on platforms and shoot bullets that can hit enemies. Support for mobile and keyboard controls.
diff --git a/examples/starting-3D-platformer/README.md b/examples/starting-3D-platformer/README.md
@@ -1,2 +1,4 @@
+# 3D Platformer
+
 A 3D, physics-based, platformer starter game. It has a ground and platforms where the player can jump or which can be pushed, as well as coins to collect.
 The camera moves around the player. It has mobile and mouse/keyboard controls.
diff --git a/examples/starting-3d-driving/README.md b/examples/starting-3d-driving/README.md
@@ -1,2 +1,4 @@
+# 3D Driving
+
 A 3D physics-based game where the player is controlling a car.
 It has a groud composed on a road and grass and some traffic cones that can be pushed by the car. Keyboard, gamepad and mobile controls for the player car.
diff --git a/examples/starting-beatemup/README.md b/examples/starting-beatemup/README.md
@@ -1,2 +1,4 @@
+# Beat'em up
+
 A 2D, side-view, beat'em up style game where the player controls a character that can move in the level and attack other characters who are trying to hurt him.
 Support for keyboard and mobile controls.
diff --git a/examples/starting-card-game/README.md b/examples/starting-card-game/README.md
@@ -1,2 +1,4 @@
+# Card Game
+
 A simple card game where the player draws cards from a deck and can drag the revealed cards on the screen. The player can also return cards to the deck or choose to shuffle the deck.
 Support for mouse and touch.
diff --git a/examples/starting-clicker/README.md b/examples/starting-clicker/README.md
@@ -1,2 +1,4 @@
+# Clicker Game
+
 A clicker game where the player clicks a button to earn money. Another button allows them to purchase a system that generate passive income every few seconds and upgrade it to be faster. A score counter displays the current amount of money.
 Support for mouse and touch.
diff --git a/examples/starting-draggable-tiles/README.md b/examples/starting-draggable-tiles/README.md
@@ -1,2 +1,4 @@
+# Board game with draggable tiles
+
 A 2D board game where 3 different kind of tiles can be dragged on the grid of the board. A tile can't be dragged if another tile is already present on a cell of the board.
 Support for both mouse and mobile controls.
diff --git a/examples/starting-endless-runner/README.md b/examples/starting-endless-runner/README.md
@@ -1,2 +1,4 @@
+# 2D Endless Runner
+
 A 2d, side-view, endless runner - similar to games like Geometry Dash. It has a player object which can jump, some platforms, obstacles to avoid. The level is a repeating layout. It displays a score increasing as the player progresses.
 Support for mobile and keyboard controls.
diff --git a/examples/starting-first-person/README.md b/examples/starting-first-person/README.md
@@ -1,3 +1,5 @@
+# 3D First Person
+
 A 3D, physics-based, first person game where the player can move and look around.
 It has a ground, platforms and obstacles which can be pushed away.
 Support for both mobile and keyboard/mouse controls.
diff --git a/examples/starting-flappy-bird/README.md b/examples/starting-flappy-bird/README.md
@@ -1,2 +1,4 @@
+# Flappy Bird
+
 A game where the player must constantly tap to jump on the screen, avoiding to touch the ground and obstacles as they progress in a challenging level. It is similar to Flappy Bird.
 Support for keyboard and mobile controls.
diff --git a/examples/starting-physics-pixel/README.md b/examples/starting-physics-pixel/README.md
@@ -1,3 +1,5 @@
+# 2D Physics Game (pixel-art)
+
 A 2D, side-view, physics-based game. Similar to Angry bird, you can throw a ball against obstacles and walls.
 Works on mobile and with the mouse.
 Assets and game are optimized for pixel art.
diff --git a/examples/starting-physics/README.md b/examples/starting-physics/README.md
@@ -1,2 +1,4 @@
+# 2D Physics Game
+
 A 2D, side-view, physics-based game. Similar to Angry bird, you can throw a ball against obstacles and walls.
 Works on mobile and with the mouse.
diff --git a/examples/starting-platformer-pixel/README.md b/examples/starting-platformer-pixel/README.md
@@ -1,3 +1,5 @@
+# 2D Platformer (pixel-art)
+
 A 2D platformer game in which the player can jump on platforms and collect coins.
 It has platforms, a player and coins to collect like a basic 2D Mario-like game.
 Support mobile controls and keyboard.
diff --git a/examples/starting-platformer/README.md b/examples/starting-platformer/README.md
@@ -1,3 +1,5 @@
+# 2D Platformer
+
 A 2D platformer game in which the player can jump on platforms and collect coins.
 It has platforms, a player and coins to collect.
 Support mobile controls and keyboard.
diff --git a/examples/starting-point-and-click-adventure/README.md b/examples/starting-point-and-click-adventure/README.md
@@ -1,3 +1,5 @@
+# Point-and-click adventure
+
 A 2D, side-view, point-and-click game where the player taps on the screen to move their character, who automatically walks around obstacles. The player can interact with other characters: when close, a dialog opens with a question offering two choices.
 
 Support for mouse and touch.
diff --git a/examples/starting-point-and-click-pixel/README.md b/examples/starting-point-and-click-pixel/README.md
@@ -1,3 +1,5 @@
+# Top-down point-and-click (pixel-art)
+
 A 2D, top-down, game where the player is a rectangle which can move to where the player clicks using pathfinding - avoiding obstacles.
 Support for mobile controls and mouse.
 Assets and game are optimized for pixel art.
diff --git a/examples/starting-point-and-click/README.md b/examples/starting-point-and-click/README.md
@@ -1,2 +1,4 @@
+# Top-down point-and-click
+
 A 2D, top-down, game where the player is a rectangle which can move to where the player clicks using pathfinding - avoiding obstacles.
 Support for mobile controls and mouse.
diff --git a/examples/starting-quiz/README.md b/examples/starting-quiz/README.md
@@ -1,2 +1,4 @@
-A basic quizz game showing a question on the screen with 4 buttons allowing to choose an answer. Once an answer is selected, a win/lose sound is played and the next question is displayed. Questions are stored in a scene variable.
+# Quiz game
+
+A basic quiz game showing a question on the screen with 4 buttons allowing to choose an answer. Once an answer is selected, a win/lose sound is played and the next question is displayed. Questions are stored in a scene variable.
 Support for both mouse and touchscreens.
diff --git a/examples/starting-rts-unit-selection/README.md b/examples/starting-rts-unit-selection/README.md
@@ -1,3 +1,5 @@
+# Top-down RTS (unit selection)
+
 A 2D, top-down, simple game where the player can draw a selection around its units and then tap on the screen to move the selected units to this point (avoiding obstacles).
 
 Support for mouse and touch.
diff --git a/examples/starting-shootemup/README.md b/examples/starting-shootemup/README.md
@@ -1,3 +1,5 @@
+# Shoot 'em up
+
 A 2D side-scrolling shoot ’em up where the player can move around the screen while automatically firing bullets. Enemies regularly appear from the opposite side, advancing toward the player and shooting back.
 
 Support for keyboard and mobile controls.
diff --git a/examples/starting-tile-placement/README.md b/examples/starting-tile-placement/README.md
@@ -1,2 +1,4 @@
+# Tile-based builder/strategy
+
 A 2D, top-down, game where tiles can be selected, like in a strategy game, and placed on a grid.
 Support for both mouse and touchscreens.
diff --git a/examples/starting-top-down-pixel/README.md b/examples/starting-top-down-pixel/README.md
@@ -1,3 +1,5 @@
+# Top-down game (pixel-art)
+
 A 2D, top-down, game where the player can move around on a small level with solid obstacles.
 Support for both mobile controls and keyboard.
 Assets and game are optimized for pixel art.
diff --git a/examples/starting-top-down-rpg/README.md b/examples/starting-top-down-rpg/README.md
@@ -1,3 +1,5 @@
+# 2D RPG
+
 A 2D top-down RPG-style game where the player can explore the map and interact with other characters. When near a character, a dialog appears with text and two choices.
 
 Support for keyboard and mobile controls.
diff --git a/examples/starting-top-down/README.md b/examples/starting-top-down/README.md
@@ -1,2 +1,4 @@
+# Top-down game
+
 A 2D, top-down, game where the player can move around on a small level with solid obstacles.
 Support for both mobile controls and keyboard.
diff --git a/examples/starting-twin-stick-shooter/README.md b/examples/starting-twin-stick-shooter/README.md
@@ -1,3 +1,5 @@
+# 2D Twin Stick Shooter
+
 A 2D, top-down, game where the player can move around and shoot at enemies which are randomly created around the player and moving toward them.
 The player movement and shooting direction are independant.
 Support for mobile controls (using two virtual joysticks, hence the name "Twin Stick Shooter") and mouse/keyboard.
diff --git a/examples/starting-vampire-survivor/README.md b/examples/starting-vampire-survivor/README.md
@@ -1,3 +1,5 @@
+# Vampire Survivors-like game
+
 A 2D, top-down, game where the player can move around and automatically fires bullets toward enemies who are moving toward them.
-This is similar to casual survival games like Vampire Survivor.
+This is similar to casual survival games like Vampire Survivors.
 Support for both mobile controls and keyboard.
diff --git a/examples/text-input/README.md b/examples/text-input/README.md
@@ -1 +1,3 @@
+# Text Input Demo
+
 Showcase of the Text Input object and few conditions/actions related to this object.
diff --git a/examples/tilemaps-made-with-ldtk/README.md b/examples/tilemaps-made-with-ldtk/README.md
@@ -1 +1,3 @@
+# Tilemaps with LDtk Demo
+
 Shows examples of tile maps made with the LDtk (that can be downloaded on ldtk.io).
diff --git a/examples/tilemaps-made-with-tiled-editor/README.md b/examples/tilemaps-made-with-tiled-editor/README.md
@@ -1 +1,3 @@
+# Tilemaps with Tiled Demo
+
 Shows different examples of Tilemaps made with the Tiled editor (that can be downloaded on mapeditor.org), including some with animations.
diff --git a/examples/tower-defense-war/README.md b/examples/tower-defense-war/README.md
@@ -1 +1,3 @@
+# Zombie Tower Defense
+
 A tower defense game example that shows users how to select, deselect, and purchase towers. Create instances of enemies using arrays, and moving enemies along a path using their own object arrays and point objects in scene.
diff --git a/scripts/generate-database.js b/scripts/generate-database.js
@@ -340,6 +340,43 @@ const getQuickCustomizationImageUrl = (gameFolderPath, allFiles) => {
   return hasImage ? getResourceUrl(imagePath) : undefined;
 };
 
+/**
+ * Extract example name and descriptions from README content
+ * @param {string} readmeFileContent
+ * @param {string} slug
+ * @returns {{exampleName: string, shortDescription: string, description: string}}
+ */
+const extractExampleNameAndDescriptions = (readmeFileContent, slug) => {
+  const cleanedContent = readmeFileContent.replace(/\r\n/g, '\n').trim();
+
+  // Extract example name from README header or format from slug
+  let exampleName;
+  let contentAfterHeader = cleanedContent;
+
+  // Check if README starts with a markdown header
+  const headerMatch = cleanedContent.match(/^#\s+(.+)$/m);
+  if (headerMatch && cleanedContent.indexOf(headerMatch[0]) === 0) {
+    // Use the header text as the example name
+    exampleName = headerMatch[1].trim();
+    // Remove the header and any immediately following empty lines from content
+    contentAfterHeader = cleanedContent
+      .substring(headerMatch[0].length)
+      .replace(/^\n+/, '');
+  } else {
+    // Use formatted slug as before
+    exampleName = formatExampleName(slug);
+  }
+
+  // Split content into short description and description
+  const contentParagraphs = contentAfterHeader.split('\n\n');
+  const shortDescription = contentParagraphs[0] ? contentParagraphs[0].trim() : '';
+  const description = contentParagraphs.length > 1
+    ? contentParagraphs.slice(1).join('\n\n').trim()
+    : '';
+
+  return { exampleName, shortDescription, description };
+};
+
 /**
  * Extract the information about the example games from the examples folder.
  * @param {libGDevelop} gd
@@ -449,16 +486,12 @@ const extractExamples = async (
           );
           return null;
         }
-        const readmeFileContent = readmeFileWithMetadata.parsedContent
-          .replace(/\r\n/g, '\n')
-          .trim();
-        const exampleName = formatExampleName(slug);
-
-        const shortDescription = readmeFileContent.split('\n\n')[0];
-        const description = readmeFileContent
-          .split('\n\n')
-          .slice(1)
-          .join('\n\n');
+        const readmeFileContent = readmeFileWithMetadata.parsedContent;
+
+        const { exampleName, shortDescription, description } = extractExampleNameAndDescriptions(
+          readmeFileContent,
+          slug
+        );
 
         const tags = [
           ...fileWithMetadata.tags,
