Dolphin MMJR2 Fork

Mainly, this fork is meant for personal use. This repo's only function at the current time is to update MMJR2 to the latest Dolphin Offical Dev Source code without scoped storage changes merged. If you want scoped storage, go use Dolphin Official Builds. I have no use for scoped storage, nor any changes related to it. I wont be merging these changes. Have a nice day!

An Android-only performance-focused dolphin fork, rebased on top of latest dolphin development builds and reimplementing MMJ UX and performance improvements, plus adding our own.

Grab the latest build in the releases section, or check for new version in the in-app updater. Old MMJR v1.0 builds can be found at the old repository here. 1.0 and 2.0 builds can be installed without conflicts as they use different folders, but savestates are not compatible. We kindly ask you to avoid misusing GitHub Issues and Pull Requests.

This fork wouldn't be possible without the crazy amount of work that developers much more skilled than us put into Dolphin.

Dolphin - A GameCube and Wii Emulator

Dolphin is an emulator for running GameCube and Wii games on Windows, Linux, macOS, and recent Android devices. It's licensed under the terms of the GNU General Public License, version 2 or later (GPLv2+).

Please read the FAQ before using Dolphin.

System Requirements

Android

OS
- Android 5.0 Lollipop or higher (SDK >= 21).
Processor
- A processor with support for 64-bit applications (either ARMv8 or x86-64).
Graphics
- A graphics processor that supports OpenGL ES 3.0 or higher. Performance varies heavily with driver quality.
- A graphics processor that supports standard desktop OpenGL features is recommended for best performance.

Dolphin can only be installed on devices that satisfy the above requirements. Attempting to install on an unsupported device will fail and display an error message.

Building for Android

These instructions assume familiarity with Android development. If you do not have an Android dev environment set up, see AndroidSetup.md.

Make sure to pull submodules before building:

git submodule update --init

If using Android Studio, import the Gradle project located in ./Source/Android.

Android apps are compiled using a build system called Gradle. Dolphin's native component, however, is compiled using CMake. The Gradle script will attempt to run a CMake build automatically while building the Java code.

Uninstalling

When Dolphin has been installed with the NSIS installer, you can uninstall Dolphin like any other Windows application.

Linux users can run cat install_manifest.txt | xargs -d '\n' rm as root from the build directory to uninstall Dolphin from their system.

macOS users can simply delete Dolphin.app to uninstall it.

Additionally, you'll want to remove the global user directory (see below to see where it's stored) if you don't plan to reinstall Dolphin.

Command Line Usage

Usage: Dolphin [-h] [-d] [-l] [-e <str>] [-b] [-v <str>] [-a <str>]

-h, --help Show this help message
-d, --debugger Show the debugger pane and additional View menu options
-l, --logger Open the logger
-e, --exec= Load the specified file (DOL,ELF,WAD,GCM,ISO)
-b, --batch Exit Dolphin with emulator
-v, --video_backend= Specify a video backend
-a, --audio_emulation= Low level (LLE) or high level (HLE) audio

Available DSP emulation engines are HLE (High Level Emulation) and LLE (Low Level Emulation). HLE is faster but less accurate whereas LLE is slower but close to perfect. Note that LLE has two submodes (Interpreter and Recompiler) but they cannot be selected from the command line.

Available video backends are "D3D" and "D3D12" (they are only available on Windows), "OGL", and "Vulkan". There's also "Null", which will not render anything, and "Software Renderer", which uses the CPU for rendering and is intended for debugging purposes only.

Sys Files

wiitdb.txt: Wii title database from GameTDB
totaldb.dsy: Database of symbols (for devs only)
GC/font_western.bin: font dumps
GC/font_japanese.bin: font dumps
GC/dsp_coef.bin: DSP dumps
GC/dsp_rom.bin: DSP dumps
Wii/clientca.pem: Wii network certificate
Wii/clientcakey.pem: Wii network certificate key
Wii/rootca.pem: Wii network certificate issuer / CA

The DSP dumps included with Dolphin have been written from scratch and do not contain any copyrighted material. They should work for most purposes, however some games implement copy protection by checksumming the dumps. You will need to dump the DSP files from a console and replace the default dumps if you want to fix those issues.

Wii network certificates must be extracted from a Wii IOS. A guide for that can be found here.

Folder Structure

These folders are installed read-only and should not be changed:

GameSettings: per-game default settings database
GC: DSP and font dumps
Shaders: post-processing shaders
Themes: icon themes for GUI
Resources: icons that are theme-agnostic
Wii: default Wii NAND contents

User Folder Structure

List of user folders:

Cache: used to cache the ISO list
Config: configuration files
Dump: anything dumped from Dolphin
GameConfig: additional settings to be applied per-game
GC: memory cards and system BIOS
Load: custom textures
Logs: logs, if enabled
ScreenShots: screenshots taken via Dolphin
StateSaves: save states
Wii: Wii NAND contents

Custom Textures

Custom textures have to be placed in the user directory under Load/Textures/[GameID]/. You can find the Game ID by right-clicking a game in the ISO list and selecting "ISO Properties".

Riivolution Patches

Riivolution Patches have to be placed in the user directory under Load/Riivolution/. Once you have extracted the patches here, long press on the game & select Start with Riivolution Patches

DavidOliM/Dolphin-MMJR2