Skip to content

Commit 1890e00

Browse files
ClementPasteauClementPasteau
authored
Improve examples descriptions (#735)
1 parent 7a510fc commit 1890e00

File tree

24 files changed

+187
-163
lines changed

24 files changed

+187
-163
lines changed

‎__tests__/post-build/__snapshots__/exampleShortHeaders.json.spec.js.snap‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
// Jest Snapshot v1, https://goo.gl/fbAQLP
2+
3+
exports[`exampleShortHeaders.json post build checks defaultTags 1`] = `
4+
Object {
5+
"authorIds": Array [
6+
"R0F5QGNCzgOY5w2cxGeKJOq2UaD2",
7+
],
8+
"codeSizeLevel": "small",
9+
"description": "Check out [the YouTube video](https://www.youtube.com/watch?v=eU0kkLSdw0Y&list=PL3YlZTdKiS898Wio0tvKjQM0x3zo4V0Mb) explaining how this example was made.",
10+
"difficultyLevel": "simple",
11+
"gdevelopVersion": "",
12+
"id": "d260466ba96262fd00930eb950ae486209a828f851add1c1c5bbc2a2d020f868",
13+
"license": "MIT",
14+
"name": "Platformer",
15+
"previewImageUrls": Array [
16+
"https://resources.gdevelop-app.com/examples/platformer/preview.png",
17+
"https://resources.gdevelop-app.com/examples/platformer/square-icon.png",
18+
],
19+
"shortDescription": "An example of a basic platformer (Mario-like) game. Jump around and collect as many coins as you can!",
20+
"slug": "platformer",
21+
"tags": Array [
22+
"platformer",
23+
"game",
24+
"simple",
25+
"Starter",
26+
"Anchor",
27+
"Animatable capability",
28+
"Event functions",
29+
"Sounds and music",
30+
"Layers and cameras",
31+
"Conversion",
32+
"Events and control flow",
33+
"Mathematical tools",
34+
"Mouse and touch",
35+
"Objects",
36+
"Scene",
37+
"Timers and time",
38+
"Variables",
39+
"Debugger Tools",
40+
"Effect capability",
41+
"Flippable capability",
42+
"Linked objects",
43+
"Opacity capability",
44+
"Panel Sprite (9-patch) Object",
45+
"Particle system",
46+
"Platform behavior",
47+
"Shape painter",
48+
"Resizable capability",
49+
"Scalable capability",
50+
"Sprite",
51+
"System information",
52+
"Text capability",
53+
"Text object",
54+
"Tiled Sprite Object",
55+
"Top-down movement",
56+
"Tweening",
57+
"Parallax for Tiled Sprite",
58+
"Panel sprite button",
59+
"Platformer character animator",
60+
"Rectangular movement",
61+
"Smooth Camera",
62+
"Checkpoints",
63+
"Gamepads (controllers)",
64+
"Multitouch joystick and buttons (sprite)",
65+
"Shake object",
66+
"Volume Falloff",
67+
],
68+
}
69+
`;
70+
71+
exports[`exampleShortHeaders.json post build checks defaultTags 2`] = `
72+
Object {
73+
"authorIds": Array [
74+
"jy7FXnGX0ZZcWfrAI9YuQaeIphi1",
75+
"9MGDlUQAh8QUilno4JPycekjRCJ3",
76+
"R0F5QGNCzgOY5w2cxGeKJOq2UaD2",
77+
],
78+
"codeSizeLevel": "small",
79+
"description": "",
80+
"difficultyLevel": "simple",
81+
"gdevelopVersion": "",
82+
"id": "3cfc75d79ece13652857e8f9c20931f275916ca88f89940ca81b91734da4ac5d",
83+
"license": "MIT",
84+
"name": "Tappy plane",
85+
"previewImageUrls": Array [
86+
"https://resources.gdevelop-app.com/examples/tappy-plane/thumbnail.png",
87+
],
88+
"quickCustomizationImageUrl": "https://resources.gdevelop-app.com/examples/tappy-plane/thumbnail-quick-customization.png",
89+
"shortDescription": "Tappy Plane is a Flappy Bird-like game. Tap to keep your plane in the air and make your way through the cave system.
90+
Get as far as you can before you crash in to a wall, submit your score, and try again.",
91+
"slug": "tappy-plane",
92+
"tags": Array [
93+
"tappy-plane",
94+
"game",
95+
"simple",
96+
"Starter",
97+
"Anchor",
98+
"Animatable capability",
99+
"Event functions",
100+
"Sounds and music",
101+
"Layers and cameras",
102+
"Events and control flow",
103+
"External layouts",
104+
"Storage",
105+
"Keyboard",
106+
"Mathematical tools",
107+
"Mouse and touch",
108+
"Network",
109+
"Objects",
110+
"Scene",
111+
"Timers and time",
112+
"Variables",
113+
"Destroy Outside Screen Behavior",
114+
"Effect capability",
115+
"Flippable capability",
116+
"Leaderboards",
117+
"Opacity capability",
118+
"Panel Sprite (9-patch) Object",
119+
"Platform behavior",
120+
"Player Authentication",
121+
"Resizable capability",
122+
"Scalable capability",
123+
"Sprite",
124+
"Text capability",
125+
"Text Input",
126+
"Text object",
127+
"Tiled Sprite Object",
128+
"Tweening",
129+
"Ellipse movement",
130+
"Panel sprite button",
131+
"Shake object",
132+
"Flash object",
133+
],
134+
}
135+
`;

‎__tests__/post-build/exampleShortHeaders.json.spec.js‎

Lines changed: 2 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -26,135 +26,14 @@ describe('exampleShortHeaders.json post build checks', () => {
2626
if (!platformer)
2727
throw new Error('Platformer not found in the example short headers');
2828

29-
expect(platformer).toEqual(
30-
expect.objectContaining({
31-
id: 'd260466ba96262fd00930eb950ae486209a828f851add1c1c5bbc2a2d020f868',
32-
slug: 'platformer',
33-
name: 'Platformer',
34-
authorIds: ['R0F5QGNCzgOY5w2cxGeKJOq2UaD2'],
35-
shortDescription:
36-
'An example of a basic platformer (Mario-like) game. Jump around and collect as many coins as you can!',
37-
description:
38-
'Check out [the YouTube video](https://www.youtube.com/watch?v=eU0kkLSdw0Y&list=PL3YlZTdKiS898Wio0tvKjQM0x3zo4V0Mb) explaining how this example was made.',
39-
license: 'MIT',
40-
previewImageUrls: [
41-
'https://resources.gdevelop-app.com/examples/platformer/preview.png',
42-
'https://resources.gdevelop-app.com/examples/platformer/square-icon.png',
43-
],
44-
tags: expect.arrayContaining([
45-
'platformer',
46-
'game',
47-
'simple',
48-
'Starter',
49-
'Anchor',
50-
'Event functions',
51-
'Sounds and music',
52-
'Layers and cameras',
53-
'Conversion',
54-
'Events and control flow',
55-
'Mathematical tools',
56-
'Mouse and touch',
57-
'Objects',
58-
'Scene',
59-
'Timers and time',
60-
'Variables',
61-
'Debugger Tools',
62-
'Linked objects',
63-
'Panel Sprite (9-patch) Object',
64-
'Particle system',
65-
'Platform behavior',
66-
'Shape painter',
67-
'Sprite',
68-
'System information',
69-
'Text object',
70-
'Tiled Sprite Object',
71-
'Top-down movement',
72-
'Tweening',
73-
'Panel sprite button',
74-
'Platformer character animator',
75-
'Rectangular movement',
76-
'Smooth Camera',
77-
'Checkpoints',
78-
'Gamepads (controllers)',
79-
'Multitouch joystick and buttons (sprite)',
80-
'Shake object',
81-
'Volume Falloff',
82-
]),
83-
codeSizeLevel: 'small',
84-
difficultyLevel: 'simple',
85-
gdevelopVersion: '',
86-
})
87-
);
29+
expect(platformer).toMatchSnapshot();
8830

8931
const tappyPlane = exampleShortHeaders.find(
9032
({ name }) => name === 'Tappy plane'
9133
);
9234
if (!tappyPlane)
9335
throw new Error('Tappy Plane not found in the example short headers');
9436

95-
expect(tappyPlane).toEqual(
96-
expect.objectContaining({
97-
id: '3cfc75d79ece13652857e8f9c20931f275916ca88f89940ca81b91734da4ac5d',
98-
name: 'Tappy plane',
99-
slug: 'tappy-plane',
100-
shortDescription:
101-
'Tappy Plane is a Flappy Bird-like game. Tap to keep your plane in the air and make your way through the cave system.\nGet as far as you can before you crash in to a wall, submit your score, and try again.',
102-
license: 'MIT',
103-
previewImageUrls: [
104-
'https://resources.gdevelop-app.com/examples/tappy-plane/thumbnail.png',
105-
],
106-
quickCustomizationImageUrl:
107-
'https://resources.gdevelop-app.com/examples/tappy-plane/thumbnail-quick-customization.png',
108-
authorIds: [
109-
'jy7FXnGX0ZZcWfrAI9YuQaeIphi1',
110-
'9MGDlUQAh8QUilno4JPycekjRCJ3',
111-
'R0F5QGNCzgOY5w2cxGeKJOq2UaD2',
112-
],
113-
tags: expect.arrayContaining([
114-
'tappy-plane',
115-
'game',
116-
'simple',
117-
'Starter',
118-
'Animatable capability',
119-
'Event functions',
120-
'Sounds and music',
121-
'Layers and cameras',
122-
'Events and control flow',
123-
'External layouts',
124-
'Storage',
125-
'Keyboard',
126-
'Mathematical tools',
127-
'Mouse and touch',
128-
'Network',
129-
'Objects',
130-
'Scene',
131-
'Timers and time',
132-
'Variables',
133-
'Destroy Outside Screen Behavior',
134-
'Effect capability',
135-
'Flippable capability',
136-
'Leaderboards',
137-
'Opacity capability',
138-
'Panel Sprite (9-patch) Object',
139-
'Platform behavior',
140-
'Player Authentication',
141-
'Resizable capability',
142-
'Scalable capability',
143-
'Sprite',
144-
'Text capability',
145-
'Text Input',
146-
'Text object',
147-
'Tiled Sprite Object',
148-
'Tweening',
149-
'Ellipse movement',
150-
'Panel sprite button',
151-
'Shake object',
152-
'Flash object',
153-
]),
154-
codeSizeLevel: 'small',
155-
difficultyLevel: 'simple',
156-
gdevelopVersion: '',
157-
})
158-
);
37+
expect(tappyPlane).toMatchSnapshot();
15938
});
16039
});

‎examples/button-effects/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Change the way a button looks based on the state of the button
22

3-
This is a simple yet powerful method for changing the appearance of objects that using the "Button effects" behavior.
3+
This is a simple yet powerful method for changing the appearance of objects that using the "Button effects" behavior.
44
The states of a button include: idle, hover, pressed, held outside, and focused.
55

66
Multiple behaviors are provided and they can be combined to make a juicy button with animated responses to user input.
@@ -11,4 +11,4 @@ Multiple behaviors are provided and they can be combined to make a juicy button
1111
- Button size (scale) tween
1212
- Button color (tint) tween
1313
- Button opacity tween
14-
- Button angle tween
14+
- Button angle tween

‎examples/downhill-bike-physics-demo/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
Try to cross the finish line as fast as possible without falling over! And remember to pedal safe!
22

3-
Starting with this template, use the Physics Engine to build an advanced simulation of a bike with a person pedaling on it! You will discover how to join objects, apply basic physics behaviors to your scene and change your camera settings to adapt to what's happening during the game.
3+
Starting with this template, use the Physics Engine to build an advanced simulation of a bike with a person pedaling on it!
4+
5+
You will discover how to join objects, apply basic physics behaviors to your scene and change your camera settings to adapt to what's happening during the game.

‎examples/game-feel-demo/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
A demo showing how to enhance the "game feel" of your project: VFX, shot trail, ambient sounds and SFX, screenshake, wobble...
22

3-
Have you ever felt like you were actually inside a video game when playing it? Discover GDevelop's capabilities and immerse future players in your next game!
3+
Have you ever felt like you were actually inside a video game when playing it? Discover GDevelop's capabilities and immerse future players in your next game!

‎examples/geometry-monster/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
A hyper casual endless game where you have to collect shapes and avoid bombs, with a progressively increasing difficulty.
22

3-
Start from this example to create your own catch game! You will learn about collisions, particle emitters, and how to set up a menu.
3+
Start from this example to create your own catch game! You will learn about collisions, particle emitters, and how to set up a menu.

‎examples/multiplayer-jump-game/README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
An online multiplayer physics game where try to collect all of the apples in the game without throwing your keyboard through your monitor.
1+
An online multiplayer physics game where you try to collect all of the apples in the game without throwing your keyboard through your monitor.
22

33
This game example includes:
4-
-Multiplayer lobby
5-
-Multiplayer chat
6-
-Physics behavior
7-
-Tween behavior
8-
-Sound effects
9-
-Text objects
4+
5+
- Multiplayer lobby
6+
- Multiplayer chat
7+
- Physics behavior
8+
- Tween behavior
9+
- Sound effects
10+
- Text objects

‎examples/not-a-vania/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
This project is meant as a game example or template for a more advanced platformer. This is in the style of older castlevania entries, such as Castlevania 1 or 3.
22

3-
There are numerous advanced GDevelop concepts in this project, such as finite state machines (FSMs), tweens, bitmap fonts and bitmap text objects, tilemaps, external event sheets, declaring variables via events, and object variables.
3+
There are numerous advanced GDevelop concepts in this project, such as finite state machines (FSMs), tweens, bitmap fonts and bitmap text objects, tilemaps, external event sheets, declaring variables via events, and object variables.
44

55
Before working with this project, it is STRONGLY recommended that you review the following:
66

77
At least the first four tutorials on the GDevelop Wiki: http://wiki.compilgames.net/doku.php/gdevelop5/tutorials This example uses concepts from EACH of those tutorials and it is important to understand those concepts before trying to adapt these ideas.
88

9-
The finite state machine tutorial at: http://wiki.compilgames.net/doku.php/gdevelop5/tutorials/finite_state_machine
9+
The finite state machine tutorial at: http://wiki.compilgames.net/doku.php/gdevelop5/tutorials/finite_state_machine

‎examples/object-slicer/README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Test the Object Slicer extension, which can slice an object into smaller pieces that match the color of original object.
1+
Test the Object Slicer extension, which can slice an object into smaller pieces that match the color of original object.
22

33
Useful for creating death animations such as explosions, crumbling, dissolve, or teleportation effects.
44
Pieces should be a solid white color or the color of the piece not match the original color.
55

66
Tips:
7-
- Pieces are linked to the original object which can be used in other events (i.e. explode away from the original object)
7+
8+
- Pieces are linked to the original object which can be used in other events (i.e. explode away from the original object)

‎examples/old-platformer/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
An example of a basic platformer (Mario-like) game. Jump around and collect as many coins as you can!
22

3-
Platformer games are widely popular, largely because of classics like Sonic, Megaman, or even Teenage Mutant Ninja Turtles. Create your own starting from this template! You will learn about collisions, enemy movements, playing sounds and GDevelop Behaviors.
3+
Platformer games are widely popular, largely because of classics like Sonic, Megaman, or even Teenage Mutant Ninja Turtles. Create your own starting from this template! You will learn about collisions, enemy movements, playing sounds and GDevelop Behaviors.

0 commit comments

Comments
 (0)