Skip to content

Commit

Permalink
docs (flappybird/): improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
maelbecel committed Jan 10, 2024
1 parent de805a6 commit 8dc4009
Show file tree
Hide file tree
Showing 11 changed files with 1,500 additions and 2 deletions.
3 changes: 3 additions & 0 deletions doc/Writerside/hi.tree
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@

<toc-element topic="Home.md">
<toc-element topic="Examples.md">
<toc-element topic="example-flappybird.md">
<toc-element topic="tuto-flappy.md"/>
</toc-element>
<toc-element topic="Application.md"/>
<toc-element topic="Application-with-a-sprite-renderer.md"/>
<toc-element topic="Default-System.md"/>
Expand Down
Binary file added doc/Writerside/images/flappybird.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion doc/Writerside/topics/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ There is a folder ```/Examples``` to check for example
4. [Entity Component System](Entity-Component-System.md)
5. [ImGui](ImGui.md)
6. [Network](example_network.md)
7. [Script](example-script.md)
7. [Script](example-script.md)
8. [FlappyBird](example-flappybird.md)
2 changes: 2 additions & 0 deletions doc/Writerside/topics/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ There is a folder ```/Examples``` to check for example

Feel free to explore and learn more about each aspect of the RType game engine!

You can also try the FlappyBird example in the folder ```/flappybird```

## Contributing

If you are interested in contributing to the RType game engine, please read our [contributing guidelines](CONTRIBUTING.md) for more information.
Expand Down
24 changes: 24 additions & 0 deletions doc/Writerside/topics/example-flappybird.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# FlappyBird

## Description

The Flappy bird is a game where the player controls a bird, attempting to fly between columns of green pipes without hitting them.
Here we have make a new version, with the same gameplay, but with a different design.

## Usage

The player can control the bird with the space bar, and the goal is to pass between the pipes without touching them.

You can build it with the following command

```bash
echo 2 | ./make.sh && yes | mv ./SandBoxGames ./flappybird && cd flappybird && ./SandBoxGames
```

## Gameplay

![flappybird.png](flappybird.png)

## How to recreate the game

[Here](tuto-flappy.md) is the link to the tutorial to recreate the game.
Loading

0 comments on commit 8dc4009

Please sign in to comment.