Red1C3 / Another-Kawaii-Chip-8-Emulator

A Chip-8 emulator made with C++, using OpenGL 3.3 as graphical backend

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Another-Kawaii-Chip-8-Emulator

AKCemu for short, is a Chip-8 emulator made with C++ using OpenGL 3.3 as its graphics backend, it also uses SFML audio module for sounds, and GLFW for windowing and input handling

Usage

From terminal opened inside "bin" folder run:

./akcemu ../<your rom name>.ch8

or if you want to specify a resolution

./akcemu <height> <width> <your rom name>.ch8

if any errors occured, a log file will auto-generate containing what error happened

Key Bindings

The emulator uses keyboard keys {1,2,3,4,Q,W,E,R,A,S,D,F,Z,X,C,V} , although not tested in other languages' layouts, it's recommended to change your keyboard language to English before running the emulator

Runtime Prerequisites

  • GLFW runtime libraries
  • GLEW runtime libraries
  • SFML audio runtime libraries

Building

Prerequisites

  • GLFW dev libraries
  • GLEW dev libraries
  • SFML audio dev libraries

With Meson Build System and prerequisites installed on your machine, run:

meson builddir --buildtype=release
cd builddir
ninja

Contribution

Feel free to fork, create issues or make a pull request, I'll do my best to check them out.

License

This project is under MIT License.

Copyright (c) 2021 Mohammad Issawi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Audio "beeping" file was downloaded from Zapslat

Made with love and 8-bit kittens :)

About

A Chip-8 emulator made with C++, using OpenGL 3.3 as graphical backend

License:MIT License


Languages

Language:C++ 86.7%Language:GLSL 12.4%Language:Meson 0.8%Language:Shell 0.1%