Skip to content

Commit

Permalink
add images to README
Browse files Browse the repository at this point in the history
  • Loading branch information
azabicki authored Feb 18, 2024
1 parent f5cd93e commit def6e29
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

>:: a python gui to keep track of scores _while_ playing [**Doomlings**](https://doomlings.com/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Introduction

Expand Down Expand Up @@ -110,13 +111,17 @@ I hope that the handling is self-explanatory. Especially if you've already playe
- Since `Prepper` is able to choose the world's end effect, you may need to change it manually
- As soon as every _trait's world's end effects_ are resolved, click on th `GO!` button to activate the actual _world's end effect_
- **Settings:**
- As a joke, we thought it could be funny to make own sound-snippets and record all the "quotes" on top of every trait. But until now, we only added some generic mp3's. Turn it only and be surprised :)
- You can change what icons will be shown in the trait pile:
- ![icons_default](./doompy/images/icons_on.png | width=20) `Default`: basic infos about the trait + effects
- `none`: only effects
- `full`: all icons


- As a joke, we thought it could be funny to record our own little sound-snippets of all the "quotes" on top of every trait. But until now, we only added some generic mp3's. Turn it only and be surprised :smile: (or annoyed :roll_eyes:)
- <img src="./doompy/images/note_off.png" width="18" vertical-align="middle"> `Music Off`: basic infos about the trait + effects
- <img src="./doompy/images/note_on.png" width="18" vertical-align="middle"> `Music On`: basic infos about the trait + effects
- You can change what trait property icons will be shown in the trait pile:
- <img src="./doompy/images/icons_on.png" width="18" vertical-align="middle"> `Default`: basic infos about the trait + effects
- <img src="./doompy/images/icons_off.png" width="18" vertical-align="middle"> `none`: only effects
- <img src="./doompy/images/icons_full.png" width="18" vertical-align="middle"> `full`: all icons
- Select scoring mode, i.e. how the current scores are shown:
- <img src="./doompy/images/points_123.png" width="18" vertical-align="middle"> `Points`:
- <img src="./doompy/images/rank.png" width="18" vertical-align="middle"> `Points`:
- <img src="./doompy/images/question_mark.png" width="18" vertical-align="middle"> `Points`:

### Scoreboard

Expand All @@ -129,7 +134,8 @@ I hope that the handling is self-explanatory. Especially if you've already playe


### Keyboard shortcuts

> [!TIP]
> Use keyboard shortcuts!
## Discussion

Expand All @@ -138,4 +144,4 @@ I hope that the handling is self-explanatory. Especially if you've already playe
- issues are the way to go


[zip]: https://github.com/azabicki/DoomPy/archive/refs/heads/main.zip
[zip]: https://github.com/azabicki/DoomPy/archive/refs/heads/main.zip

0 comments on commit def6e29

Please sign in to comment.