Low-level Nintendo64 emulator 🌏
Find a file
2023-08-16 19:22:33 +09:00
roms Add public domain ROMs 2023-08-05 21:01:06 +09:00
src clang-format 2023-08-16 19:22:33 +09:00
tests Make fast and add tests (#56) 2023-07-28 02:32:33 +09:00
third_party Create Window with SDL 2023-08-07 02:03:47 +09:00
.clang-format Update .clang-format 2023-08-03 23:45:13 +09:00
.gitignore Build parallel-rdp 2023-08-06 14:32:48 +09:00
.gitmodules Add imgui to submodule 2023-08-09 17:35:13 +09:00
CMakeLists.txt Add initial SDL2 frontend 2023-08-07 00:32:24 +09:00
CONTRIBUTING.md Update CONTRIBUTING.md 2023-08-07 01:28:27 +09:00
README.md Add initial SDL2 frontend 2023-08-07 00:32:24 +09:00
sdl2-config.cmake Add initial SDL2 frontend 2023-08-07 00:32:24 +09:00

n64-emu

An experimental Nintendo 64 emulator.

NOTE

n64-emu is in a very early stage of development now. No commercial ROM can run on it.

Build

We do not distribute pre-build binaries. You need to build from source.

Prerequisites

  • Little endian machine
  • a C++ compiler compatible with C++20
  • CMake

We support MSVC++. Clang and GCC are not tested for now.

Linux

sudo apt install cmake libsdl2-dev g++

git clone --recursive git@github.com:kmc-jp/n64-emu.git
cd n64-emu
mkdir build
cd build
# configure build
cmake ..
# build
make # or cmake --build . 

Windows

  1. Donwload SDL2 from https://github.com/libsdl-org/SDL/releases and extract it.
  2. Set SDL2_DIR environment variable point that to the location where you extracted the SDL2 development package.
  3. Run the follwoing commands
git clone --recursive git@github.com:kmc-jp/n64-emu.git
cd n64-emu
mkdir build
cd build
# configure build
cmake ..
# build
make # or cmake --build . 

macOS

TODO

Run

Only the z64 format (big enddian) is supported.

./n64[.exe] <rom_file.z64>

Test

# In build directory
ctest -C Debug

Contributing

We do not currently accept pull requests to add new feature. But bug reports and bug fixes are always welcome 😀 See CONTRIBUTING.md(ja).

Acknowledgements

Big thanks to Dillon for the ROMs n64-tests.