Skip to content

Commit

Permalink
Add contributions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavwilliam committed Aug 1, 2024
1 parent 4bbc074 commit d01c8cc
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,12 @@ Follow the main character Maria as she sets out on an epic journey to becoming a
## Map

![Map](presentation/levels.png)

The levels 1-11 consist of both multiple-choice questions and code writing challenges, to make learning exciting and really challenge your unstanding of the topics at hand.

There are also three *special* levels A, B and C, outside of the main storyline, which tackle code golfing. If your brain doesn't get overloaded from the compact information in oneliners and hacky ways of writing code, these levels perfect for you!

### Navigation
![Map navigation](/presentation/map-navigation.png)

To move between levels in Python Adventures, we have created a vibrant map that can be easily navigated using Discord's interaction buttons. The map is dynamically generated for the user, taking into account factors such as the following:
- **Unlocked levels**, including special levels
- **Completed levels**
Expand All @@ -35,7 +33,6 @@ In order to not clutter up the chat, navigation simply edits the original intera
## Levels
### Limited lives
![Lives](bot/assets/guide-hearts.png)

With three lives comes a maximum of three mistakes before you have to restart the level. This keeps the game exciting and turns the difficulty of even the multiple choice questions up a notch.

### Code evaluation
Expand All @@ -50,7 +47,6 @@ Sometimes you get stuck on a problem. While revealing the answer straight away w

### Success/defeat/win screens
![Status screens](presentation/level-statuses.png)

With vibrant success/fail messages depending on how a level went for the player, we hope to keep the player engaged and excited to move toward the next goal. The images above are some of these and are displayed in the following situations:
- **Level failed**: the user fails a level
- **Level success**: the user completes a level
Expand Down Expand Up @@ -130,3 +126,14 @@ Install the dependencies using `pip install -r requirements.txt`. If you are dev
- Update the IDs of every emoji in `bot/config.py`
5. **Run the Bot**: `python bot/main.py`
# Contributions
This is a rough overview of what each team member has contributed:
- @gustavwilliam: graphics, map functionality and question+level classes
- @Noble-47: database functionality
- @jspmic: level questions, documentation and a (sadly not merged in time) help command
- @HeavenMercy: game intro video in this readme, linting and dotenv usage
- @Deja-Vu1: basic bot setup and discord developer portal instructions
Furthermore, each team member has contributed with valuable ideas and feedback throughout the development process.

0 comments on commit d01c8cc

Please sign in to comment.