mirror of
https://github.com/cemu-project/Cemu.git
synced 2025-07-03 13:31:18 +12:00
Rewrite Readme.md
This commit is contained in:
Zopolis4
parent
be0f062de8
commit
d454bc243b
4 changed files with 76 additions and 87 deletions
34
BUILD.md
34
BUILD.md
|
|
@ -1,34 +0,0 @@
|
||||||
# Build instructions
|
|
||||||
|
|
||||||
## Windows
|
|
||||||
|
|
||||||
Prerequisites:
|
|
||||||
- A recent version of Visual Studio 2022 with CMake tools component
|
|
||||||
- git
|
|
||||||
- Vulkan SDK ([https://vulkan.lunarg.com/](https://vulkan.lunarg.com/)). Don't forget to restart after installing.
|
|
||||||
|
|
||||||
Instructions:
|
|
||||||
|
|
||||||
1) Run `git clone --recursive https://github.com/cemu-project/Cemu`
|
|
||||||
2) Launch `Cemu/generate_vs_solution.bat`. If you installed VS to a custom location you may need to manually adjust the path inside the bat file
|
|
||||||
3) Wait until done, then open `Cemu/build/Cemu.sln` in Visual Studio
|
|
||||||
4) Right click 'CemuBin' project -> Set as startup project
|
|
||||||
5) Then build the solution and once finished you can run and debug it
|
|
||||||
|
|
||||||
You can also skip steps 3-5 and open the root folder of the cloned repo directly in Visual Studio (as a folder) and use the inbuilt cmake support, but be warned that cmake support in VS can be a bit finicky.
|
|
||||||
|
|
||||||
## Linux
|
|
||||||
|
|
||||||
To compile Cemu, a recent enough compiler and STL with C++20 support is required! We use clang 12, other compilers may work as well.
|
|
||||||
|
|
||||||
For ubuntu and most derivatives:
|
|
||||||
|
|
||||||
1) Make sure vulkansdk is installed and the VULKAN_SDK environment variable is set correctly.
|
|
||||||
2) `sudo apt install -y libgtk-3-dev libsecret-1-dev libgcrypt20-dev libsystemd-dev freeglut3-dev clang-12 nasm`
|
|
||||||
3) Run `git clone --recursive https://github.com/cemu-project/Cemu`
|
|
||||||
4) `cd Cemu`
|
|
||||||
5) `mkdir build && cd build`
|
|
||||||
6) `cmake .. -DCMAKE_BUILD_TYPE=release -DCMAKE_C_COMPILER=/usr/bin/clang-12 -DCMAKE_CXX_COMPILER=/usr/bin/clang++-12 -G Ninja -DCMAKE_MAKE_PROGRAM=/usr/bin/ninja`
|
|
||||||
8) `ninja`
|
|
||||||
|
|
||||||
Build instructions for other distributions will be added in the future!
|
|
||||||
51
README.md
51
README.md
|
|
@ -1,51 +0,0 @@
|
||||||
# **Cemu - Wii U emulator**
|
|
||||||
|
|
||||||
[](https://github.com/cemu-project/Cemu/actions/workflows/build.yml)
|
|
||||||
[](https://discord.gg/5psYsup)
|
|
||||||
|
|
||||||
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.
|
|
||||||
It's written in C/C++ and is being actively developed with new features and fixes to increase compatibility, convenience and usability.
|
|
||||||
|
|
||||||
Cemu is currently only available for 64-bit Windows and Linux devices.
|
|
||||||
|
|
||||||
### Links:
|
|
||||||
- [Original 2.0 announcement post](https://www.reddit.com/r/cemu/comments/wwa22c/cemu_20_announcement_linux_builds_opensource_and/)
|
|
||||||
- [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)
|
|
||||||
- [Unofficial Setup Guide](https://cemu.cfw.guide)
|
|
||||||
|
|
||||||
#### Other relevant repositories:
|
|
||||||
- [Cemu-Language](https://github.com/cemu-project/Cemu-Language)
|
|
||||||
- [Cemu's Community Graphic Packs](https://github.com/ActualMandM/cemu_graphic_packs)
|
|
||||||
|
|
||||||
## Download
|
|
||||||
|
|
||||||
You can download the latest Cemu releases from the [Github Releases](https://github.com/cemu-project/Cemu/releases/) or from [Cemu's website](http://cemu.info).
|
|
||||||
|
|
||||||
Cemu is currently only available in a portable format so no installation is required besides extracting it in a safe place.
|
|
||||||
|
|
||||||
See [Current State Of Linux builds](https://github.com/cemu-project/Cemu/issues/1) for information on using Cemu natively on Linux.
|
|
||||||
|
|
||||||
Pre-2.0 releases can be found on Cemu's [changelog page](http://cemu.info/changelog.html).
|
|
||||||
|
|
||||||
## Build Instructions
|
|
||||||
|
|
||||||
To compile Cemu yourself on Windows or Linux, view the [BUILD.md file](/BUILD.md).
|
|
||||||
|
|
||||||
## Issues
|
|
||||||
|
|
||||||
Issues with the emulator should be filed using [Github Issues](https://github.com/cemu-project/Cemu/issues).
|
|
||||||
The old bug tracker can be found at [bugs.cemu.info](http://bugs.cemu.info) and still contains relevant issues and feature suggestions.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Pull requests are very welcome. For easier coordination you can visit the developer discussion channel on Discord: [https://discord.gg/5psYsup](https://discord.gg/5psYsup).
|
|
||||||
|
|
||||||
If coding isn't your thing, testing games and making detailed bug reports or updating the (usually outdated) compatibility wiki is also appreciated!
|
|
||||||
|
|
||||||
Questions about Cemu's software architecture can also be answered on Discord. Alternative communication channels (like IRC) are being considered.
|
|
||||||
|
|
||||||
## License
|
|
||||||
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.
|
|
||||||
76
Readme.md
Normal file
76
Readme.md
Normal file
|
|
@ -0,0 +1,76 @@
|
||||||
|
# **Cemu - A Wii U emulator**
|
||||||
|
|
||||||
|
[](https://github.com/cemu-project/Cemu/actions/workflows/build.yml)
|
||||||
|
|
||||||
|
[Website](https://cemu.info) | [Wiki](https://wiki.cemu.info/wiki/Main_Page) | [Subreddit](https://reddit.com/r/Cemu) | [Discord](https://discord.gg/5psYsup) | [Unofficial Setup Guide](https://cemu.cfw.guide) | [Translation](https://github.com/cemu-project/Cemu-Language) | [Community Graphic Packs](https://github.com/ActualMandM/cemu_graphic_packs)
|
||||||
|
|
||||||
|
Cemu is a Wii U emulator written in C++ under active development.
|
||||||
|
|
||||||
|
## System Requirements
|
||||||
|
|
||||||
|
* OS
|
||||||
|
* Windows (7 or higher).
|
||||||
|
* Linux.
|
||||||
|
* Architecture
|
||||||
|
* x86_64.
|
||||||
|
* Graphics
|
||||||
|
* Something that supports Vulkan 1.1 or OpenGL 4.5.
|
||||||
|
* NVIDIA GPUs work best.
|
||||||
|
* AMD GPUs struggle with OpenGL.
|
||||||
|
* Intel GPUs have limited support, use Vulkan.
|
||||||
|
|
||||||
|
## Download
|
||||||
|
|
||||||
|
You can download the latest Cemu releases from the [Github Releases](https://github.com/cemu-project/Cemu/releases) or from [Cemu's website](http://cemu.info).
|
||||||
|
|
||||||
|
See [Current State Of Linux builds](https://github.com/cemu-project/Cemu/issues/1) for information on using Cemu natively on Linux.
|
||||||
|
|
||||||
|
Pre-2.0 releases can be found on Cemu's [changelog page](http://cemu.info/changelog.html).
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
The [Vulkan SDK](https://vulkan.lunarg.com) is currently required for all platforms.
|
||||||
|
Make sure to pull submodules before building:
|
||||||
|
```
|
||||||
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
### Building for Windows
|
||||||
|
|
||||||
|
Visual Studio 2022 with C++ CMake tools for Windows is required.
|
||||||
|
|
||||||
|
The Public Release configuration is best for a single build.
|
||||||
|
The Release configuration is recommended for regular development.
|
||||||
|
The Debug configuration is much slower, and should be used only for debugging.
|
||||||
|
|
||||||
|
### Building for Linux
|
||||||
|
|
||||||
|
A compiler and STL with good C++20 support is required. Make sure you have either cloned recursively or pulled submodules, and are located in-tree.
|
||||||
|
|
||||||
|
1. `mkdir build`
|
||||||
|
2. `cd build`
|
||||||
|
3. `cmake ..`
|
||||||
|
4. `make -j $(nproc)`
|
||||||
|
|
||||||
|
#### Linux Dependencies
|
||||||
|
While Cemu currently uses vcpkg on all platforms, some dependencies must be installed via the system package manager.
|
||||||
|
|
||||||
|
For apt-based systems:
|
||||||
|
```
|
||||||
|
sudo apt install libgtk-3-dev libsecret-1-dev libgcrypt20-dev libsystemd-dev freeglut3-dev nasm
|
||||||
|
```
|
||||||
|
|
||||||
|
## Issues
|
||||||
|
|
||||||
|
Issues with the emulator should be filed using [Github Issues](https://github.com/cemu-project/Cemu/issues).
|
||||||
|
The old bug tracker can be found at [bugs.cemu.info](http://bugs.cemu.info) and still contains relevant issues and feature suggestions.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Pull requests are very welcome. For easier coordination you can visit the developer discussion channel on Discord.
|
||||||
|
|
||||||
|
If coding isn't your thing, testing games and making detailed bug reports or updating the (usually outdated) compatibility wiki is also appreciated!
|
||||||
|
|
||||||
|
Questions about Cemu's software architecture can also be answered on Discord. Alternative communication channels (like IRC) are being considered.
|
||||||
|
|
||||||
|
## License
|
||||||
|
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.
|
||||||
|
|
@ -1,2 +0,0 @@
|
||||||
"C:\PROGRAM FILES\MICROSOFT VISUAL STUDIO\2022\COMMUNITY\COMMON7\IDE\COMMONEXTENSIONS\MICROSOFT\CMAKE\CMake\bin\cmake.exe" -B build/
|
|
||||||
pause
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue