Giter Club home page Giter Club logo

octarou's Introduction

octarou

License Nix build status Github Pages

A cross-platform CHIP-8 interpreter, featuring a simple UI (powered by egui). The following platforms are supported:

  • Linux
  • Windows
  • macOS
  • Web (parially)

The interpreter fully implements:

  • the original COSMAC VIP CHIP-8 instruction set.
  • the SUPER-CHIP 1.1 extension

I might implement support for other variants (for example, XO-CHIP).

One of my main goals with this project is for it to be as "correct" as possible, so should you discover any issues with this implementation, please feel free to open an issue.

Screenshot

Building with Nix

The project can be built using the provided Nix flake.

Linux and *NIXes

# build
nix build github:nikoof/octarou
./result/bin/octarou --help
# ...or run it directly
nix run github:nikoof/octarou

Windows

Building for Windows is done via cross-compilation with Nix on a Linux host.

nix build github:Nikoof/octarou#x86_64-pc-windows-gnu

The resulting binary is at result/bin/octarou.exe.

Building manually

Alternatively, you can clone the repo and compile the project natively on all major platforms, provided you have all dependencies for egui installed.

git clone https://github.com/nikoof/octarou && cd octarou
cargo run --release

Credits

This project would not have been possible without Tobias Langhoff's Guide and Timendus' Test Suite. I am extremely grateful to both authors for these amazing resources.

Resources used:

License

Copyright (c) Nicolas-Ștefan Bratoveanu, 2023-2024, licensed under the EUPL-1.2-or-later.

octarou's People

Contributors

nikoof avatar

Stargazers

 avatar  avatar

Watchers

 avatar

octarou's Issues

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.