Skip to content

Commit

Permalink
Improve examples descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
ClementPasteau committed Nov 22, 2024
1 parent 7a510fc commit 3ed39d8
Show file tree
Hide file tree
Showing 21 changed files with 47 additions and 36 deletions.
4 changes: 2 additions & 2 deletions examples/button-effects/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Change the way a button looks based on the state of the button

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

Multiple behaviors are provided and they can be combined to make a juicy button with animated responses to user input.
Expand All @@ -11,4 +11,4 @@ Multiple behaviors are provided and they can be combined to make a juicy button
- Button size (scale) tween
- Button color (tint) tween
- Button opacity tween
- Button angle tween
- Button angle tween
4 changes: 3 additions & 1 deletion examples/downhill-bike-physics-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Try to cross the finish line as fast as possible without falling over! And remember to pedal safe!

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.
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.
2 changes: 1 addition & 1 deletion examples/game-feel-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
A demo showing how to enhance the "game feel" of your project: VFX, shot trail, ambient sounds and SFX, screenshake, wobble...

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!
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!
2 changes: 1 addition & 1 deletion examples/geometry-monster/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
A hyper casual endless game where you have to collect shapes and avoid bombs, with a progressively increasing difficulty.

Start from this example to create your own catch game! You will learn about collisions, particle emitters, and how to set up a menu.
Start from this example to create your own catch game! You will learn about collisions, particle emitters, and how to set up a menu.
15 changes: 8 additions & 7 deletions examples/multiplayer-jump-game/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
An online multiplayer physics game where try to collect all of the apples in the game without throwing your keyboard through your monitor.
An online multiplayer physics game where you try to collect all of the apples in the game without throwing your keyboard through your monitor.

This game example includes:
-Multiplayer lobby
-Multiplayer chat
-Physics behavior
-Tween behavior
-Sound effects
-Text objects

- Multiplayer lobby
- Multiplayer chat
- Physics behavior
- Tween behavior
- Sound effects
- Text objects
4 changes: 2 additions & 2 deletions examples/not-a-vania/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
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.

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.
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.

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

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.

The finite state machine tutorial at: http://wiki.compilgames.net/doku.php/gdevelop5/tutorials/finite_state_machine
The finite state machine tutorial at: http://wiki.compilgames.net/doku.php/gdevelop5/tutorials/finite_state_machine
5 changes: 3 additions & 2 deletions examples/object-slicer/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Test the Object Slicer extension, which can slice an object into smaller pieces that match the color of original object.
Test the Object Slicer extension, which can slice an object into smaller pieces that match the color of original object.

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

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

- Pieces are linked to the original object which can be used in other events (i.e. explode away from the original object)
2 changes: 1 addition & 1 deletion examples/old-platformer/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
An example of a basic platformer (Mario-like) game. Jump around and collect as many coins as you can!

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.
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.
2 changes: 1 addition & 1 deletion examples/papa-is-you/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Building upon the sokoban example, it adds mechanics similar to Baba is You, a hit indie puzzle game made by Arvi Teikari in 2019.

In this example, you play using typical Sokoban controls, but there is a twist: you'll also push text blocks that change the game rules to solve puzzles.
In this example, you play using typical Sokoban controls, but there is a twist: you'll also push text blocks that change the game rules to solve puzzles.
2 changes: 1 addition & 1 deletion examples/particle-effects-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
A demo of various high quality particle effects (fire, magic, snow, rune spell...) that you can try and use in your game.

The devil is in the details and this little detail is often found in particles! Explore the possibilities GDevelop offers to make a visually stunning game with the Particle Emitter object.
The devil is in the details and this little detail is often found in particles! Explore the possibilities GDevelop offers to make a visually stunning game with the Particle Emitter object.
4 changes: 3 additions & 1 deletion examples/platformer-room-camera/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
This example shows hows to move camera in between rooms using tweens.

In this example, the camera will smoothly move into the next room when the player leaves it in any of the cardinal directions. The examples also has the additions that the player will get an additional jump when jumping up into a transition and will be kept within the current frame when the transition is in progress.
In this example, the camera will smoothly move into the next room when the player leaves it in any of the cardinal directions.

The example also has the additions that the player will get an additional jump when jumping up into a transition and will be kept within the current frame when the transition is in progress.
2 changes: 1 addition & 1 deletion examples/platformer/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
An example of a basic platformer (Mario-like) game. Jump around and collect as many coins as you can!

Check out [the YouTube video](https://www.youtube.com/watch?v=eU0kkLSdw0Y&list=PL3YlZTdKiS898Wio0tvKjQM0x3zo4V0Mb) explaining how this example was made.
Check out [the YouTube video](https://www.youtube.com/watch?v=eU0kkLSdw0Y&list=PL3YlZTdKiS898Wio0tvKjQM0x3zo4V0Mb) explaining how this example was made.
1 change: 1 addition & 0 deletions examples/plinko/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ In this game the player drops their pachinko ball in an effort to hit as many pe
The Plinko example showcases the physics behavior and how it along with other tools, like the object shake extension, can create a fun and juicy game.

The example features:

- Physics engine 2.0
- Object shake
- Particles
Expand Down
1 change: 1 addition & 0 deletions examples/rhythm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Basic example of how to create a music game like Dance Dance Revolution or Frida

When the song ends, the game calculates the scores and decides who wins.
Controls are:

- AWSD for player 1
- LEFT,RIGHT,UP,DOWN for player 2
- Enter for start the game
Expand Down
10 changes: 5 additions & 5 deletions examples/shootalia-top-down-shooter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ With this, you can start a new top-down shooter game in minutes.

## Controls

* Use the mouse to aim,
* A or Left arrow: Left,
* D or Right arrow: Right,
* W or Up arrow: Up,
* S or Down arrow: Down.
- Use the mouse to aim,
- A or Left arrow: Left,
- D or Right arrow: Right,
- W or Up arrow: Up,
- S or Down arrow: Down.
11 changes: 6 additions & 5 deletions examples/simple-platformer/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
A simple platformer example game where the player can pick up coins to improve their score and die to an enemy character or by falling off of platforms.

This example features:
-Platformer behavior
-Smooth camera behavior
-Mobile controls
-Various types of platforms
-Basic enemy movement

- Platformer behavior
- Smooth camera behavior
- Mobile controls
- Various types of platforms
- Basic enemy movement
2 changes: 1 addition & 1 deletion examples/space-asteroids/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ Juicy remake of the classic asteroids game using the physics 2.0 behavior.

This example shows how to add game juice with particles, sound effects, screen shake and everything that makes a game feel good to play.

Check out [the YouTube video](https://www.youtube.com/watch?v=w1SCpQ-mRCk&list=PL3YlZTdKiS8_Q8UPu2BJV5P5gYA-Q-k19) explaining how this example was made.
Check out [the YouTube video](https://www.youtube.com/watch?v=w1SCpQ-mRCk&list=PL3YlZTdKiS8_Q8UPu2BJV5P5gYA-Q-k19) explaining how this example was made.
2 changes: 1 addition & 1 deletion examples/space-shooter/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
A beautiful, retro side-scrolling shooter where you must defeat incoming enemies with your mecha transforming spaceship. Huge boss included!

Discover how to organize your ambitious project, by keeping a clean tidy creating environment! Check out how this template uses behaviors made with love by the community and also its very own function for dedicated logic.
Discover how to organize your ambitious project, by keeping a clean tidy creating environment! Check out how this template uses behaviors made with love by the community and also its very own function for dedicated logic.
4 changes: 3 additions & 1 deletion examples/top-down-adventure-camera/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
A top down action adventure/action RPG style camera.

It allows for following the player within the boundaries of a single room, and then smoothly slides the camera to the next room after the player enters it. It also freezes the player's controls and enemies while the room transition is occurring.
It allows for following the player within the boundaries of a single room, and then smoothly slides the camera to the next room after the player enters it.

It also freezes the player's controls and enemies while the room transition is occurring.
2 changes: 1 addition & 1 deletion examples/virtual-joystick/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Demonstrate how to use a multitouch joystick and buttons.

The example uses art from Kenney.nl game assets. The art can be found in the integrated GDevelop assets store.
The example uses art from Kenney.nl game assets. The art can be found in the integrated GDevelop assets store.
2 changes: 1 addition & 1 deletion examples/wave-defense-shooter/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Create a wave defense game without coding, using GDevelop. This beginner-friendly example covers player movement, firing a bullet, enemy logic, leveling up character stats, mobile controls, and spawning the enemies.

Example made along with this tutorial series for GDevelop: https://www.youtube.com/watch?v=mckuSpr8vio&list=PL3YlZTdKiS8_R32-DlXGi7YGZNfG7B8Vf&ab_channel=GDevelop
Check out [the YouTube series](https://www.youtube.com/watch?v=mckuSpr8vio&list=PL3YlZTdKiS8_R32-DlXGi7YGZNfG7B8Vf&ab_channel=GDevelop) explaining how this example was made.

0 comments on commit 3ed39d8

Please sign in to comment.