Giter Club home page Giter Club logo

gameboy-emulator's Introduction

๐ŸŽฎ Gameboy Emulator ๐ŸŽฎ

demo

My goal is to introduce myself to low level programming and emulators by writing a gameboy emulator in Rust ๐Ÿฆ€.

๐Ÿงฐ Structure

  • emulator/ - This contains the main Gameboy emulator. You'll find all of the necessary files and the core logic inside this folder.
  • asm/ - This is an assembler for the Gameboy, written in Python ๐Ÿ, made before starting the emulator. It's very basic and I made it only to list and understand each opcodes.

๐Ÿš€ Getting started

If you want to try this out or play around with the code, you can do the following:

๐ŸŽฎ Emulator

Clone the repository:

git clone https://github.com/lowczarc/gameboy-emulator.git

Build and run the emulator (from within the emulator/ directory):

cargo run --release <gameboy_rom>

NOTE: You need to have a gamepad to play, I didn't implement keyboard inputs yet

By default the emulator will spin lock instead of using thread::sleep.
If you're on battery or the 100% CPU usage bothers you, you can use the --thread-sleep option, though it might cause some lags and inaccurate timing.

cargo run --release <gameboy_rom> --thread-sleep

๐Ÿง‘โ€๐Ÿ’ป Assembler

There are some (not very interesting) examples of roms in the asm/ directory and a ton of them you can find using the power of the information superhighway.

Run the assembler (from within the asm/ directory):

python main.py <gbasm_input> <rom_output>

๐Ÿ“ License

This project is licensed under the NPDSML - Nintendo Please Don't Sue Me License

๐Ÿ“š References

gameboy-emulator's People

Contributors

lowczarc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.