Skip to content

Commit 4f6a83c

Browse files
committed
updated readme
1 parent 593f723 commit 4f6a83c

1 file changed

Lines changed: 18 additions & 9 deletions

File tree

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![C/C++ CI](https://github.com/pfedick/DeckerGame/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/pfedick/DeckerGame/actions/workflows/c-cpp.yml)
22

3-
# Decker - The Game
3+
# George Decker - The Game
44

55
<p align="center">
66
<img src="https://github.com/pfedick/DeckerGame/raw/main/res/screenshots/Screenshot_20210724_193500.jpg" />
@@ -11,12 +11,14 @@ This is my attempt of writing a Jump'n'Run game in C++. It uses the [Simple Dire
1111

1212
It features George Decker, one of the main characters of my Lego(tm) stopmotion film [The Adventures Of Charlie and George Decker](https://youtu.be/-aJDTe_obKI), which I made a few years ago and is available on YouTube.
1313

14+
It is a classic Jump'n'Run game like Super Mario Brothers. You have to collect coins and other things,
15+
avoid enemies and traps, find keys to open doors and solve other small puzzles.
1416

1517
## What's the status of the game?
16-
The game is in development and I already implemented a lot of the features I
17-
had in mind, when I started this project. The graphics and sound engine is complete,
18-
we have physics and a particle system, where we can generate smoke, fire, rain and water.
19-
A test level is complete and fully playable and I'm working on more levels with different themes.
18+
The game is in development since summer 2021 and all game mechanics are implemented. This includes
19+
the graphic and sound engine, physics and particles, which can be used to generate smoke, fire, rain and water.
20+
And of course, next to the playable character, there are a lot of enemies and traps.
21+
There is a tutorial and several other playable levels, and it got a nice little render intro, too.
2022

2123
### Things which are ongoing
2224

@@ -60,13 +62,16 @@ There is probably more, which I'm not aware of, yet ;-)
6062
- floater
6163
- lasers
6264
- arrows from wall
63-
- locked door
65+
- locked doors
6466
- key (used to unlock a locked door)
6567
- mushroom (white minifig with big red hat and white dots)
6668
- scorpion
69+
- bat
70+
- bird
6771
- ostrich
6872
- Wallenstein
69-
- Helena (but she make no damage yet)
73+
- Helena
74+
- Yeti
7075
- how does sound work with SDL?
7176
- write the audio engine
7277
- how to integrate sound track and sound effects into the game
@@ -79,6 +84,7 @@ There is probably more, which I'm not aware of, yet ;-)
7984
- ui for special objects
8085
- refine physics for jumping & falling
8186
- particle effects
87+
- pathfinding for ai enemies
8288

8389
## How to control the player
8490

@@ -88,15 +94,16 @@ The player can be controlled by the arrow keys or alternatively with "wasd" or "
8894
- cursor left / a / j: walk to the left
8995
- cursor right / d / l: walk to the right
9096
- shift left / shift right: walk faster, jump higher
91-
- e: action key, it activates switches or open doors
97+
- e / o: action key, it activates switches or open doors
98+
- space: skip the intro video
9299

93100
When walking an pressing the key for up, the player will jump in the direction of walking.
94101

95102

96103
## On what platforms will the game be available
97104
My target platforms are:
98105

99-
- Linux (development is done on Fedora)
106+
- Linux (development is done on Fedora 38)
100107
- Windows 10
101108

102109
The game will be open source and uses the [Simple DirectMedia Layer](https://www.libsdl.org/)
@@ -185,10 +192,12 @@ You can find a lot of videos about the game on my channel on YouTube and Twitch:
185192
* YouTube: https://www.youtube.com/@PatrickFedick
186193
* Twitch: https://www.twitch.tv/pfedick
187194
* Mastodon: https://mastodon.de/@patrickf
195+
* Discord: https://discord.gg/QZXPNFKNKP
188196

189197

190198
## Release History
191199

200+
* [0.13.0](https://github.com/pfedick/DeckerGame/releases/tag/0.13.0) [2023-09-01]: Intro
192201
* [0.12.0](https://github.com/pfedick/DeckerGame/releases/tag/0.12.0) [2023-08-19]: Tutorial and Speech
193202
* [0.11.0](https://github.com/pfedick/DeckerGame/releases/tag/0.11.0) [2023-08-10]: Pathfinding and Blood Update
194203
* [0.10.0](https://github.com/pfedick/DeckerGame/releases/tag/0.10.0) [2023-07-30]: Water update

0 commit comments

Comments
 (0)