https://github.com/dylangageot/mechgah
Mechgah is an accurate NES emulator, developped for Linux and written in C.
https://github.com/dylangageot/mechgah
6502 c emulator nes object-oriented
Last synced: 10 months ago
JSON representation
Mechgah is an accurate NES emulator, developped for Linux and written in C.
- Host: GitHub
- URL: https://github.com/dylangageot/mechgah
- Owner: dylangageot
- Created: 2019-06-10T10:15:18.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-27T09:53:54.000Z (over 5 years ago)
- Last Synced: 2025-10-09T14:05:37.387Z (10 months ago)
- Topics: 6502, c, emulator, nes, object-oriented
- Language: C
- Homepage:
- Size: 4.13 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mechgah README
## Why develop a new NES emulator?
This project is born in our engineering school ([INSA Rennes](https://www.insa-rennes.fr/), France) as part of a C language programming course. For one semester, in a team of four, we had to demonstrate our knowledge on a practical case. We had the choice of the subject, so we chose to develop a NES emulator because we thought (and it was) that it could train us on some aspect of computer architecture with the 6502 that NES use and, by the way, learn how gaming was in the past. This work was possible with the tons of documentation that is available on [NESdev](https://nesdev.com/).
Our team is composed of:
- Baptiste **Me**hat (CPU, PPU)
- Nicolas **Ch**abanis (CPU, Loader, Controller)
- Dylan **Ga**geot (CPU, PPU, NROM Mapper)
- Nicolas **H**ily (CPU, Controller, SDL)
## Dependencies
Our NES emulator depends on various library, which are:
- libsdl1.2-dev
- libsdl-gfx1.2-dev
- [cmocka](https://cmocka.org/)
You can install libsdl1.2-dev and libsdl-gfx1.2-dev with this command on Ubuntu :
```bash
sudo apt install libsdl1.2-dev libsdl-gfx1.2-dev
```
## Makefile
```bash
make # build mechgah executable (you can precise mechgah)
make run-test # build unit test and run it with Valgrind
# and code coverage feature
make doc # build Doxygen documentation from doxyfile
make clean # clean every generated file (including coverage and doc dir)
```
## CMake
Run the following command to compile this project through CMake:
```bash
cmake . -Bbuild
cd build
make mechgah # build mechgah executable
make utest # build unit test
```
If you want to launch unit tests, run ./build/utest from the root of the repository (that is because our unit tests use relative path for file opening). If you are using CLion, precise executables working directory to root path.
## User manual
### Synopsis
```bash
./mechgah [OPTION]... [ROM]
```
### Description
Launches the NES emulator on the given ROM filename and with the given OPTION. If no ROM filename is given, the emulator won't launch. If multiple filenames are given, the emulator will launch with the first one.
### Options
-s [scale]
Defines the scaling factor. Must be between 1 (genuine resolution) and 15 (4K resolution).
If not specified, scaling factor is set to 2.
## Screenshot
## Todo
- Add APU
- Add mappers
- Enhance PPU behavior (optimization with prediction algorithm)
- Troubleshoot Controller (aren't working after a Game Over on *Super Mario Bros.*)