RV64GC Emulator Software Suite

This repository houses the software and associated assets for the RV64GC Emulator, a RISC-V emulator developed in C++20.

Contained within this repository are the Linux buildroot configuration and a port of DOOM, both compatible with the RV64GC Emulator.

Setup
Building Linux
DOOM Port
Linux with DOOM
Dependencies and Credits
License

Setup

Initially, compile the emulator by adhering to the instructions available in the Emulator's git directory. Once the build is complete, copy the executable (located in the build/rv64gc_emu) to the root of this git repository.

Building Linux

To build the Linux kernel and OpenSBI bootloader for this emulator, first install the dependencies (Linux only):

sudo apt install -y git build-essential wget cpio unzip rsync bc libncurses5-dev screen bison file flex

After that, execute the build with:

make linux

Then, run it via the following command:

make run_linux

When the emulator is compiled using the Native CLI flag, it results in faster boot times for Linux.

DOOM Port

In order to build the DOOM port, place a .wad file in the root of this git repository. For the baremetal build, execute the following command:

make doom_baremetal

Next, to run the port, use the following command:

make run_doom_baremetal

Linux with DOOM

To build and run DOOM under Linux, first you need to compile riscv64 gnu toolchain with libc. To do that, first install the dependencies:

sudo apt-get install autoconf automake autotools-dev curl python3 python3-pip libmpc-dev libmpfr-dev libgmp-dev gawk build-essential bison flex texinfo gperf libtool patchutils bc zlib1g-dev libexpat-dev ninja-build git cmake libglib2.0-dev

Then clone, configure and install riscv-gnu-toolchain:

git clone https://github.com/riscv-collab/riscv-gnu-toolchain.git
cd riscv-gnu-toolchain
./configure --prefix=/opt/riscv --with-cmodel=medany
sudo make linux
echo 'export PATH="/opt/riscv/bin/:\$PATH"' >> ~/.bashrc

Then, restart your terminal and from the root of this git directory do:

make linux_with_doom

And run it with

make run_linux

When Linux boots and you get Buildroot login: prompt, enter root. After that, run doom by typing in:

/doom/doom

Please note that running DOOM will not work if the emulator was compiled with the Native CLI flag.

Dependencies and Credits

MesloLGS NF Regular font - included as font.ttf in the misc folder
doomgeneric - used as a DOOM port
buildroot - used for the Linux build environment

License

This repository is licensed under the GNU GPLv3.

The RISC-V trade name is a registered trademark of RISC-V International.

The DOOM name and logo are trademarks or registered trademarks of id Software LLC.

bane9/rv64gc-emu-software