# Mega Man 64: Recompiled
Mega Man 64: Recompiled is a project that uses [N64: Recompiled](https://github.com/Mr-Wiseguy/N64Recomp) to statically recompile Mega Man 64 into a native port with modern rendering, configurable controls, and quality-of-life features.

This repository and its releases do not contain game assets. You must provide your own legal ROM dump.

## Table of Contents
- [System Requirements](#system-requirements)
- [Features](#features)
- [FAQ](#faq)
- [Building](#building)
- [Libraries Used and Projects Referenced](#libraries-used-and-projects-referenced)

## System Requirements
A GPU supporting Direct3D 12 (Shader Model 6), Vulkan 1.2, or Metal Argument Buffers Tier 2 is required.

On x86-64 PCs, a CPU with SSE4.1 support is required. ARM64 builds run on ARM64 CPUs.

If startup crashes occur, update GPU drivers first.

## Features
#### Plug and Play
Provide the supported Mega Man 64 ROM from the launcher and start playing. No separate extraction step is required for normal gameplay.

#### Modern Graphics Options
Graphics API, resolution, aspect ratio, anti-aliasing, and related rendering options can be configured in-game.

#### High Framerate Support
The renderer supports modern display refresh rates while preserving original gameplay timing.

#### Widescreen and Ultrawide Support
The port supports modern aspect ratios with configurable HUD behavior.

#### Menu-Driven Configuration
Gameplay, graphics, audio, and control options are configurable from the in-game UI.

## FAQ
#### Where are save files stored?
- Windows: `%LOCALAPPDATA%\MegaMan64Recompiled\saves`
- Linux: `~/.config/MegaMan64Recompiled/saves`
- macOS: `~/Library/Application Support/MegaMan64Recompiled/saves`

#### Can I run this in portable mode?
Yes. Place a file named `portable.txt` next to the executable. Saves/config/mod data will be written beside the executable.

#### Can I use arbitrary N64 ROMs?
No. This project targets Mega Man 64 only. It is not a general-purpose emulator.

## Building
Prebuilt releases are intended for players. If you want to build from source, see [BUILDING.md](BUILDING.md).

## Libraries Used and Projects Referenced
- [RT64](https://github.com/rt64/rt64) for rendering
- [RmlUi](https://github.com/mikke89/RmlUi) for UI
- [lunasvg](https://github.com/sammycage/lunasvg) for SVG rendering
- [FreeType](https://freetype.org/) for font rendering
- [N64: Recompiled](https://github.com/Mr-Wiseguy/N64Recomp) for static recompilation