citra-emu
/
citra
Archived
1
0
Fork 0
This repository has been archived on 2024-03-23. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
zhupengfei 890405bb7c
core/file_sys: LayeredFS implementation
This implementation is different from Luma3DS's which directly hooks the SDK functions. Instead, we read the RomFS's metadata and figure out the directory and file structure. Then, relocations (i.e. replacements/deletions/patches) are applied. Afterwards, we rebuild the metadata, and assign 'fake' data offsets to the files. When we want to read file data from this rebuilt RomFS, we use binary search to find the last data offset smaller or equal to the given offset and read from that file  (either from the original RomFS, or from replacement files, or from buffered data with patches applied) and any later files when length is not enough.

The code that rebuilds the metadata is pretty complex and uses quite a few variables to keep track of necessary information like metadata offsets. According to my tests, it is able to build RomFS-es identical to the original (but without trailing garbage data) when no relocations are applied.
2020-02-07 15:19:57 +08:00
.appveyor appveyor: Generate PDBs for mingw build 2018-03-27 11:57:34 +01:00
.github .github: Create FUNDING.yml 2019-06-08 20:09:03 +02:00
.travis OSX Build: Remove ninja 2020-01-21 18:54:05 -07:00
CMakeModules Fix title bar 2020-01-15 23:52:41 -07:00
dist Update translations (2019-09-21) 2019-09-21 13:57:24 +00:00
externals Address review and update zstd 2020-01-15 19:58:34 -07:00
hooks hook: remove clang-format check 2017-02-17 13:52:23 +02:00
src core/file_sys: LayeredFS implementation 2020-02-07 15:19:57 +08:00
.gitattributes Meta: Add gitattributes file 2018-09-22 14:59:15 -06:00
.gitignore Flatpak support (#4383) 2018-11-07 21:33:36 -05:00
.gitmodules Add ZSTD compression for precompiled cache 2020-01-15 19:58:33 -07:00
.travis.yml travis: Update the frozen build to be a flagless Debug build 2019-08-14 09:27:06 +08:00
CMakeLists.txt CMakeLists: Fix `find_package` call 2019-10-03 09:35:08 +08:00
CONTRIBUTING.md CONTRIBUTING.md: migrate to the wiki 2018-11-08 00:15:55 -05:00
Doxyfile Remove every trailing whitespace from the project (but externals). 2015-05-29 21:59:29 +01:00
README.md Updated README with new help page. 2019-08-18 22:12:05 +00:00
appveyor.yml CMake: separate options for FFmpeg decoder/dumper 2019-08-20 14:45:39 +08:00
bitrise.yml android: set up cmake 2018-11-20 14:24:19 -05:00
keys.tar.enc Flatpak support (#4383) 2018-11-07 21:33:36 -05:00
license.txt citra_qt/multiplayer: Add user ping support 2018-12-15 11:03:35 +08:00

README.md

BEFORE FILING AN ISSUE, READ THE RELEVANT SECTION IN THE CONTRIBUTING FILE!!!

Citra

Travis CI Build Status AppVeyor CI Build Status Bitrise CI Build Status

Citra is an experimental open-source Nintendo 3DS emulator/debugger written in C++. It is written with portability in mind, with builds actively maintained for Windows, Linux and macOS.

Citra emulates a subset of 3DS hardware and therefore is useful for running/debugging homebrew applications, and it is also able to run many commercial games! Some of these do not run at a playable state, but we are working every day to advance the project forward. (Playable here means compatibility of at least "Okay" on our game compatibility list.)

Citra is licensed under the GPLv2 (or any later version). Refer to the license.txt file included. Please read the FAQ before getting started with the project.

Check out our website!

Need help? Check out our asking for help guide.

For development discussion, please join us at #citra-dev on freenode.

Development

Most of the development happens on GitHub. It's also where our central repository is hosted.

If you want to contribute please take a look at the Contributor's Guide and Developer Information. You should as well contact any of the developers in the forum in order to know about the current state of the emulator because the TODO list isn't maintained anymore.

If you want to contribute to the user interface translation, please checkout citra project on transifex. We centralize the translation work there, and periodically upstream translation.

Building

Support

We happily accept monetary donations or donated games and hardware. Please see our donations page for more information on how you can contribute to Citra. Any donations received will go towards things like:

  • 3DS consoles for developers to explore the hardware
  • 3DS games for testing
  • Any equipment required for homebrew
  • Infrastructure setup
  • Eventually 3D displays to get proper 3D output working

We also more than gladly accept used 3DS consoles, preferably ones with firmware 4.5 or lower! If you would like to give yours away, don't hesitate to join our IRC channel #citra on Freenode and talk to neobrain or bunnei. Mind you, IRC is slow-paced, so it might be a while until people reply. If you're in a hurry you can just leave contact details in the channel or via private message and we'll get back to you.