OpenPunk/citra
1
0
Fork 0
mirror of https://github.com/citra-emu/citra.git synced 2024-11-21 23:20:04 +00:00
Code Issues Projects Releases Wiki Activity

Updated Home (markdown)

bunnei 2018-01-14 02:02:20 -05:00
parent 0da704e0eb
commit f700ec9566
1 changed files with 23 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
Home.md

@ -1,76 +1,36 @@
Citra – 3DS Emulator and Debugger
==============
[![Travis CI Build Status](https://travis-ci.org/citra-emu/citra.svg?branch=master)](https://travis-ci.org/citra-emu/citra)
[![AppVeyor CI Build Status](https://ci.appveyor.com/api/projects/status/sdf1o4kh3g1e68m9?svg=true)](https://ci.appveyor.com/project/bunnei/citra)
yuzu emulator
=============
yuzu is an experimental open-source emulator for the Nintendo Switch from the creators of [Citra](https://citra-emu.org/).
Citra is an experimental open-source Nintendo 3DS emulator/debugger written in C++.
It is written in C++ with portability in mind, with builds actively maintained for Windows, Linux and macOS. The emulator is currently only useful for homebrew development and research purposes.
Although it is slow at this time, it is constantly being improved.
yuzu only emulates a subset of Switch hardware and therefore is generally only useful for running/debugging homebrew applications. At this time, yuzu does not run any commercial Switch games. yuzu can boot some games, to varying degrees of success, but does not implement any of the necessary GPU features to render 3D graphics.
Citra's features include better visual output, debugging homebrew, and controller support.
yuzu is licensed under the GPLv2 (or any later version). Refer to the license.txt file included.
The [Citra repositories](https://github.com/citra-emu/citra) are hosted on GitHub.
Citra is licensed under GPLv2 (or any later version). Refer to the license.txt file included.
Check out our [website](https://yuzu-emu.org/)!
## Usage
You may download a precompiled binary from [our website](https://citra-emu.org/download/), or you can build it yourself from the source code.
* __[Windows, macOS, and Linux Binary Downloads](https://citra-emu.org/download/)__
* [[Build Instructions for Windows|Building for Windows]]
* [[Build Instructions for macOS|Building for macOS]]
* [[Build Instructions for Linux|Building for Linux]]
* [[Simplified instructions for Ubuntu 16.04|Building for Ubuntu 16.04]]
* For Ubuntu 14.04 or older versions, we strongly recommend updating to Ubuntu 16.04 LTS.
For development discussion, please join us on [Discord](https://discord.gg/VXqngT3).
If you are having trouble building Citra from the source code, see this wiki page:
* [[Common Issues When Building|Common Issues]]
### Development
Now, you'll need to dump the games you want to play with your 3DS.
* [[Dumping Game Cartridges]]
* [[Dumping Installed Titles]]
Most of the development happens on GitHub. It's also where [our central repository](https://github.com/yuzu-emu/yuzu) is hosted.
If you have any save files or extra data on your 3DS that you want to import into Citra, you'll have to dump them as well.
* [[Dumping Save Data from a 3DS Console]]
* [[Dumping Extra Data from a 3DS Console]]
If you want to contribute please take a look at the [Contributor's Guide](CONTRIBUTING.md) and [Developer Information](https://github.com/yuzu-emu/yuzu/wiki/Developer-Information). You should as well contact any of the developers on Discord in order to know about the current state of the emulator.
In order to make some games work, you'll have to dump some system files from your 3DS.
* [[Dumping System Archives and the Shared Fonts from a 3DS Console]]
* [[Dumping Config Savegame from a 3DS Console]]
### Building
You can find a reference for Citra's default keyboard bindings here:
* [[Default Keyboard Bindings]]
* __Windows__: [Windows Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Windows)
* __Linux__: [Linux Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Linux)
* __macOS__: [macOS Build](https://github.com/yuzu-emu/yuzu/wiki/Building-for-macOS)
If you have any questions about Citra, first check these pages:
* [[User Directory]] - Explanation of Citra's file structure
* [[Citra Web Service]] - What are and how to use web services tokens
* [[Compatibility List]] - List(s) of titles known to be compatible or incompatible with Citra
* [[Frequently Asked Questions|FAQ]] - Help with common questions about using Citra
* [[Common Issues]] - Help with issues encountered while building Citra from source
If you don't see your question answered there, feel free to ask at these places:
* [Citra's Forums](https://community.citra-emu.org/)
* [Citra's Discord](https://discord.gg/9jgD2y4) at #citra-support
* The #citra IRC Channel on [freenode](http://webchat.freenode.net/) (chat.freenode.net:6667 / SSL: 6697)
* The #citra-dev IRC Channel on [freenode](http://webchat.freenode.net/) (chat.freenode.net:6667 / SSL: 6697)
### Support
We happily accept monetary donations or donated games and hardware. Please see our [donations page](https://yuzu-emu.org/donate/) for more information on how you can contribute to yuzu. Any donations received will go towards things like:
* Switch consoles to explore and reverse-engineer the hardware
* Switch games for testing, reverse-engineering, and implementing new features
* Web hosting and infrastructure setup
* Software licenses (e.g. Visual Studio, IDA Pro, etc.)
* Additional hardware (e.g. GPUs as-needed to improve rendering support, other peripherals to add support for, etc.)
## Development
If you are interested in contributing to Citra's code, the first thing you should read is this guide, which will show you what style to code in:
* [Contributing.md](https://github.com/citra-emu/citra/blob/master/CONTRIBUTING.md)
You can find info about the 3DS on these pages:
* [[Developer Information]]
* [[CPU Information|CPU]]
When you are ready, this page will show you how to use Git to setup your own repository:
* [[Typical Git Workflow]]
Using log filters, you can configure Citra to make development easier.
* [[Log Filters]]
You can find various Homebrew that test the accuracy of Citra here:
* [[Archive of 3DS Tests]]
Now that everything is setup, you can take a look at these places to see what needs to be done:
* [TODO List](https://docs.google.com/document/d/1SWIop0uBI9IW8VGg97TAtoT_CHNoP42FzYmvG1F4QDA)
* The #citra IRC Channel on [freenode](http://webchat.freenode.net/) (chat.freenode.net:6667 / SSL: 6697)
* The #citra-dev IRC Channel on [freenode](http://webchat.freenode.net/) (chat.freenode.net:6667 / SSL: 6697)
We also more than gladly accept used Switch consoles, preferably ones with firmware 3.0.0 or lower! If you would like to give yours away, don't hesitate to join our [Discord](https://discord.gg/VXqngT3) and talk to bunnei. You may also contact: donations@yuzu-emu.org.