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 c0815af commit 7cc7bda
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
## <img src="./readme-doc/app-icon.png" alt="logo" width="18"> Pokemon <img src="./readme-doc/app-icon.png" alt="logo" width="18">

<img src="./readme-doc/landing-bg.gif" alt="landing" width="400">
<img src="./readme-doc/landing-bg.gif" alt="landing" width="360">

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

### 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.

### AI Opponents ⚔️
- **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.*

#### 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).
21 changes: 21 additions & 0 deletions readme-doc/run-jar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Running `.jar`

To execute the `.jar` file, please be aware of the following dependencies:
```
JavaFX Version: 17.0.11
JavaFX Runtime Version: 17.0.11+3
```

### Windows
1. Set `%PATH_TO_FX%` to the JavaFX SDK path, which you can [download from here](https://gluonhq.com/products/javafx/).
2. Run the following command in `cmd`:
```shell
java --module-path "%PATH_TO_FX%" --add-modules javafx.controls,javafx.fxml,javafx.media --add-opens javafx.graphics/com.sun.glass.utils=ALL-UNNAMED --add-opens javafx.media/com.sun.media.jfxmedia=ALL-UNNAMED --add-opens javafx.graphics/com.sun.glass.ui=ALL-UNNAMED --add-opens javafx.graphics/com.sun.javafx.application=ALL-UNNAMED -jar Pokemon.jar
```
<i>*I know the command is very long, but bear with me, it works just fine</i>

### Linux
Linux should be much simpler, just run the following command:
```bash
java -jar Pokemon.jar
```

0 comments on commit 7cc7bda

Please sign in to comment.