Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
msosav committed Sep 17, 2024
1 parent 6b572e7 commit fe58625
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
<div align="center">
<img src="./res/banner.png" alt="Banner" width="100%">
</div>

# The Legend of Zelda: Reinforcement Learning

This repository contains the code for the project "The Legend of Zelda: Reinforcement Learning", it's purpose is to train an agent to play the game "The Legend of Zelda: Link's Awakening" for GameBoy using Reinforcement Learning.

## Dependencies

- `Python 3.11`
- `pyboy`
- `numpy`
- `pytorch`
- `gymnasium`
- `stable-baselines3`
- `opencv-python`

## Installation

Clone the repository
Expand All @@ -28,6 +22,12 @@ python -m venv venv
source venv/bin/activate
```

Install pytorch

```bash
pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu
```

Install the requirements

```bash
Expand All @@ -38,6 +38,9 @@ pip install -r requirements.txt

The program is divided into two main parts: the training and the testing.

> [!NOTE]
> You need to create a folder called `roms` in the root of the project and put the rom of the game "The Legend of Zelda: Link's Awakening" for GameBoy in it and name it `ZeldaLinksAwakening.gb`.
### Training

To train the agent, run the following command:
Expand Down
Binary file added res/banner.png
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 fe58625

Please sign in to comment.