Giter Site home page Giter Site logo


Ryujinx
Ryujinx
(REE-YOU-JINX)

Ryujinx is an open-source Nintendo Switch emulator, created by gdkchan, written in C#. This emulator aims at providing excellent accuracy and performance, a user-friendly interface and consistent builds. It was written from scratch and development on the project began in September 2017. Ryujinx is available on Github under the MIT license.

Discord

Compatibility

As of October 2023, Ryujinx has been tested on approximately 4,200 titles; over 4,150 boot past menus and into gameplay, with roughly 3,500 of those being considered playable.

You can check out the compatibility list here.

Anyone is free to submit a new game test or update an existing game test entry; simply follow the new issue template and testing guidelines, or post as a reply to the applicable game issue. Use the search function to see if a game has been tested already!

Usage

To run this emulator, your PC must be equipped with at least 8GiB of RAM; failing to meet this requirement may result in a poor gameplay experience or unexpected crashes.

See our Setup & Configuration Guide on how to set up the emulator.

For our Local Wireless (LDN) builds, see our Multiplayer: Local Play/Local Wireless Guide .

Avalonia UI comes with translations for various languages. See Crowdin for more information.

Latest build

These builds are compiled automatically for each commit on the master branch. While we strive to ensure optimal stability and performance prior to pushing an update, our automated builds may be unstable or completely broken.

If you want to see details on updates to the emulator, you can visit our Changelog.

The latest automatic build for Windows, macOS, and Linux can be found on the Official Website.

Documentation

If you are planning to contribute or just want to learn more about this project please read through our documentation.

Building

If you wish to build the emulator yourself, follow these steps:

Step 1

Install the .NET 8.0 (or higher) SDK. Make sure your SDK version is higher or equal to the required version specified in global.json.

Step 2

Either use git clone https://github.com/Ryujinx/Ryujinx on the command line to clone the repository or use Code --> Download zip button to get the files.

Step 3

To build Ryujinx, open a command prompt inside the project directory. You can quickly access it on Windows by holding shift in File Explorer, then right clicking and selecting Open command window here. Then type the following command: dotnet build -c Release -o build the built files will be found in the newly created build directory.

Ryujinx system files are stored in the Ryujinx folder. This folder is located in the user folder, which can be accessed by clicking Open Ryujinx Folder under the File menu in the GUI.

Features

  • Audio

    Audio output is entirely supported, audio input (microphone) isn't supported. We use C# wrappers for OpenAL, and SDL2 & libsoundio as fallbacks.

  • CPU

    The CPU emulator, ARMeilleure, emulates an ARMv8 CPU and currently has support for most 64-bit ARMv8 and some of the ARMv7 (and older) instructions, including partial 32-bit support. It translates the ARM code to a custom IR, performs a few optimizations, and turns that into x86 code. There are three memory manager options available depending on the user's preference, leveraging both software-based (slower) and host-mapped modes (much faster). The fastest option (host, unchecked) is set by default. Ryujinx also features an optional Profiled Persistent Translation Cache, which essentially caches translated functions so that they do not need to be translated every time the game loads. The net result is a significant reduction in load times (the amount of time between launching a game and arriving at the title screen) for nearly every game. NOTE: This feature is enabled by default in the Options menu > System tab. You must launch the game at least twice to the title screen or beyond before performance improvements are unlocked on the third launch! These improvements are permanent and do not require any extra launches going forward.

  • GPU

    The GPU emulator emulates the Switch's Maxwell GPU using either the OpenGL (version 4.5 minimum), Vulkan, or Metal (via MoltenVK) APIs through a custom build of OpenTK or Silk.NET respectively. There are currently six graphics enhancements available to the end user in Ryujinx: Disk Shader Caching, Resolution Scaling, Anti-Aliasing, Scaling Filters (including FSR), Anisotropic Filtering and Aspect Ratio Adjustment. These enhancements can be adjusted or toggled as desired in the GUI.

  • Input

    We currently have support for keyboard, mouse, touch input, JoyCon input support, and nearly all controllers. Motion controls are natively supported in most cases; for dual-JoyCon motion support, DS4Windows or BetterJoy are currently required. In all scenarios, you can set up everything inside the input configuration menu.

  • DLC & Modifications

    Ryujinx is able to manage add-on content/downloadable content through the GUI. Mods (romfs, exefs, and runtime mods such as cheats) are also supported; the GUI contains a shortcut to open the respective mods folder for a particular game.

  • Configuration

    The emulator has settings for enabling or disabling some logging, remapping controllers, and more. You can configure all of them through the graphical interface or manually through the config file, Config.json, found in the user folder which can be accessed by clicking Open Ryujinx Folder under the File menu in the GUI.

Contact

If you have contributions, suggestions, need emulator support or just want to get in touch with the team, join our Discord server. You may also review our FAQ.

Donations

If you'd like to support the project financially, Ryujinx has an active Patreon campaign.

All developers working on the project do so in their free time, but the project has several expenses:

  • Hackable Nintendo Switch consoles to reverse-engineer the hardware
  • Additional computer hardware for testing purposes (e.g. GPUs to diagnose graphical bugs, etc.)
  • Licenses for various software development tools (e.g. Jetbrains, IDA)
  • Web hosting and infrastructure maintenance (e.g. LDN servers)

All funds received through Patreon are considered a donation to support the project. Patrons receive early access to progress reports and exclusive access to developer interviews.

License

This software is licensed under the terms of the MIT license. This project makes use of code authored by the libvpx project, licensed under BSD and the ffmpeg project, licensed under LGPLv3. See LICENSE.txt and THIRDPARTY.md for more details.

Credits

  • LibHac is used for our file-system.
  • AmiiboAPI is used in our Amiibo emulation.
  • ldn_mitm is used for one of our available multiplayer modes.
  • ShellLink is used for Windows shortcut generation.

youkaede77's Projects

3d-earth icon 3d-earth

基于Echarts.js,3D炫酷世界地图地球仪动画,自动旋转,业务迁移热点显示动画,3D动态地球,可以根据经纬度定位坐标。

all-defense-tool icon all-defense-tool

本项目集成了全网优秀的攻防工具项目,包含自动化利用,子域名、敏感目录、端口等扫描,各大中间件,cms漏洞利用工具以及应急响应等资料。

allnewsspider icon allnewsspider

澎湃新闻,新浪新闻,腾讯新闻,搜狐新闻,旨在爬取所有新闻门户网站的新闻,禁止将所得数据商用!

apubplat icon apubplat

Devops自动化部署、堡垒机开源项目、Web Terminal

at-lumen icon at-lumen

嗯,一个更适合开箱即用的 Lumen 封装

certd icon certd

免费通配符域名SSL证书全自动申请、更新、续期、部署安装,支持部署到阿里云、腾讯云、ssh主机。Automatically apply, renew and deploy free Generic domain SSL Certificates。

decryptlogin icon decryptlogin

DecryptLogin: APIs for loginning some websites by using requests.

devops icon devops

基于 python 3.9.13 + django 2.2.16 + channels 2.4.0 + celery 5.2.7 + ansible 2.9.14 + paramiko 2.6.0 + AdminLTE-3.0.0 实现的运维 devops 管理系统。

dnmp icon dnmp

Docker LNMP (Nginx, PHP7/PHP5, MySQL, Redis)

docker-android icon docker-android

Android in docker solution with noVNC supported and video recording

docker-documentserver icon docker-documentserver

ONLYOFFICE Document Server is an online office suite comprising viewers and editors for texts, spreadsheets and presentations, fully compatible with Office Open XML formats: .docx, .xlsx, .pptx and enabling collaborative editing in real time.

docs-zh-cn icon docs-zh-cn

Vue 文档官方中文翻译 | Official Chinese translation for Vue docs

dootask icon dootask

DooTask是一款轻量级的开源在线项目任务管理工具,提供各类文档协作工具、在线思维导图、在线流程图、项目管理、任务分发、即时IM,文件管理等工具。

drawdb icon drawdb

Free, simple, and intuitive online database design tool and SQL generator.

easyocr icon easyocr

Ready-to-use OCR with 80+ supported languages and all popular writing scripts including Latin, Chinese, Arabic, Devanagari, Cyrillic and etc.

easyspider icon easyspider

A visual no-code/code-free web crawler/spider易采集:一个可视化浏览器自动化测试/数据采集/爬虫软件,可以无代码图形化的设计和执行爬虫任务。别名:ServiceWrapper面向Web应用的智能化服务封装系统。

ecommercecrawlers icon ecommercecrawlers

实战🐍多种网站、电商数据爬虫🕷。包含🕸:淘宝商品、微信公众号、大众点评、企查查、招聘网站、闲鱼、阿里任务、博客园、微博、百度贴吧、豆瓣电影、包图网、全景网、豆瓣音乐、某省药监局、搜狐新闻、机器学习文本采集、fofa资产采集、汽车之家、国家统计局、百度关键词收录数、蜘蛛泛目录、今日头条、豆瓣影评、携程、小米应用商店、安居客、途家民宿❤️❤️❤️。微信爬虫展示项目:

fay icon fay

Fay is an open-source digital human framework integrating language models and digital characters. It offers retail, assistant, and agent versions for diverse applications like virtual shopping guides, broadcasters, assistants, waiters, teachers, and voice or text-based mobile assistants.

filecodebox icon filecodebox

文件快递柜-匿名口令分享文本,文件,像拿快递一样取文件(File Express Cabinet - Anonymous Passcode Sharing Text, Files, Like Taking Express Delivery for Files)

google2fa icon google2fa

A One Time Password Authentication package, compatible with Google Authenticator.

google2fa-laravel icon google2fa-laravel

A One Time Password Authentication package, compatible with Google Authenticator for Laravel

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.