piwalker/dolphin
1
0
Fork 0
mirror of https://github.com/dolphin-emu/dolphin.git synced 2024-11-14 21:37:52 -07:00
Code Issues Actions Packages Projects Releases Wiki Activity
Dolphin is a GameCube / Wii emulator, allowing you to play games for these two platforms on PC with improvements.
16,443 Commits 5 Branches 11 Tags 1.3 GiB
C++ 88.5%
Kotlin 4.9%
C 2.4%
CMake 1.2%
Objective-C++ 1%
Other 1.7%
2f8e0c9bb9
Go to file
mimimi085181 2f8e0c9bb9 Allow multiple texture cache entries for textures at the same address 
This is the same trick which is used for Metroid's fonts/texts, but for all textures. If 2 different textures at the same address are loaded during the same frame, create a 2nd entry instead of overwriting the existing one. If the entry was overwritten in this case, there wouldn't be any caching, which results in a big performance drop.

The restriction to textures, which are loaded during the same frame, prevents creating lots of textures when textures are used in the regular way. This restriction is new. Overwriting textures, instead of creating new ones is faster, if the old ones are unlikely to be used again.

Since this would break efb copies, don't do it for efb copies.

Castlevania 3 goes from 80 fps to 115 fps for me.

There might be games that need a higher texture cache accuracy with this, but those games should also see a performance boost from this PR.

Some games, which use paletted textures, which are not efb copies, might be faster now. And also not require a higher texture cache accuracy anymore. (similar sitation as PR https://github.com/dolphin-emu/dolphin/pull/1916)
2015-02-18 23:54:40 +01:00
CMakeTests Adds LLVM version check to cmake. 2014-12-07 10:49:45 +00:00
Data PostProcessing: Add support for user-supplied anaglyph shaders. 2015-01-25 22:07:03 +01:00
docs Clean Up 2015-01-24 17:10:21 -06:00
Externals make libusb vcxproj use standard dolphin template and don't compile strerror.c. 2015-02-18 13:29:39 -08:00
Installer Clean Up 2015-01-24 17:10:21 -06:00
Languages Revert "Automatic translation resources update from Transifex" 2014-11-10 00:37:38 +00:00
Source Allow multiple texture cache entries for textures at the same address 2015-02-18 23:54:40 +01:00
Tools Tools: add disassemble script for perf 2015-02-08 00:39:54 +01:00
.gitignore Android: also ignore the libs left on the root. 2014-11-30 23:01:00 -08:00
.gitmodules Add Qt submodule for windows. 2014-09-15 15:07:42 -07:00
.mailmap Add a .mailmap file 2014-12-23 09:34:56 +01:00
CMakeLists.txt xxhash: Add cmake + VS files 2015-01-21 07:35:34 +01:00
Contributing.md Add a notice about licensing to CONTRIBUTING.md 2014-11-21 18:38:45 -05:00
license.txt
Readme.md Merge pull request #1749 from Buddybenj/readme 2015-01-22 18:38:27 -06:00

Readme.md

Dolphin - A GameCube / Wii / Triforce Emulator

Homepage | Project Site | Forums | Wiki | Issue Tracker | Coding Style | Transifex Page

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

Please read the FAQ before using Dolphin.

System Requirements

  • OS
    • Microsoft Windows (Vista or higher).
    • Linux.
    • Apple Mac OS X (10.9 or higher).
    • Unix-like systems other than Linux might work but are not officially supported.
  • Processor
    • A CPU with SSE2 support.
    • A modern CPU (3 GHz and Dual Core, not older than 2008) is highly recommended.
  • Graphics
    • A reasonably modern graphics card (Direct3D 10.0 / OpenGL 3.0).
    • A graphics card that supports Direct3D 11 / OpenGL 4.4 is recommended.

Installation on Windows

Use the solution file Source/dolphin-emu.sln to build Dolphin on Windows. Visual Studio 2013 is a hard requirement since previous versions don't support many C++ features that we use. Other compilers might be able to build Dolphin on Windows but have not been tested and are not recommended to be used.

An installer can be created by using the Installer_win32.nsi and Installer_x64.nsi scripts in the Installer directory. This will require the Nullsoft Scriptable Install System (NSIS) to be installed. Creating an installer is not necessary to run Dolphin since the Build directory contains a working Dolphin distribution.

Installation on Linux and OS X

Dolphin requires CMake for systems other than Windows. Many libraries are bundled with Dolphin and used if they're not installed on your system. CMake will inform you if a bundled library is used or if you need to install any missing packages yourself.

Build Steps:

  1. mkdir Build
  2. cd Build
  3. cmake ..
  4. make

On OS X, an application bundle will be created in ./Binaries.

On Linux, it's strongly recommended to perform a global installation via sudo make install.

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 | xargs -d '\n' rm from the build directory to uninstall Dolphin from their system.

OS X 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 Opens the debugger
  • -l, --logger Opens the logger
  • -e, --exec= Loads 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 fast but often less accurate while LLE is slow but close to perfect. Note that LLE has two submodes (Interpreter and Recompiler), which cannot be selected from the command line.

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

Sys Files

  • totaldb.dsy: Database of symbols (for devs only)
  • GC/font_ansi.bin: font dumps
  • GC/font_sjis.bin: font dumps
  • GC/dsp_coef.bin: DSP dumps
  • GC/dsp_rom.bin: DSP dumps

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.

Folder Structure

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

  • GameSettings: per-game default settings database
  • GC: DSP and font dumps
  • Maps: symbol tables (dev only)
  • Shaders: post-processing shaders
  • Themes: icon themes for GUI
  • Resources: icons that are theme-agnostic
  • Wii: default Wii NAND contents

User Folder Structure

A number of user writeable directories are created for caching purposes or for allowing the user to edit their contents. On OS X and Linux these folders are stored in ~/Library/Application Support/Dolphin/ and ~/.dolphin-emu respectively. On Windows the user directory is stored in the My Documents folder by default, but there are various way to override this behavior:

  • Creating a file called portable.txt next to the Dolphin executable will store the user directory in a local directory called "User" next to the Dolphin executable.
  • If the registry string value LocalUserConfig exists in HKEY_CURRENT_USER/Software/Dolphin Emulator and has the value 1, Dolphin will always start in portable mode.
  • If the registry string value UserConfigPath exists in HKEY_CURRENT_USER/Software/Dolphin Emulator, the user folders will be stored in the directory given by that string. The other two methods will be prioritized over this setting.

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".