https://github.com/talhaahussain/donkey-kong-neat
A Python program to play the first or second level of Donkey Kong Country (SNES, 1996), Jungle Hijinks or Ropey Rampage, using the genetic algorithm NEAT (NeuroEvolution of Augmenting Topologies) and Gymnasium, a maintained fork of OpenAI's Gym.
https://github.com/talhaahussain/donkey-kong-neat
donkey-kong donkey-kong-country donkeykong gymnasium neat neat-python neuroevolution-of-augmenting-topologies openai openai-gym opencv
Last synced: 4 months ago
JSON representation
A Python program to play the first or second level of Donkey Kong Country (SNES, 1996), Jungle Hijinks or Ropey Rampage, using the genetic algorithm NEAT (NeuroEvolution of Augmenting Topologies) and Gymnasium, a maintained fork of OpenAI's Gym.
- Host: GitHub
- URL: https://github.com/talhaahussain/donkey-kong-neat
- Owner: talhaahussain
- License: mit
- Created: 2023-07-09T18:43:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-04T20:38:51.000Z (12 months ago)
- Last Synced: 2025-02-21T07:41:32.641Z (4 months ago)
- Topics: donkey-kong, donkey-kong-country, donkeykong, gymnasium, neat, neat-python, neuroevolution-of-augmenting-topologies, openai, openai-gym, opencv
- Language: Python
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Donkey-Kong-NEAT
A Python program to play the first or second level of Donkey Kong Country (SNES, 1996), Jungle Hijinks or Ropey Rampage, using the genetic algorithm NEAT (NeuroEvolution of Augmenting Topologies) and Gymnasium, a maintained fork of OpenAI's Gym.
### Prerequisites
Requires a valid ROM file (`.sfc`) of Donkey Kong Country, USA version, Rev 2 (SHA-1 sum: cd606e77ab2034438e06891cd2d067dad69b4d1a).
**Please check that you have this specific ROM version, as other versions of Donkey Kong may not work.**
pyenv must be installed, as well as Python version 3.8 (through pyenv). Details for how this may be done can be seen [here](https://github.com/pyenv/pyenv).
Prerequisites are viewable in `requirements.txt`.
### Installation
Clone with:
```shell
git clone https://github.com/talhaahussain/Donkey-Kong-NEAT.git dkc-neat
cd dkc-neat/
```
Install prerequisites with:
```shell
. install.sh
```
or alternatively:
```bash
pip install -r requirements.txt
```
### Configuration
The NEAT algorithm can be configured using `config_feedforward.txt`. More information on how to do this can be seen [here](https://neat-python.readthedocs.io/en/latest/index.html), at NEAT-Python’s documentation.
### Usage
Run with:
```shell
python dkc-retro.py
```
### See also
[Flappy-Bird-NEAT](https://github.com/talhaahussain/Flappy-Bird-NEAT)
### Footnote
This project does not infringe on any intellectual property. Always obtain ROMs from an authentic and legal source - piracy is a crime.