Skip to content

Latest commit

 

History

History
122 lines (71 loc) · 3.61 KB

README.md

File metadata and controls

122 lines (71 loc) · 3.61 KB
Raw

Chip-8 Emulator in Ruby 3

Hi! This project is called "CHIP 8 emulator" in Ruby 3 but actually, CHIP 8 is an interpreted programming language, and this is an implementation of it...

If you're interested on knowing more about it, you can check here.

Extras

In case you don't know from where to start or is wondering about some parts of the process for developing this project, you can check the extra section, where I wrote down some notes that maybe could be helpful.

Installation

If you're using debian based distro:

You can just run bin/setup from the root path of the project.

OR

Linux dependencies for both C++ and Ruby

Debian Based Distros

$ sudo apt install build-essential libsdl2-dev libgl1-mesa-dev libopenal-dev \
libgmp-dev libfontconfig1-dev

Other O.S.

Gosu's Gem require couple libs to be installed on your environment, for more information you can check it here

Project's Dependencies

$ bundle install

Usage

To run the project:

  1. Place a rom inside the folder roms/

    1. NOTE: The only acceptable extensions are .o and .ch8, if the game is not with one of this extensions on it's name it'll not show on the menu as an option.

  2. From the root folder run the command: bin/chip8

    1. Navigate through the options using the up/down arrow keys.
    2. Hit enter key to select.

Another alternative to run the project is to follow the commands:

  1. From the root folder run the command bin/chip8 0 'roms/name_of_the_rom.extension'
    1. If you want to enable the debug then set the flag zero to 1

Keyboard

Your Keyboard => CHIP-8 Keybaord

1 2 3 4 => 1 2 3 C

Q W E R => 4 5 6 D

A S D F => 7 8 9 E

Z X C V => A 0 B F

NOTE: This Keyboard is for QWERTY setup.

Other Commands

(Not in the numpad)

  • Number 8 => Reduce ROM speed by 20
  • Number 9 => Increase ROM speed by 20
  • Number 0 => Reset ROM speed to 60Hz

Development

After checking out the repo, run bin/setup to install dependencies (If you're using Debian based linux distros, otherwise check the Other O.S' section).

Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

The used ruby's version is 3.0.2.

Other information

Gems' Details

Detailing the reason on for gems that are non-common gems used in this project.

Gosu

"2D game development library. Gosu provides simple and game-friendly interfaces to 2D graphics and text (accelerated by 3D hardware), sound samples and music as well as keyboard, mouse and gamepad/joystick input."

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lucasmenezesds/chip-8-ruby-3. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the CHIP-8-ruby-3 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.