<h1 align="center">Rust8</h1>
*<p align="center">A Chip-8 Emulator Library in Rust</p>*
<p align="center">
<a href="https://github.com/lagmoellertim/rust8/blob/master/LICENSE" target="_blank"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="MIT License Badge"/></a>
</p>
---
## Introduction
**Rust8** is a modern, high-performance Chip-8 emulator library written entirely in Rust. Designed with both simplicity and efficiency in mind, rust8 provides an easy-to-use API for integrating Chip-8 emulation into your Rust projects.
## Features
- **High Performance**: Leverages Rust's efficiency to ensure fast and reliable emulation.
- **Easy Integration**: Simple API for quick setup in any Rust application.
- **Cross-Platform**: Works on all platforms that Rust supports, including Windows, macOS, and Linux.
## Getting started
### Prerequisites
Before you begin, ensure you have the latest version of Rust installed on your system. If you need to install Rust, follow the instructions on the [official Rust website](https://www.rust-lang.org/tools/install).
### Installation
Add rust8 to your project's `Cargo.toml`:
```toml
[dependencies]
rust8 = "[version of your choice]"
```
or add it using
```shell
cargo add rust8
```
## Contributing
If you are missing a feature or have new idea, go for it! That is what open-source is for! 😃
## Author
**Tim-Luca Lagmöller** ([@lagmoellertim](https://github.com/lagmoellertim))
## Donations / Sponsors
I'm part of the official GitHub Sponsors program where you can support me on a monthly basis.
<a href="https://github.com/sponsors/lagmoellertim" target="_blank"><img src="https://github.com/lagmoellertim/shared-repo-files/raw/main/github-sponsors-button.png" alt="GitHub Sponsors" height="35px" ></a>
You can also contribute by buying me a coffee (this is a one-time donation).
<a href="https://ko-fi.com/lagmoellertim" target="_blank"><img src="https://github.com/lagmoellertim/shared-repo-files/raw/main/kofi-sponsors-button.png" alt="Ko-Fi Sponsors" height="35px" ></a>
Thank you for your support!
## License
The Code is licensed under the
[MIT License](https://github.com/lagmoellertim/rust8/blob/master/LICENSE)
Copyright © 2024-present, [Tim-Luca Lagmöller](https://lagmoellertim.de)
## Have fun :tada: