diff --git a/README.md b/README.md index 5423897..6f2c2ed 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,11 @@ +
+ Banner +
+ # 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 @@ -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 @@ -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: diff --git a/res/banner.png b/res/banner.png new file mode 100644 index 0000000..21888cd Binary files /dev/null and b/res/banner.png differ