Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
eesuhn committed Aug 31, 2024
1 parent 7cc7bda commit 0a209ca
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

A **Scala-based** game recreating the iconic Pokemon battles from *Game Boy*

[<u>**Check out the Demo**</u>](https://www.youtube.com/watch?v=dAXEsYox5lI) 🌱

### Pokemon & Moves 🐉
- **100+ Pokemon**: Wide range of Pokemon, each with its *unique stats*.
- **100+ Moves**: From *physical* to *status* moves, offering strategic choices in battle.
Expand All @@ -12,19 +14,27 @@ A **Scala-based** game recreating the iconic Pokemon battles from *Game Boy*
- **Weighted Move Selection**: Select moves factoring in *move effectiveness* and *type advantages*.
- **Smart Switching**: Switches to Pokémon that has *type advantage* over the player’s active Pokémon.

#### Requirements 🛠️
- Scala 2.11.*
- SBT 1.10.*
- Java 17
- JavaFX 17.*
<img src="./readme-doc/sample-battle.gif" alt="landing" width="360">

### Requirements 🛠️
```
Scala 2.11.*
SBT 1.10.*
Java 17
JavaFX 17.*
```

#### Running the Game 🎮
If you running `.jar` from [releases](https://github.com/eesuhn/Pokemon/releases/tag/v1.1), make sure to [check out the doc](./readme-doc/run-jar.md).
### Running the Game 🎮
If you running `.jar` from [releases](https://github.com/eesuhn/Pokemon/releases/tag/v1.1), make sure to [check out the doc](./readme-doc/run-jar.md)

Run the following command if you running from source:
```
sbt compile run
```

#### Background Work 🛠️ <i>*If you plan to contribute</i>
- **Assets Automation**: Automatically scrap and manipulate assets using `FFmpeg, BeautifulSoup, Pillow`. [Check out the script](https://github.com/eesuhn/pokemon-res).
### Background Work 🛠️
<i>*If you plan to contribute</i>
- **Assets Automation**: <br>
Automatically scrap and manipulate assets using `FFmpeg, BeautifulSoup, Pillow`. [Check out the script](https://github.com/eesuhn/pokemon-res)
- **Sprites**: Extracted from [Pokemon Database](https://pokemondb.net/pokedex/all)
- **SFX**: Extracted from [SFX Gen 5](https://downloads.khinsider.com/game-soundtracks/album/pokemon-sfx-gen-5-attack-moves-blk-wht-blk2-wht2)
Binary file added readme-doc/sample-battle.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0a209ca

Please sign in to comment.