[![Crates.io][crate-badge]][crate-link]
[![Build success][build-badge]][build-link]

# ship8

This is a working emulator for the CHIP-8 machine built in Rust.
This probably should not be used in production and I am a beginner in Rust so
there are probably better ways to write the code I wrote.

It handles sound, graphics and keyboard input using the SDL2 library.

## Usage

Clone the repository and make sure Rust and Cargo are installed, then run:

```sh
$ cargo run
```

This will start the Pong game bundled with the emulator.
The bundled Pong game was not made by me but it is in public domain.
You can find a lot of games for the CHIP-8 if you type *CHIP-8 free games* on
your favorite search engine.

If you have a CHIP-8 ROM file, you can run in the emulator with the following
command:

```sh
$ cargo run your-rom-file.ch8
```

To get a list of options, run:

```sh
$ cargo run -- -h
```

This will list the options and explain them.
For example, you can change the emulator speed and mute the audio.

## Contribute

If you find a better way to write the code, or if there is a mistake, feel free
to send a pull request or to create an issue.

[crate-link]: https://crates.io/crates/ship8
[crate-badge]: https://img.shields.io/crates/v/ship8.svg?style=flat-square
[build-badge]: https://img.shields.io/travis/aapr0x/ship8.svg?style=flat-square
[build-link]: https://travis-ci.org/aapr0x/calcu