Difference between revisions of "Cemu"

From Emulation General Wiki
Jump to navigation Jump to search
m (Info about async shader)
(18 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 +
{{WIP}}
 
{{Infobox emulator
 
{{Infobox emulator
 
|logo = Cemu-Logo.png
 
|logo = Cemu-Logo.png
|version = {{CemuVer}}
+
|version = {{Version|Cemu}}
 
|active = Yes
 
|active = Yes
|platform = [[Emulators on Windows|Windows]]
+
|platform = [[Emulators on Windows|Windows]]</br>[[Emulators on Linux|Linux]] (experimental)</br>[[Emulators on macOS|macOS]] (experimental)
 
|architecture = x86_64
 
|architecture = x86_64
 
|target = [[Wii U emulators|Wii U]]
 
|target = [[Wii U emulators|Wii U]]
 
|developer = Exzap, Petergov
 
|developer = Exzap, Petergov
 
|website = [http://cemu.info Cemu]
 
|website = [http://cemu.info Cemu]
|license = Closed-source freeware
+
|license = MPL-2.0
 
|compatibility = [https://compat.cemu.info Compatibility list]
 
|compatibility = [https://compat.cemu.info Compatibility list]
 
|support = [https://www.patreon.com/cemu Patreon]
 
|support = [https://www.patreon.com/cemu Patreon]
|bios = [[Emulator_Files#Wii_U|Optional]]
+
|source = [https://github.com/cemu-project/Cemu GitHub]
 +
|bios = [[Emulator_files#Wii_U|Optional]]
 
}}
 
}}
  
'''[[wikipedia:Cemu|Cemu]]''' is a closed-source [[Wii U emulators|Wii U emulator]] for Windows. Its development was started circa 2015 and it's known to be the very first Wii U emulator ever that can boot games.
+
'''[[wikipedia:Cemu|Cemu]]''' is a now open-source [[Wii U emulators|Wii U emulator]]. Its development was started circa 2015 and it's known for being the first Wii U emulator to successfully boot a game.
  
 
Before updates are publicly released, they're accessible to backers over at [https://www.patreon.com/cemu their Patreon].
 
Before updates are publicly released, they're accessible to backers over at [https://www.patreon.com/cemu their Patreon].
Line 20: Line 22:
 
==Download==
 
==Download==
 
{| cellpadding="4"
 
{| cellpadding="4"
 +
|align=center|{{Icon|Win}}
 +
|'''[http://cemu.info/index.html#download Latest public release]'''<br/><small>Available one week after the Patreon builds release</small><br/>
 
|-
 
|-
|align=center|{{Icon|Win-big}}
+
|align=center|{{Icon|Win|Lin|Mac}}
|'''[http://cemu.info/index.html#download Latest public release]'''<br/><small>Available one week after the Patreon builds release</small>
+
|'''[https://github.com/cemu-project/Cemu/releases GitHub release]'''<br/><small>Experimental</small><br/>
|-
 
 
|}
 
|}
  
 
==System requirements==
 
==System requirements==
You will also need enough storage for the [[Wii U emulators|Wii U]] games. Running Cemu on [[Wine]] has been reported to work just as well as Windows.
+
 
===Minimum===
+
* Windows 7 (x64) or above
* Windows 7 (64-bit)
+
* OpenGL 4.5 or Vulkan 1.1
* Graphics Card: Supports at least OpenGL 4.5 or Vulkan 1.1
+
* RAM: 4 GB minimum, 8 GB or more recommended
* Memory: 4 GB
+
 
===Recommended===
+
'''NVIDIA GPU:''' Runs as expected on most recent driver.<br>
* Windows 10 (64-bit)
+
'''AMD GPU:''' Runs as expected on most recent driver. Avoid OpenGL due to bad performance<br>
* Graphics Card: Supports OpenGL 4.6 (Vulkan 1.1 for AMD or Intel)
+
'''Intel GPU:''' Limited support. Vulkan is recommended
* Memory: 8 GB or more
 
  
 
==Game formats and needed files==
 
==Game formats and needed files==
Line 72: Line 74:
  
 
Cemu cannot connect to a real (or emulated) [[Nintendo 3DS emulators|3DS]].
 
Cemu cannot connect to a real (or emulated) [[Nintendo 3DS emulators|3DS]].
 
===Cemuhook===
 
Using this is completely optional but highly recommended. Without Cemuhook, some games won't have texts, have laggy cutscenes and display numerous other bugs.
 
 
Download [http://sshnuke.net/cemuhook/ the latest version] compatible with your Cemu version, unpack it to the same directory as cemu.exe and right-click on dbghelp.dll, check Proprieties, Digital Signatures tab, select a signature and press Details. This should make it no longer crash at start-up. Make sure you also have the latest GPU driver installed, as well as both x86 and x64 versions of the [https://aka.ms/vs/15/release/vc_redist.x64.exe Microsoft Visual C++ 2017 X64 Redistributable].
 
 
After the first boot of Cemu with cemuhook installed, accept to download the missing shared fonts to make the text in some games (Super Mario Maker among others) display correctly.
 
Whenever you boot Cemu now, this cemuhook tool is enabled by default and offers various additions for better motion control emulation or some graphical hacks that greatly enhance Zelda BOTW in particular.
 
Various way to take advantages of the cemuhook motion control emulation are listed [http://compat.cemu.info/wiki/Motion_Sensing#Full-motion_Solutions here].
 
 
Enabling "GX2SetGPUFenceSkip (HACK)" enhances graphical emulation in BOTW in particular. A pre-installed Graphical Pack that comes with recent versions of Cemuhook, "LWZX Crash Workaround", as well as the "GX2DrawDone()" option under Experimental, should help with some general crashes specific to BOTW.
 
 
As of version 1.18.0, cemuhook is no longer considered required to run the emulator, as all major functions previously provided by cemuhook have been implemented into the emulator itself.
 
  
 
===Shader caches===
 
===Shader caches===
Line 92: Line 81:
  
 
==Troubleshooting/speeding up==
 
==Troubleshooting/speeding up==
===Shadercaches===
+
===Shader caches===
 
Shaders are normally cached as you play the game. This can cause a lot of stutters and slow the game down. However, as of version 1.19.0, Cemu added support for Asynchronous Shader Compiling on their Vulkan API which can make shader compiling near instantaneous on modern hardware, so try enabling that before hunting for shader caches.
 
Shaders are normally cached as you play the game. This can cause a lot of stutters and slow the game down. However, as of version 1.19.0, Cemu added support for Asynchronous Shader Compiling on their Vulkan API which can make shader compiling near instantaneous on modern hardware, so try enabling that before hunting for shader caches.
  
Cemu accepts other shader caches that can be traded online. You can go to [https://www.reddit.com/r/Cemucaches/ /r/Cemucaches] and search for the ones you want. It's often very difficult to generate a complete cache for large games, and will not completely eliminate stuttering.
+
Cemu accepts other shader caches that can be traded online. It's often very difficult to generate a complete cache for large games, and will not completely eliminate stuttering, which is why using Asynchronous Shader Compiling is recommended instead.
  
 
[[File:Shadercachestuff.png|thumb|Some settings in the Nvidia control panel might help.]]
 
[[File:Shadercachestuff.png|thumb|Some settings in the Nvidia control panel might help.]]
  
 
Some games' transferable caches may cause slowdowns on some graphics cards like the GeForce GTX 970. If this is the case, you will have to generate your own shaders and delete the ones you downloaded. In the case of the GeForce, also consider deleting the .bin and .toc file in your GLCache at <code>%APPDATA%\NVIDIA\GLCache\(hexstring)\(hexstring)</code>.
 
Some games' transferable caches may cause slowdowns on some graphics cards like the GeForce GTX 970. If this is the case, you will have to generate your own shaders and delete the ones you downloaded. In the case of the GeForce, also consider deleting the .bin and .toc file in your GLCache at <code>%APPDATA%\NVIDIA\GLCache\(hexstring)\(hexstring)</code>.
 
===Native H.264 decoder===
 
MP4 videos are often encoded for Wii U games with the expectation that the hardware plays it back on-the-fly, but because the x86 architecture is not PowerPC, this is resource-intensive for Cemu since it has to run the PowerPC video decoder. An unofficial utility called [https://sshnuke.net/cemuhook/ Cemuhook] bypasses this by playing H.264 video directly from Windows codecs that are programmed for x86.
 
  
 
==Graphic Packs==
 
==Graphic Packs==
Line 127: Line 113:
  
 
See some of the community graphics packs at [http://slashiee.github.io/cemu_graphic_packs/ this page].
 
See some of the community graphics packs at [http://slashiee.github.io/cemu_graphic_packs/ this page].
 
==Issues==
 
* Save states aren't getting implemented any time soon. This has a lot to do with the complexity of the Wii U memory layout and architecture, as well as the huge file size. As a result, the current developers are not interested in implementing them.
 
* The emulator is still unfinished and unoptimized, as noted in the lack of efficient and stable H.264 video decoding, causing glitchy videos. This is worked around with Cemuhook entirely, but its approach to video decoding is unlikely to be taken into the emulator.
 
  
 
==External links==
 
==External links==
 
* [https://wiki.cemu.info/wiki/Main_Page Wiki]
 
* [https://wiki.cemu.info/wiki/Main_Page Wiki]
* [https://discord.gg/5psYsup Discord]
+
* [https://discord.gg/5psYsup Official Discord]
  
 
<references/>
 
<references/>

Revision as of 15:14, 20 March 2023

Cemu
Cemu-Logo.png
Developer(s) Exzap, Petergov
Latest version 2.0 [+]
Active Yes
Platform(s) Windows
Linux (experimental)
macOS (experimental)
Architecture(s) x86_64
Emulates Wii U
Compatibility Compatibility list
Website Cemu
Support ($) Patreon
License MPL-2.0
Source code GitHub
BIOS/Keys Optional

Cemu is a now open-source Wii U emulator. Its development was started circa 2015 and it's known for being the first Wii U emulator to successfully boot a game.

Before updates are publicly released, they're accessible to backers over at their Patreon.

Download

Windows Latest public release
Available one week after the Patreon builds release
Windows Linux macOS GitHub release
Experimental

System requirements

  • Windows 7 (x64) or above
  • OpenGL 4.5 or Vulkan 1.1
  • RAM: 4 GB minimum, 8 GB or more recommended

NVIDIA GPU: Runs as expected on most recent driver.
AMD GPU: Runs as expected on most recent driver. Avoid OpenGL due to bad performance
Intel GPU: Limited support. Vulkan is recommended

Game formats and needed files

Physical dumps

You'll first need to fill in the "keys.txt" file in Cemu's directory. It has a sample line with a bogus key and a comment, which you may as well delete.

Your file must have many lines like this, one for the Wii U Common Key (D7B00402659BA2ABD2CB0DB27FA2B656), and one line for the Game Key of each game. Sharing these keys isn't exactly safe legally, but ROM sites at least share the Game ones. Note that for games using the Loadiine format, you won't need a Game Key at all, but those will need Cemu versions from 1.4.0 onward.

Your ISO must be either uncompressed, compressed using WUD format, or in Loadiine format (only possible for versions 1.4.0 onward) to boot in Cemu. Here's a compatibility list. Dump your discs using Wudump.

Digital copies

Cemu supports either physical games dumps in WUD, or compressed WUX format, as well as game dumps converted to the Loadiine format. Loadiine games come as multiple directories with game files and a .rpx file.

Nintendo's CDN for Wii U and 3DS digital games is rather poorly secured, due to a huge oversight when designing the software protection for these consoles. As such, with tickets proving you bought the game (but which you can get through less legit ways), there are downloader utilities like NUSGrabber, FunKiiU, UWizard, or jnus among others, and decryption tools like UWizard and CDecrypt, to obtain a functional copy. The process of how to exactly acquire those files is detailed elsewhere on this wiki.

Load the .rpx file from [Your gamelocation]/code/[yourgame].rpx with Cemu.

Updates and DLC

Prior to 1.7.3, only updates were supported though pasting update files on the main game's folders (keeping in mind the main game is in Loadiine format) and overwriting any files. DLC wouldn't work at all through this method, though with some specific games there were workarounds and some could play DLC tracks in Mario Kart 8 through swapping of specific files. From 1.7.3 onwards, proper support for DLC and updates was included in Cemu.

The Update installation method has been reworked since 1.11.0 simplifying the installation method a lot. To install updates and DLC on Cemu on (1.11.0)+ versions you need to follow theses steps :

  • On Cemu interface, select File -> Install game update or DLC
  • Select the meta.xml in the meta folder of the update or DLC
  • Run the game to update the UI and show the update and/or DLC version

Amiibo support

Amiibo are hard-to-find figurines unlocking various on-disc content in select 3DS and Wii U games. They use the NFC technology. Nintendo Amiibo data is distributed online as NFC tags (.bin files). There's a regularly updated complete set of the official ones but there are also unofficial spoofed packs on various other sites.

Recent versions of Cemu include Amiibo support. Simply go to NFC / Scan NFC Tag from file, and load the relevant .bin file. Keep in mind Amiibo support in Cemu is incomplete right now and not all figurines are compatible yet - though incompatibilities may be caused by bad Amiibo dumps as well.

Setting up Cemu

Controls

Cemu added native support for Wii Remote controllers as of 1.12.0.

Cemu cannot connect to a real (or emulated) 3DS.

Shader caches

When your game is loaded, check for its ID on the title bar in front of "SaveDir:" and note it down. The directory where transferable shader caches are stored is .\Cemu\shaderCache\transferable. They're generated the first time you play through a game and at that time cause noticeable stuttering. You can download a complete cache from places like here and rename them to match your game version's ID to spare yourself most of that unpleasant experience. Just keep in mind that shader caches from versions older than 1.8.0 are incompatible with later versions of Cemu.

At startup, Cemu will prepare a compiled version of that cache under .\Cemu\shaderCache\precompiled and that one depends on your GPU driver, so you might want to erase it if any problems or crashes when compiling shaders at startup occur.

Troubleshooting/speeding up

Shader caches

Shaders are normally cached as you play the game. This can cause a lot of stutters and slow the game down. However, as of version 1.19.0, Cemu added support for Asynchronous Shader Compiling on their Vulkan API which can make shader compiling near instantaneous on modern hardware, so try enabling that before hunting for shader caches.

Cemu accepts other shader caches that can be traded online. It's often very difficult to generate a complete cache for large games, and will not completely eliminate stuttering, which is why using Asynchronous Shader Compiling is recommended instead.

Some settings in the Nvidia control panel might help.

Some games' transferable caches may cause slowdowns on some graphics cards like the GeForce GTX 970. If this is the case, you will have to generate your own shaders and delete the ones you downloaded. In the case of the GeForce, also consider deleting the .bin and .toc file in your GLCache at %APPDATA%\NVIDIA\GLCache\(hexstring)\(hexstring).

Graphic Packs

To work around emulation bugs and other problems the way Dolphin does, "Graphic Packs" are title-specific property sheets which define advanced settings you might not be able to change in the interface. Basic rendering options including shadow resolution and quality, post-processing effects like bloom, lighting and god rays, custom anti-aliasing, and such can be applied here. You can even use them to reduce the internal resolution for an increase in the framerate. This is not to be confused with Texture Packs, which are replacement textures; Cemu doesn't support that, but it is planned.

The "Graphic Packs" themselves are folders under the graphicPacks directory. They can be named anything, but they should contain the "rules.txt" file. A bare-bones example of a "Graphics Pack", called "Bayo_1080p", would look like this:

[Definition]
titleIds = 0005000010172600,0005000010172700,000500001011b900,000500001014db00,0005000010157e00,0005000010157f00
name = "Bayonetta 1 + 2 - 1080p"

[TextureRedefine]
width = 1280
height = 720
overwriteWidth = 1920
overwriteHeight = 1080

Whenever the titleId matches the current one, Cemu will show the Graphics Pack under Options -> Graphics Pack. If you don't know what the titleId of the game you want is, check the logs.txt file. You can safely delete it in the event that it gets too big for a text editor to parse.

The overwriteWidth and overwriteHeight properties used in this example will upscale the game from 720p to 1080p. But if the game doesn't have all of its textures in the specified resolution, they won't be upscaled and could look messy as a result. In this case, this problem is seen in some FMVs in the game. This is the purpose of the TextureRedefine rule.

Since 1.13.0, the graphic packs system and interface was overhauled for better use and many bugs when using multiples graphic packs were fixed. For 1.15.1 and now on, users can download the community's graphics packs linked below directly from Cemu user interface and just check the graphics packs they want to enable. That update completly removed the need to manage files for the user.

See some of the community graphics packs at this page.

External links