cemu-project/Cemu
1
0
Fork 0
mirror of https://github.com/cemu-project/Cemu.git synced 2024-11-23 11:29:53 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
ea68f787eb
Cemu/README.md

55 lines
3.4 KiB
Markdown
Raw Normal View History

Expand readme with links and description
2022-08-23 00:37:05 +00:00
# **Cemu - Wii U emulator**
[![Build Process](https://github.com/cemu-project/Cemu/actions/workflows/build.yml/badge.svg)](https://github.com/cemu-project/Cemu/actions/workflows/build.yml)
[![Discord](https://img.shields.io/discord/286429969104764928?label=Cemu&logo=discord&logoColor=FFFFFF)](https://discord.gg/5psYsup)
Update readme about matrix server Supersedes https://github.com/cemu-project/Cemu/pull/245
2022-09-15 02:06:40 +00:00
[![Matrix Server](https://img.shields.io/matrix/cemu:cemu.info?server_fqdn=matrix.cemu.info&label=cemu:cemu.info&logo=matrix&logoColor=FFFFFF)](https://matrix.to/#/#cemu:cemu.info)
Expand readme with links and description
2022-08-23 00:37:05 +00:00
This is the code repository of Cemu, a Wii U emulator that is able to run most Wii U games and homebrew in a playable state.
Add coding style guidelines and clang-format file
2023-09-14 17:46:54 +00:00
It's written in C/C++ and is being actively developed with new features and fixes.
Expand readme with links and description
2022-08-23 00:37:05 +00:00
Add macOS to README.md (#599)
2023-01-13 12:49:01 +00:00
Cemu is currently only available for 64-bit Windows, Linux & macOS devices.
Expand readme with links and description
2022-08-23 00:37:05 +00:00
### Links:
Add GDB stub for debugging (#657) * Implement GDB stub debugger Can be enabled by using the "--enable-gdbstub" option (and the debugger GUI, although that's untested) which'll pause any game you launch at start-up. Will start at port 1337 although it'll eventually be user-editable. The code is a bit weirdly sorted and also just needs a general cleanup, so expect that eventually too. And uses egyptian braces but formatting was easier to do at the end, so that's also something to do. It has been tested to work with IDA Pro, Clion and the standalone interface for now, but I plan on writing some instructions in the PR to follow for people who want to use this. Memory breakpoints aren't possible yet, only execution breakpoints. This code was aimed to be decoupled from the existing debugger to be able to be ported to the Wii U for an equal debugging experience. That's also why it uses the Cafe OS's thread sleep and resuming functions whenever possible instead of using recompiler/interpreter controls. * Add memory writing and floating point registers support * Reformat code a bit * Format code to adhere to Cemu's coding style * Rework GDB Stub settings in GUI * Small styling fixes * Rework execution breakpoints Should work better in some edge cases now. But this should also allow for adding access breakpoints since it's now more separated. * Implement access breakpoints * Fix some issues with breakpoints * Fix includes for Linux * Fix unnecessary include * Tweaks for Linux compatibility * Use std::thread instead of std::jthread to fix MacOS support * Enable GDB read/write breakpoints on x86 only * Fix compilation for GCC compilers at least The thread type varies on some platforms, so supporting this is hell... but let's get it to compile on MacOS first. * Disable them for MacOS due to lack of ptrace --------- Co-authored-by: Exzap <13877693+Exzap@users.noreply.github.com>
2023-02-19 14:41:49 +00:00
- [Open Source Announcement](https://www.reddit.com/r/cemu/comments/wwa22c/cemu_20_announcement_linux_builds_opensource_and/)
Expand readme with links and description
2022-08-23 00:37:05 +00:00
- [Official Website](https://cemu.info)
- [Compatibility List/Wiki](https://wiki.cemu.info/wiki/Main_Page)
- [Official Subreddit](https://reddit.com/r/Cemu)
- [Official Discord](https://discord.gg/5psYsup)
Update readme about matrix server Supersedes https://github.com/cemu-project/Cemu/pull/245
2022-09-15 02:06:40 +00:00
- [Official Matrix Server](https://matrix.to/#/#cemu:cemu.info)
Add GDB stub for debugging (#657) * Implement GDB stub debugger Can be enabled by using the "--enable-gdbstub" option (and the debugger GUI, although that's untested) which'll pause any game you launch at start-up. Will start at port 1337 although it'll eventually be user-editable. The code is a bit weirdly sorted and also just needs a general cleanup, so expect that eventually too. And uses egyptian braces but formatting was easier to do at the end, so that's also something to do. It has been tested to work with IDA Pro, Clion and the standalone interface for now, but I plan on writing some instructions in the PR to follow for people who want to use this. Memory breakpoints aren't possible yet, only execution breakpoints. This code was aimed to be decoupled from the existing debugger to be able to be ported to the Wii U for an equal debugging experience. That's also why it uses the Cafe OS's thread sleep and resuming functions whenever possible instead of using recompiler/interpreter controls. * Add memory writing and floating point registers support * Reformat code a bit * Format code to adhere to Cemu's coding style * Rework GDB Stub settings in GUI * Small styling fixes * Rework execution breakpoints Should work better in some edge cases now. But this should also allow for adding access breakpoints since it's now more separated. * Implement access breakpoints * Fix some issues with breakpoints * Fix includes for Linux * Fix unnecessary include * Tweaks for Linux compatibility * Use std::thread instead of std::jthread to fix MacOS support * Enable GDB read/write breakpoints on x86 only * Fix compilation for GCC compilers at least The thread type varies on some platforms, so supporting this is hell... but let's get it to compile on MacOS first. * Disable them for MacOS due to lack of ptrace --------- Co-authored-by: Exzap <13877693+Exzap@users.noreply.github.com>
2023-02-19 14:41:49 +00:00
- [Setup Guide](https://cemu.cfw.guide)
Expand readme with links and description
2022-08-23 00:37:05 +00:00
#### Other relevant repositories:
- [Cemu-Language](https://github.com/cemu-project/Cemu-Language)
Update URLs related towards cemu_graphic_packs repo. (#764)
2023-04-13 02:37:53 +00:00
- [Cemu's Community Graphic Packs](https://github.com/cemu-project/cemu_graphic_packs)
Expand readme with links and description
2022-08-23 00:37:05 +00:00
## Download
Add coding style guidelines and clang-format file
2023-09-14 17:46:54 +00:00
You can download the latest Cemu releases for Windows, Linux and Mac from the [GitHub Releases](https://github.com/cemu-project/Cemu/releases/). For Linux you can also find Cemu on [flathub](https://flathub.org/apps/info.cemu.Cemu).
Expand readme with links and description
2022-08-23 00:37:05 +00:00
Add coding style guidelines and clang-format file
2023-09-14 17:46:54 +00:00
On Windows Cemu is currently only available in a portable format so no installation is required besides extracting it in a safe place.
Expand readme with links and description
2022-08-23 00:37:05 +00:00
Add macOS to README.md (#599)
2023-01-13 12:49:01 +00:00
The native macOS build is currently purely experimental and should not be considered stable or ready for issue-free gameplay. There are also known issues with degraded performance due to the use of MoltenVK and Rosetta for ARM Macs. We appreciate your patience while we improve Cemu for macOS.
Update URLs to HTTPS (#44)
2022-08-25 13:33:12 +00:00
Pre-2.0 releases can be found on Cemu's [changelog page](https://cemu.info/changelog.html).
Expand readme with links and description
2022-08-23 00:37:05 +00:00
## Build Instructions
Add coding style guidelines and clang-format file
2023-09-14 17:46:54 +00:00
To compile Cemu yourself on Windows, Linux or macOS, view [BUILD.md](/BUILD.md).
Expand readme with links and description
2022-08-23 00:37:05 +00:00
## Issues
Improve docs (#216)
2022-09-09 16:39:23 +00:00
Issues with the emulator should be filed using [GitHub Issues](https://github.com/cemu-project/Cemu/issues).
Update bug tracker URL to use HTTPS (#211)
2022-09-08 21:52:45 +00:00
The old bug tracker can be found at [bugs.cemu.info](https://bugs.cemu.info) and still contains relevant issues and feature suggestions.
Expand readme with links and description
2022-08-23 00:37:05 +00:00
## Contributing
Update readme about matrix server Supersedes https://github.com/cemu-project/Cemu/pull/245
2022-09-15 02:06:40 +00:00
Pull requests are very welcome. For easier coordination you can visit the developer discussion channel on [Discord](https://discord.gg/5psYsup) or alternatively the [Matrix Server](https://matrix.to/#/#cemu:cemu.info).
Add coding style guidelines and clang-format file
2023-09-14 17:46:54 +00:00
Before submitting a pull request, please read and follow our code style guidelines listed in [CODING_STYLE.md](/CODING_STYLE.md).
Expand readme with links and description
2022-08-23 00:37:05 +00:00
If coding isn't your thing, testing games and making detailed bug reports or updating the (usually outdated) compatibility wiki is also appreciated!
Update readme about matrix server Supersedes https://github.com/cemu-project/Cemu/pull/245
2022-09-15 02:06:40 +00:00
Questions about Cemu's software architecture can also be answered on Discord (through the Matrix bridge).
Expand readme with links and description
2022-08-23 00:37:05 +00:00
## License
Tweak readme
2022-08-23 03:56:08 +00:00
Cemu is licensed under [Mozilla Public License 2.0](/LICENSE.txt). Exempt from this are all files in the dependencies directory for which the licenses of the original code apply as well as some individual files in the src folder, as specified in those file headers respectively.
Reference in New Issue Copy Permalink